|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AMPostAuthProcessInterface
The AMPostAuthProcessInterface
interface needs to
be implemented by services and applications to do post
authentication processing.
This interface is invoked by OpenSSO Authentication service on a successful authentication , failed authentication or during logout.
This interface has three methods onLoginSuccess
,
onLoginFailure
and onLogout
. The
onLoginSucess
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 | |
---|---|
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 | |
---|---|
void |
onLoginFailure(Map requestParamsMap,
HttpServletRequest request,
HttpServletResponse response)
Post processing on failed authentication. |
void |
onLoginSuccess(Map requestParamsMap,
HttpServletRequest request,
HttpServletResponse response,
SSOToken ssoToken)
Post processing on successful authentication. |
void |
onLogout(HttpServletRequest request,
HttpServletResponse response,
SSOToken ssoToken)
Post processing on Logout. |
Field Detail |
---|
static final String POST_PROCESS_LOGIN_SUCCESS_URL
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.
static final String POST_PROCESS_LOGIN_FAILURE_URL
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");
}
static final String POST_PROCESS_LOGOUT_URL
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");
}
Method Detail |
---|
void onLoginSuccess(Map requestParamsMap, HttpServletRequest request, HttpServletResponse response, SSOToken ssoToken) throws AuthenticationException
requestParamsMap
- map containing HttpServletRequest
parametersrequest
- HttpServletRequest
object.response
- HttpServletResponse
object.ssoToken
- authenticated user's single sign token.
AuthenticationException
- if there is an error.void onLoginFailure(Map requestParamsMap, HttpServletRequest request, HttpServletResponse response) throws AuthenticationException
requestParamsMap
- map containing HttpServletRequest
parameters.request
- HttpServletRequest
object.response
- HttpServletResponse
object.
- Throws:
AuthenticationException
- when there is an error.
void onLogout(HttpServletRequest request, HttpServletResponse response, SSOToken ssoToken) throws AuthenticationException
request
- HttpServletRequest
object.response
- HttpServletResponse
object.ssoToken
- authenticated user's single sign on token.
AuthenticationException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |