oracle.security.jps.callback

Interface IdentityCallbackHandler

All Superinterfaces:

javax.security.auth.callback.CallbackHandler

public interface IdentityCallbackHandler
extends javax.security.auth.callback.CallbackHandler

Each Identity Callback hanlder must implement this interface

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getIdentity() User must implement this method and return the valid authenticated identity
javax.security.auth.Subject	getSubject() User should implement this method and can return the valid subject if LoginModule is not used for subject population and the subject.loginmodule.disabled property is set to true.
boolean	isIdentityAsserted() User should implement this method and must set the valid authenticated state and it can not be null in any case.
void	setApplicationContextName(java.lang.String contextName) set contextName for callback handling
void	setAuthenticationType(java.lang.String authenticationType) User should implement this method and must set the valid authenticated identity and it can not be null in any case.
void	setIdentity(java.lang.String identity) User must implement this method and set the valid authenticated identity
void	setIdentityAsserted(boolean authState) User should implement this method and must set the valid authenticated state and it can not be null in any case.
void	setRequest(javax.servlet.http.HttpServletRequest request) set HttpRequestCallback for callback handling
void	setResponse(javax.servlet.http.HttpServletResponse response) set HttpResponseCallback for callback handling
void	setSession(java.lang.Object object) This method can be used to pass any session object from Identity Asserter to Login module if needed
void	setSessionCookie(java.lang.String sessionCookie) sets session cookie in callback handling
void	setSubject(javax.security.auth.Subject subject) User should implement this method and can set the valid subject if LoginModule is not used for subject population and the subject.loginmodule.disabled property is set to true.

Methods inherited from interface javax.security.auth.callback.CallbackHandler

handle

Method Detail

setIdentity

void setIdentity(java.lang.String identity)
                 throws oracle.security.jps.service.idm.asserter.AsserterException

User must implement this method and set the valid authenticated identity

Parameters:

identity - The valid identity

Throws:

oracle.security.jps.service.idm.asserter.AsserterException - if identity is not asserted

getIdentity

java.lang.String getIdentity()

User must implement this method and return the valid authenticated identity

Returns:

String The valid identity

setSubject

void setSubject(javax.security.auth.Subject subject)

User should implement this method and can set the valid subject if LoginModule is not used for subject population and the subject.loginmodule.disabled property is set to true. This can be null

Parameters:

subject - The valid subject

getSubject

javax.security.auth.Subject getSubject()

User should implement this method and can return the valid subject if LoginModule is not used for subject population and the subject.loginmodule.disabled property is set to true. This can be null

Returns:

Subject The valid subject

setAuthenticationType

void setAuthenticationType(java.lang.String authenticationType)

User should implement this method and must set the valid authenticated identity and it can not be null in any case.

Parameters:

authenticationType - The valid identity Type

setIdentityAsserted

void setIdentityAsserted(boolean authState)

User should implement this method and must set the valid authenticated state and it can not be null in any case.

Parameters:

authState - The valid authentication State

isIdentityAsserted

boolean isIdentityAsserted()

User should implement this method and must set the valid authenticated state and it can not be null in any case.

Returns:

The valid authentication state

setSessionCookie

void setSessionCookie(java.lang.String sessionCookie)

sets session cookie in callback handling

Parameters:

sessionCookie - - The session cookie

setResponse

void setResponse(javax.servlet.http.HttpServletResponse response)

set HttpResponseCallback for callback handling

Parameters:

response - - the http response

setRequest

void setRequest(javax.servlet.http.HttpServletRequest request)

set HttpRequestCallback for callback handling

Parameters:

request - - the http request

setApplicationContextName

void setApplicationContextName(java.lang.String contextName)

set contextName for callback handling

Parameters:

contextName - - The context name

setSession

void setSession(java.lang.Object object)

This method can be used to pass any session object from Identity Asserter to Login module if needed

Parameters:

object - - The session object