oracle.security.am.plugin.impl

Class AbstractAuthnContext

java.lang.Object

oracle.security.am.plugin.impl.AbstractPluginContext

oracle.security.am.plugin.impl.AbstractAuthnContext

All Implemented Interfaces:

AuthenticationContext, PluginAttribute, PluginContext

Direct Known Subclasses:

AuthnContext

public abstract class AbstractAuthnContext
extends AbstractPluginContext
implements AuthenticationContext

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	clientIPAddress
protected ClientProfile	clientProfile
protected Credential	credential
protected ExecutionAction	executionAction
protected IdentityStoreContext	idStoreContext
protected java.util.HashMap<java.lang.String,java.lang.Object>	pluginStateAttribute
protected AMSession	session
protected java.lang.String	startingStep
protected GenericTransportContext	transportContext

Fields inherited from class oracle.security.am.plugin.impl.AbstractPluginContext

amSession, exceptionList, objectMap, pluginResponses, stringMap

Fields inherited from interface oracle.security.am.plugin.PluginAttribute

KEY_TAG

Constructor Summary

Constructors

Constructor and Description
AbstractAuthnContext()
AbstractAuthnContext(GenericTransportContext ctx, IdentityStoreContext idStore, Credential credential)
AbstractAuthnContext(java.lang.String clientIPAddress, ClientProfile clientProfile, AMSession session, PluginTransportContext transportContext, Credential credential)

Method Summary

Modifier and Type	Method and Description
void	deleteStateAttribute(java.lang.String attributeName) Deletes the plugin state attribute that was set earlier.
ExecutionAction	getAction() Returns the execution action that has been set in the authentication context
java.util.HashMap<java.lang.String,java.lang.Object>	getAllStateAttributes() Returns all the plugin state attributes and their values
java.lang.String	getImplType() returns the implementation type of the plugin.
java.lang.String	getStartingStep() Returns the starting step that has been set in the authentication context
java.lang.Object	getStateAttribute(java.lang.String attributeName) Returns the pluginStateAttribute value or null if the state is not available
void	setAction(ExecutionAction executionAction) Sets the execution action in the authentication context
void	setClientIPAddress(java.lang.String clientIPAddress)
void	setClientProfile(ClientProfile clientProfile)
void	setCredential(Credential credential)
void	setIdentityStoreContext(IdentityStoreContext idStoreContext)
void	setSession(AMSession session)
void	setStartingStep(java.lang.String startingStep) Sets the starting step in the authentication context
void	setStateAttribute(java.lang.String attributeName, java.lang.Object attributeValue) Sets the plugin state that can be used across plugins
void	setTransportContext(PluginTransportContext transportContext)

Methods inherited from class oracle.security.am.plugin.impl.AbstractPluginContext

addErrorCode, addException, addResponse, getAllResponses, getClientIPAddress, getClientProfile, getErrorCode, getExceptionList, getIdentityStoreContext, getObjectAttribute, getObjectMap, getResponse, getResponses, getSession, getStringAttribute, getStringMap, getTransportContext, removeResponse, removeResponse, setObjectAttribute, setStringAttribute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.security.am.plugin.authn.AuthenticationContext

getAuthenticationClass, getAuthnModuleConfig, getAuthnScheme, getCredential, getResourceURL, getSubject, setAuthenticationClass, setAuthnModuleConfig, setSubject

Methods inherited from interface oracle.security.am.plugin.PluginContext

addErrorCode, addException, addResponse, getAllResponses, getClientIPAddress, getClientProfile, getErrorCode, getExceptionList, getIdentityStoreContext, getObjectAttribute, getObjectMap, getResponse, getResponses, getSession, getStringAttribute, getStringMap, getTransportContext, removeResponse, removeResponse, setObjectAttribute, setStringAttribute

Methods inherited from interface oracle.security.am.plugin.PluginAttribute

fromString, getKeyName, getObjName, setKeyName, toStringForm

Field Detail

clientIPAddress

protected java.lang.String clientIPAddress

clientProfile

protected ClientProfile clientProfile

session

protected AMSession session

transportContext

protected GenericTransportContext transportContext

credential

protected Credential credential

idStoreContext

protected IdentityStoreContext idStoreContext

startingStep

protected java.lang.String startingStep

executionAction

protected ExecutionAction executionAction

pluginStateAttribute

protected java.util.HashMap<java.lang.String,java.lang.Object> pluginStateAttribute

Constructor Detail

AbstractAuthnContext

public AbstractAuthnContext()

AbstractAuthnContext

public AbstractAuthnContext(GenericTransportContext ctx,
                            IdentityStoreContext idStore,
                            Credential credential)

Parameters:

ctx -

idStore -

credential -

AbstractAuthnContext

public AbstractAuthnContext(java.lang.String clientIPAddress,
                            ClientProfile clientProfile,
                            AMSession session,
                            PluginTransportContext transportContext,
                            Credential credential)

Parameters:

clientIPAddress -

clientProfile -

session -

transportContext -

credential -

Method Detail

setClientIPAddress

public void setClientIPAddress(java.lang.String clientIPAddress)

Parameters:

clientIPAddress -

setClientProfile

public void setClientProfile(ClientProfile clientProfile)

Parameters:

clientProfile -

setSession

public void setSession(AMSession session)

Parameters:

session -

setTransportContext

public void setTransportContext(PluginTransportContext transportContext)

Parameters:

transportContext -

setCredential

public void setCredential(Credential credential)

Parameters:

credential -

setIdentityStoreContext

public void setIdentityStoreContext(IdentityStoreContext idStoreContext)

Parameters:

idStoreContext -

getImplType

public java.lang.String getImplType()

returns the implementation type of the plugin.

Specified by:

getImplType in interface PluginContext

Returns:

getStartingStep

public java.lang.String getStartingStep()

Returns the starting step that has been set in the authentication context

Specified by:

getStartingStep in interface PluginContext

Returns:

startingStep

setStartingStep

public void setStartingStep(java.lang.String startingStep)

Sets the starting step in the authentication context

Specified by:

setStartingStep in interface PluginContext

Parameters:

startingStep -

getAction

public ExecutionAction getAction()

Returns the execution action that has been set in the authentication context

Specified by:

getAction in interface PluginContext

Returns:

startingStep

setAction

public void setAction(ExecutionAction executionAction)

Sets the execution action in the authentication context

Specified by:

setAction in interface PluginContext

Parameters:

ExecutionAction -

setStateAttribute

public void setStateAttribute(java.lang.String attributeName,
                              java.lang.Object attributeValue)

Description copied from interface: PluginContext

Sets the plugin state that can be used across plugins

Specified by:

setStateAttribute in interface PluginContext

Parameters:

attributeName - : attributeName represents the name of the plugin state

getStateAttribute

public java.lang.Object getStateAttribute(java.lang.String attributeName)

Description copied from interface: PluginContext

Returns the pluginStateAttribute value or null if the state is not available

Specified by:

getStateAttribute in interface PluginContext

Parameters:

attributeName - : the name of the plugin state attribute

deleteStateAttribute

public void deleteStateAttribute(java.lang.String attributeName)

Description copied from interface: PluginContext

Deletes the plugin state attribute that was set earlier. This will make the state unavailable for subsequent plugins.

Specified by:

deleteStateAttribute in interface PluginContext

getAllStateAttributes

public java.util.HashMap<java.lang.String,java.lang.Object> getAllStateAttributes()

Description copied from interface: PluginContext

Returns all the plugin state attributes and their values

Specified by:

getAllStateAttributes in interface PluginContext