Class SAML2PostAuthenticationPlugin
- java.lang.Object
-
- org.forgerock.openam.authentication.modules.saml2.SAML2PostAuthenticationPlugin
-
- All Implemented Interfaces:
AMPostAuthProcessInterface
public class SAML2PostAuthenticationPlugin extends Object implements AMPostAuthProcessInterface
Plugin that gets activated for SLO for the SAML2 auth module. Supports HTTP-Redirect for logout-sending messages only.
-
-
Field Summary
-
Fields inherited from interface com.sun.identity.authentication.spi.AMPostAuthProcessInterface
POST_PROCESS_LOGIN_FAILURE_URL, POST_PROCESS_LOGIN_SUCCESS_URL, POST_PROCESS_LOGOUT_URL
-
-
Constructor Summary
Constructors Constructor Description SAML2PostAuthenticationPlugin()Default Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidonLoginFailure(Map requestParamsMap, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)Post processing on failed authentication.voidonLoginSuccess(Map requestParamsMap, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, SSOToken ssoToken)If enabled, performs the first-stage of SLO - by recording the currently logged in user.voidonLogout(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, SSOToken ssoToken)Post processing on Logout.
-
-
-
Method Detail
-
onLoginSuccess
public void onLoginSuccess(Map requestParamsMap, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, SSOToken ssoToken)
If enabled, performs the first-stage of SLO - by recording the currently logged in user. The information relating to a remote user is stored alongside their local information, and upon active-logout is used to trigger a call to the IdP requesting their logout.- Specified by:
onLoginSuccessin interfaceAMPostAuthProcessInterface- Parameters:
requestParamsMap- map containingHttpServletRequestparametersrequest-HttpServletRequestobject.response-HttpServletResponseobject.ssoToken- authenticated user's single sign token.
-
onLoginFailure
public void onLoginFailure(Map requestParamsMap, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) throws AuthenticationException
Description copied from interface:AMPostAuthProcessInterfacePost processing on failed authentication.- Specified by:
onLoginFailurein interfaceAMPostAuthProcessInterface- Parameters:
requestParamsMap- map containingHttpServletRequestparameters.request-HttpServletRequestobject.response-HttpServletResponseobject.- Throws:
AuthenticationException- when there is an error.
-
onLogout
public void onLogout(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, SSOToken ssoToken) throws AuthenticationExceptionDescription copied from interface:AMPostAuthProcessInterfacePost processing on Logout.- Specified by:
onLogoutin interfaceAMPostAuthProcessInterface- Parameters:
request-HttpServletRequestobject.response-HttpServletResponseobject.ssoToken- authenticated user's single sign on token.- Throws:
AuthenticationException- if an error occurs during logout post processing
-
-