|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 | |
void |
initialize(java.lang.String hostedProviderID,
java.util.Set initParams)
initializes the federation adapter, this method will only be executed once after creation of the adapter instance. |
void |
postRegisterNameIdentifierSuccess(java.lang.String hostedProviderID,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
java.lang.String userDN,
FSNameRegistrationRequest regRequest,
FSNameRegistrationResponse regResponse,
java.lang.String regProfile)
invokes after Register Name Identifier processing is successful |
void |
postSingleLogoutSuccess(java.lang.String hostedProviderID,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
java.lang.String userDN,
FSLogoutNotification logoutRequest,
FSLogoutResponse logoutResponse,
java.lang.String sloProfile)
Invokes after single logout is successful completed, i.e. |
boolean |
postSSOFederationSuccess(java.lang.String hostedProviderID,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
SSOToken ssoToken,
FSAuthnRequest authnRequest,
FSAuthnResponse authnResponse,
FSResponse samlResponse)
invokes after Single-Sign-On and Federation processing is successful. |
void |
postTerminationNotificationSuccess(java.lang.String hostedProviderID,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
java.lang.String userDN,
FSFederationTerminationNotification notification,
java.lang.String termProfile)
invokes after the service provider successfully terminates federation with IDP. |
void |
preSingleLogoutProcess(java.lang.String hostedProviderID,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
java.lang.String userDN,
FSLogoutNotification logoutRequest,
FSLogoutResponse logoutResponse,
java.lang.String sloProfile)
Invokes before single logout process started on FM side. |
void |
preSSOFederationProcess(java.lang.String hostedProviderID,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
FSAuthnRequest authnRequest,
FSAuthnResponse authnResponse,
FSResponse samlResponse)
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(java.lang.String hostedProviderID,
java.lang.String idpProviderID,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
FSAuthnRequest authnRequest)
invokes before federation manager sends the Single-Sing-On and Federation request to IDP. |
Method Detail |
public void initialize(java.lang.String hostedProviderID, java.util.Set initParams)
hostedProviderID
- provider ID for the hosted SPinitParams
- initial set of parameters configured in the service
provider for this adapterpublic void preSSOFederationRequest(java.lang.String hostedProviderID, java.lang.String idpProviderID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, FSAuthnRequest authnRequest)
hostedProviderID
- provider ID for the hosted SPidpProviderID
- provider id for the IDP to which the request will
be sentrequest
- servlet requestresponse
- servlet responseauthnRequest
- the authentication request to be send to IDPpublic void preSSOFederationProcess(java.lang.String hostedProviderID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, FSAuthnRequest authnRequest, FSAuthnResponse authnResponse, FSResponse samlResponse) throws FederationException
hostedProviderID
- provider ID for the hosted SPrequest
- servlet requestresponse
- servlet responseauthnRequest
- the original authentication request sent from SPauthnResponse
- 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.
FederationException
- if user want to fail the process.public boolean postSSOFederationSuccess(java.lang.String hostedProviderID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SSOToken ssoToken, FSAuthnRequest authnRequest, FSAuthnResponse authnResponse, FSResponse samlResponse)
hostedProviderID
- provider ID for the hosted SPrequest
- servlet requestresponse
- servlet responseauthnRequest
- the original authentication request sent from SPauthnResponse
- 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.
public void postRegisterNameIdentifierSuccess(java.lang.String hostedProviderID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String userDN, FSNameRegistrationRequest regRequest, FSNameRegistrationResponse regResponse, java.lang.String regProfile)
hostedProviderID
- provider ID for the hosted SPrequest
- servlet requestresponse
- servlet responseuserDN
- DN of the user with whom name identifier registration
performedregRequest
- register name identifier request, value will be
null if the request object is not availableregResponse
- register name identifier response, value will be
null if the response object is not availableregProfile
- 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_PROFILEpublic void postTerminationNotificationSuccess(java.lang.String hostedProviderID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String userDN, FSFederationTerminationNotification notification, java.lang.String termProfile)
hostedProviderID
- provider ID for the hosted SPrequest
- servlet requestresponse
- servlet responseuserDN
- DN of the user with whom name identifier registration
performednotification
- federation termination notification messagetermProfile
- 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_PROFILEpublic void preSingleLogoutProcess(java.lang.String hostedProviderID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String userDN, FSLogoutNotification logoutRequest, FSLogoutResponse logoutResponse, java.lang.String sloProfile)
hostedProviderID
- provider ID for the hosted SPrequest
- servlet requestresponse
- servlet responseuserDN
- user DNlogoutRequest
- single logout request objectlogoutResponse
- single logout response, value will be
null if the response object is not availablesloProfile
- 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_PROFILEpublic void postSingleLogoutSuccess(java.lang.String hostedProviderID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String userDN, FSLogoutNotification logoutRequest, FSLogoutResponse logoutResponse, java.lang.String sloProfile)
hostedProviderID
- provider ID for the hosted SPrequest
- servlet requestresponse
- servlet responseuserDN
- user DNlogoutRequest
- single logout request, value will be
null if the request object is not availablelogoutResponse
- single logout response, value will be
null if the response object is not availablesloProfile
- 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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |