com.sun.identity.federation.plugins

Interface FederationSPAdapter

Deprecated.

since 12.0.0

@Deprecated
public interface FederationSPAdapter

The interface FederationSPAdapter could be implemented to perform user specific processing during federation process on the Liberty Service Provider side.

A singleton instance of this FederationSPAdapter will be used during runtime, so make sure implementation of the federation processing methods (except initialize() method) are thread safe.

Method Summary

Modifier and Type	Method and Description
void	initialize(String hostedEntityID, Set initParams) Deprecated. Initializes the federation adapter, this method will only be executed once after creation of the adapter instance.
void	postRegisterNameIdentifierSuccess(String hostedEntityID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String userDN, FSNameRegistrationRequest regRequest, FSNameRegistrationResponse regResponse, String regProfile) Deprecated. Invokes after Register Name Identifier processing is successful
void	postSingleLogoutSuccess(String hostedEntityID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String userDN, FSLogoutNotification logoutRequest, FSLogoutResponse logoutResponse, String sloProfile) Deprecated. Invokes after single logout is successful completed, i.e.
boolean	postSSOFederationFailure(String hostedEntityID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, FSAuthnRequest authnRequest, FSAuthnResponse authnResponse, FSResponse samlResponse, int failureCode) Deprecated. Invokes after Single-Sign-On or Federation processing is failed.
boolean	postSSOFederationSuccess(String hostedEntityID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object ssoToken, FSAuthnRequest authnRequest, FSAuthnResponse authnResponse, FSResponse samlResponse) Deprecated. Invokes after Single-Sign-On and Federation processing is successful.
void	postTerminationNotificationSuccess(String hostedEntityID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String userDN, FSFederationTerminationNotification notification, String termProfile) Deprecated. Invokes after the service provider successfully terminates federation with IDP.
void	preSingleLogoutProcess(String hostedEntityID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String userDN, FSLogoutNotification logoutRequest, FSLogoutResponse logoutResponse, String sloProfile) Deprecated. Invokes before single logout process started on FM side.
void	preSSOFederationProcess(String hostedEntityID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, FSAuthnRequest authnRequest, FSAuthnResponse authnResponse, FSResponse samlResponse) Deprecated. Invokes when the FM received the Single-Sign-On and Federation response from the IDP, this is called before any processing started on SP side.
void	preSSOFederationRequest(String hostedEntityID, String idpEntityID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, FSAuthnRequest authnRequest) Deprecated. Invokes before federation manager sends the Single-Sing-On and Federation request to IDP.

Method Detail

initialize

void initialize(String hostedEntityID,
                Set initParams)

Deprecated.

Initializes the federation adapter, this method will only be executed once after creation of the adapter instance.

Parameters:

hostedEntityID - entity ID for the hosted SP

initParams - initial set of parameters(such as REALM) configured in the service provider for this adapter.

preSSOFederationRequest

void preSSOFederationRequest(String hostedEntityID,
                             String idpEntityID,
                             javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response,
                             FSAuthnRequest authnRequest)

Deprecated.

Invokes before federation manager sends the Single-Sing-On and Federation request to IDP.

Parameters:

hostedEntityID - entity ID for the hosted SP

idpEntityID - entity id for the IDP to which the request will be sent

request - servlet request

response - servlet response

authnRequest - the authentication request to be send to IDP

preSSOFederationProcess

void preSSOFederationProcess(String hostedEntityID,
                             javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response,
                             FSAuthnRequest authnRequest,
                             FSAuthnResponse authnResponse,
                             FSResponse samlResponse)
                      throws FederationException

Deprecated.

Invokes when the FM received the Single-Sign-On and Federation response from the IDP, this is called before any processing started on SP side.

Parameters:

hostedEntityID - entity ID for the hosted SP

request - servlet request

response - servlet response

authnRequest - the original authentication request sent from SP

authnResponse - response from IDP if Browser POST or LECP profile is used for the request, value will be null if Browser Artifact profile is used.

samlResponse - response from IDP if Browser Artifact profile is used for the request, value will be null if Browser POST or LECP profile is used.

Throws:

FederationException - if user want to fail the process.

postSSOFederationSuccess

boolean postSSOFederationSuccess(String hostedEntityID,
                                 javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 Object ssoToken,
                                 FSAuthnRequest authnRequest,
                                 FSAuthnResponse authnResponse,
                                 FSResponse samlResponse)
                          throws FederationException

Deprecated.

Invokes after Single-Sign-On and Federation processing is successful.

Parameters:

hostedEntityID - Entity ID for the hosted SP

request - servlet request

response - servlet response

ssoToken - user's SSO Token

authnRequest - the original authentication request sent from SP

