AMPostAuthProcessInterface (OpenAM Project 15.1.7-SNAPSHOT API)

All Known Implementing Classes:

AccountExpirePlugin, AdaptivePostAuthenticationPlugin, AMPostAuthProcess, JaspiAuthLoginModulePostAuthenticationPlugin, OAuth2PostAuthnPlugin, PersistentCookieAuthModulePostAuthenticationPlugin, ReplayPasswd, SAML2PostAuthenticationPlugin, WSSReplayPasswd
```
public interface AMPostAuthProcessInterface
```
The AMPostAuthProcessInterface interface needs to be implemented by services and applications to do post authentication processing.
This interface is invoked by the OpenAM Authentication service on a successful authentication, failed authentication or during logout.
This interface has three methods onLoginSuccess, onLoginFailure and onLogout. The onLoginSuccess will be invoked when authentication is successful. The onFailure will be invoked on failed authentication. The onLogout is invoked during a logout.
The post processing class implementation can be configured per ORGANIZATION or SERVICE or ROLE

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`POST_PROCESS_LOGIN_FAILURE_URL` Constant to represent SPI redirect URL on login failure.
`static String`	`POST_PROCESS_LOGIN_SUCCESS_URL` Constant to represent SPI redirect URL on login success.
`static String`	`POST_PROCESS_LOGOUT_URL` Constant to represent SPI redirect URL on logout.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`onLoginFailure(Map requestParamsMap, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` Post processing on failed authentication.
`void`	`onLoginSuccess(Map requestParamsMap, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SSOToken ssoToken)` Post processing on successful authentication.
`void`	`onLogout(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SSOToken ssoToken)` Post processing on Logout.

- Field Detail
  - POST_PROCESS_LOGIN_SUCCESS_URL
```
static final String POST_PROCESS_LOGIN_SUCCESS_URL
```
    Constant to represent SPI redirect URL on login success. Following sample code explains how to use this onLoginSuccess. public void onLoginSuccess(Map requestParamsMap,HttpServletRequest request, HttpServletResponse response,SSOToken ssoToken)throws AuthenticationException { // Set redirect URL on login success, User will be redirected to this URL on success. if (request != null) request.setAttribute( AMPostAuthProcessInterface.POST_PROCESS_LOGIN_SUCCESS_URL, "http://www.sun.com"); } Note: Setting this property will take precendence over a session proeprty POST_PROCESS_SUCCESS_URL , which can also be configured to redirect users after successful authentication.
    
    See Also:
    
    Constant Field Values
  - POST_PROCESS_LOGIN_FAILURE_URL
```
static final String POST_PROCESS_LOGIN_FAILURE_URL
```
    Constant to represent SPI redirect URL on login failure. Following sample code explains how to use this onLoginFailure. public void onLoginFailure(Map requestParamsMap,HttpServletRequest request, HttpServletResponse response,SSOToken ssoToken)throws AuthenticationException { // Set redirect URL on login failure, User will be redirected to this URL on failure. if (request != null) request.setAttribute( AMPostAuthProcessInterface.POST_PROCESS_LOGIN_FAILURE_URL, "http://www.example.com"); }
    
    See Also:
    
    Constant Field Values
  - POST_PROCESS_LOGOUT_URL
```
static final String POST_PROCESS_LOGOUT_URL
```
    Constant to represent SPI redirect URL on logout. Following sample code explains how to use this onLogout. public void onLoginFailure(Map requestParamsMap,HttpServletRequest request, HttpServletResponse response,SSOToken ssoToken)throws AuthenticationException { // Set redirect URL on logout, User will be redirected to this URL on logout. if (request != null) request.setAttribute( AMPostAuthProcessInterface.POST_PROCESS_LOGOUT_URL, "http://opensso.dev.java.net"); }
    
    See Also:
    
    Constant Field Values
- Method Detail
  - onLoginSuccess
```
void onLoginSuccess(Map requestParamsMap,
                    javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response,
                    SSOToken ssoToken)
             throws AuthenticationException
```
    Post processing on successful authentication.
    
    Parameters:
    
    requestParamsMap - map containing HttpServletRequest parameters
    
    request - HttpServletRequest object.
    
    response - HttpServletResponse object.
    
    ssoToken - authenticated user's single sign token.
    
    Throws:
    
    AuthenticationException - if there is an error.
  - onLoginFailure
```
void onLoginFailure(Map requestParamsMap,
                    javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws AuthenticationException
```
    Post processing on failed authentication.
    
    Parameters:
    
    requestParamsMap - map containing HttpServletRequest parameters.
    request - HttpServletRequest object. response - HttpServletResponse object. Throws: AuthenticationException - when there is an error.
  onLogout void onLogout(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SSOToken ssoToken) throws AuthenticationException Post processing on Logout. Parameters: request - HttpServletRequest object. response - HttpServletResponse object. ssoToken - authenticated user's single sign on token. Throws: AuthenticationException

Interface AMPostAuthProcessInterface

Field Summary

Method Summary

Field Detail

POST_PROCESS_LOGIN_SUCCESS_URL

POST_PROCESS_LOGIN_FAILURE_URL

POST_PROCESS_LOGOUT_URL

Method Detail

onLoginSuccess

onLoginFailure

onLogout