com.ibm.itim.ui.sso
Interface SSOAdapter

Deprecated.

public interface SSOAdapter

Defines a pluggable interface to be implemented for SSO configurations. Implementations of this interface are responsible checking if the user is authenticated, and returning the ITIM userid when SSO is enabled Note: Additional ITIM server configurations are required to enable SSO. See the configuration guide for more details.

Method Summary

java.lang.String	getUserId(javax.servlet.http.HttpServletRequest request) Deprecated. Returns the ITIM User ID that identifies the authenticated user.
boolean	isAuthenticated(javax.servlet.http.HttpServletRequest request) Deprecated. Given the request object return if the request has been authenticated via an SSO provider

Method Detail

isAuthenticated

boolean isAuthenticated(javax.servlet.http.HttpServletRequest request)
                        throws ITIMUIException

Deprecated.

Given the request object return if the request has been authenticated via an SSO provider

Parameters:

request - the servlet request

Returns:

true if the request has been authenticated false otherwise

Throws:

ITIMUIException - if an error occurs while checking the authentication state

getUserId

java.lang.String getUserId(javax.servlet.http.HttpServletRequest request)
                           throws ITIMUISSOUserIdNotFoundException,
                                  ITIMUIException

Deprecated.

Returns the ITIM User ID that identifies the authenticated user. The SSO adapter should use information stored in the HTTP request to identify the ITIM user. If the user id used to the authenticate to the SSO provider does not match the ITIM user id, the adapter is responsible for mapping/returning the itim user id.

Parameters:

request - the servlet request

Returns:

the itim user id for the authenticated user. This method should not return null or empty string, but instead throw an exception if the user id is not found or valid

Throws:

ITIMUISSOUserIdNotFoundException - if the sso adapter is unable to determine the itim user id

ITIMUIException - if an error occurs while determining the user id