fuego.sso
Interface SSOUserLoginInterface

All Known Subinterfaces:

fuego.web.SSOUserLoginInterface, SSOWorkspaceLoginInterface

public interface SSOUserLoginInterface

This interface enables you to provide Oracle BPM web applications with a custom single sign-on authentication. Oracle BPM web applications use this interface to obtain the credentials to authenticate against the Directory Service. The authentication is transparent to the user who is already authenticated against an external system.

Method Summary

java.lang.String	getLogoutRelativePath() Obtains the path for redirecting users when they log out.
java.lang.String	getLogoutURL() Obtains the URL for redirecting users when they log out.
java.lang.String	getPassword(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) If the method skipFDIAuthentication() returns false, this method enables you to return the password for authenticating to the directory service.
java.lang.String	getUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Depending on the external system you are using, the request object might contain either the user credentials or the token used by that system.
boolean	skipFDIAuthentication() Indicates if the directory service used by ALBPM handles the authentication.

Method Detail

getUser

java.lang.String getUser(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                         throws fuego.sso.SSOLoginException

Depending on the external system you are using, the request object might contain either the user credentials or the token used by that system. Based on them, you should be able to obtain the valid credentials for Oracle BPM Directory Service.

Parameters:

request - an HttpServletRequest object that contains the request received by the Servlet Container

response - an HttpServletResponse object that contains the response sent to the client

Returns:

the user ID that identifies the user in the directory service

Throws:

SSOLoginException - if an error occurs trying to obtain the user

getPassword

java.lang.String getPassword(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                             throws fuego.sso.SSOLoginException

If the method skipFDIAuthentication() returns false, this method enables you to return the password for authenticating to the directory service.

Parameters:

request - an HttpServletRequest object that contains the request received by the Servlet Container

response - an HttpServletResponse object that contains the response sent to the client

Returns:

the plaintext password to authenticate against the directory service

Throws:

SSOLoginException - if an error occurs trying to get the password

skipFDIAuthentication

boolean skipFDIAuthentication()

Indicates if the directory service used by ALBPM handles the authentication. It returns false if an external system handles the authentication, or true if the directory service handles the authentication. If the directory service handles the authentication, it uses the user and the password provided in this interface.

Returns:

true if the directory service handles the authentication, otherwise false

See Also:

getUser(HttpServletRequest request, HttpServletResponse response), getPassword(HttpServletRequest request, HttpServletResponse response)

getLogoutURL

java.lang.String getLogoutURL()

Obtains the URL for redirecting users when they log out. If you want to use Oracle BPM default logout page this method should return null.

Returns:

the URL for redirecting users when they log out

getLogoutRelativePath

java.lang.String getLogoutRelativePath()

Obtains the path for redirecting users when they log out. This path is relative to the URL of the Oracle BPM Web Application using single sign-on. This method has precedence over the getLogoutURL() method.

Returns:

a relative path to the ALBPM Web Application using single sign-on, used to build the URL for redirecting users when they logout