com.sun.identity.authentication.spi

Interface AMPostAuthProcessInterface

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

Method Summary

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.

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 - when there is an error.