authnResponse - response from IDP if Browser POST or LECP profile is used for the request, value will be null if Browser Artifact profile is used.

samlResponse - response from IDP if Browser Artifact profile is used for the request, value will be null if Browser POST or LECP profile is used.

Returns:

true if browser redirection happened, false otherwise.

Throws:

FederationException - if user want to fail the process.

postSSOFederationFailure

boolean postSSOFederationFailure(String hostedEntityID,
                                 javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 FSAuthnRequest authnRequest,
                                 FSAuthnResponse authnResponse,
                                 FSResponse samlResponse,
                                 int failureCode)

Deprecated.

Invokes after Single-Sign-On or Federation processing is failed.

Parameters:

hostedEntityID - Entity ID for the hosted SP

request - servlet request

response - servlet response

authnRequest - the original authentication request sent from SP

authnResponse - response from IDP if Browser POST or LECP profile is used for the request, value will be null if Browser Artifact profile is used.

samlResponse - response from IDP if Browser Artifact profile is used * for the request, value will be null if Browser POST or LECP profile is used.

failureCode - an integer specifies the failure code. Possible failure codes are defined in this interface.

Returns:

true if browser redirection happened, false otherwise.

postRegisterNameIdentifierSuccess

void postRegisterNameIdentifierSuccess(String hostedEntityID,
                                       javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response,
                                       String userDN,
                                       FSNameRegistrationRequest regRequest,
                                       FSNameRegistrationResponse regResponse,
                                       String regProfile)

Deprecated.

Invokes after Register Name Identifier processing is successful

Parameters:

hostedEntityID - Entity ID for the hosted SP

request - servlet request

response - servlet response

userDN - DN of the user with whom name identifier registration performed

regRequest - register name identifier request, value will be null if the request object is not available

regResponse - register name identifier response, value will be null if the response object is not available

regProfile - register name identifier profile used, one of following IFSConstants.NAME_REGISTRATION_SP_HTTP_PROFILE IFSConstants.NAME_REGISTRATION_SP_SOAP_PROFILE IFSConstants.NAME_REGISTRATION_IDP_HTTP_PROFILE IFSConstants.NAME_REGISTRATION_IDP_SOAP_PROFILE

postTerminationNotificationSuccess

void postTerminationNotificationSuccess(String hostedEntityID,
                                        javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response,
                                        String userDN,
                                        FSFederationTerminationNotification notification,
                                        String termProfile)

Deprecated.

Invokes after the service provider successfully terminates federation with IDP.

Parameters:

hostedEntityID - Entity ID for the hosted SP

request - servlet request

response - servlet response

userDN - DN of the user with whom name identifier registration performed

notification - federation termination notification message

termProfile - federation termination profile used, one of following IFSConstants.TERMINATION_SP_HTTP_PROFILE IFSConstants.TERMINATION_SP_SOAP_PROFILE IFSConstants.TERMINATION_IDP_HTTP_PROFILE IFSConstants.TERMINATION_IDP_SOAP_PROFILE

preSingleLogoutProcess

void preSingleLogoutProcess(String hostedEntityID,
                            javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            String userDN,
                            FSLogoutNotification logoutRequest,
                            FSLogoutResponse logoutResponse,
                            String sloProfile)

Deprecated.

Invokes before single logout process started on FM side. This method is called before the user token is invalidated on the service provider side.

Parameters:

hostedEntityID - Entity ID for the hosted SP

request - servlet request

response - servlet response

userDN - user DN

logoutRequest - single logout request object

logoutResponse - single logout response, value will be null if the response object is not available

sloProfile - single logout profile used, one of following IFSConstants.LOGOUT_SP_REDIRECT_PROFILE IFSConstants.LOGOUT_SP_SOAP_PROFILE IFSConstants.LOGOUT_IDP_REDIRECT_PROFILE IFSConstants.LOGOUT_IDP_SOAP_PROFILE

postSingleLogoutSuccess

void postSingleLogoutSuccess(String hostedEntityID,
                             javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response,
                             String userDN,
                             FSLogoutNotification logoutRequest,
                             FSLogoutResponse logoutResponse,
                             String sloProfile)

Deprecated.

Invokes after single logout is successful completed, i.e. user token has been invalidated.

Parameters:

hostedEntityID - Entity ID for the hosted SP

request - servlet request

response - servlet response

userDN - user DN

logoutRequest - single logout request, value will be null if the request object is not available

logoutResponse - single logout response, value will be null if the response object is not available

sloProfile - single logout profile used, one of following IFSConstants.LOGOUT_SP_HTTP_PROFILE IFSConstants.LOGOUT_SP_SOAP_PROFILE IFSConstants.LOGOUT_IDP_HTTP_PROFILE IFSConstants.LOGOUT_IDP_SOAP_PROFILE