Package oracle.security.am.plugin.impl

Class AuthnContext

java.lang.Object

oracle.security.am.plugin.impl.AbstractPluginContext

oracle.security.am.plugin.impl.AbstractAuthnContext

oracle.security.am.plugin.impl.AuthnContext

All Implemented Interfaces:

AuthenticationContext, PluginAttribute, PluginContext

public class AuthnContext
extends AbstractAuthnContext

Field Summary

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

KEY_TAG

Constructor Summary

Constructors

Constructor	Description
AuthnContext()
AuthnContext<wbr>(Subject subject)
AuthnContext<wbr>(AuthenticationContext authnContext, GenericTransportContext pCtx, IdentityStoreContext idStore, Credential credential)
AuthnContext<wbr>(GenericTransportContext pCtx, IdentityStoreContext idStore, Credential credential)

Method Summary

Modifier and Type	Method	Description
void	fromString<wbr>(String token)
oracle.security.am.common.policy.runtime.AccessConstants.AUTH_CLASS	getAuthenticationClass()
AuthnModuleConfig	getAuthnModuleConfig()
PluginAuthnScheme	getAuthnScheme()	Returns the authentication scheme that initiated the authentication process.
String	getClientIPAddress()	gets the client IP address.
ClientProfile	getClientProfile()	returns the ClientProfile object that contains the client specific attributes.
Credential	getCredential()	Get credential for the authentication.
IdentityStoreContext	getIdentityStoreContext()	returns the identity store context.
String	getKeyName()
String	getObjName()
String	getResourceURL()
AMSession	getSession()	returns the OAM session object.
Subject	getSubject()	Retrieves a Subject from the authentication context.
GenericTransportContext	getTransportContext()	Transport context encapsulate the transport related handling in the request object.
void	setAuthenticationClass<wbr>(oracle.security.am.common.policy.runtime.AccessConstants.AUTH_CLASS authClass)
void	setAuthnModuleConfig<wbr>(AuthnModuleConfig config)
void	setAuthnScheme<wbr>(PluginAuthnScheme authnScheme)	sets the authentication scheme
void	setKeyName<wbr>(String keyName)
void	setResourceURL<wbr>(String resourceURL)
void	setSubject<wbr>(Subject subject)	sets a subject to the authentication context.
String	toStringForm()
String	toStringForm<wbr>(boolean isLogStr)

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

deleteStateAttribute, getAction, getAllStateAttributes, getHttpProxyHost, getHttpProxyPort, getImplType, getStartingStep, getStateAttribute, setAction, setClientIPAddress, setClientProfile, setCredential, setHttpProxyHost, setHttpProxyPort, setIdentityStoreContext, setSession, setStartingStep, setStateAttribute, setTransportContext

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

addErrorCode, addException, addResponse, getAllResponses, getErrorCode, getExceptionList, getObjectAttribute, getObjectMap, getResponse, getResponses, getStringAttribute, getStringMap, removeResponse, removeResponse, setObjectAttribute, setStringAttribute

Methods inherited from class java.lang.Object

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

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

addErrorCode, addException, addResponse, getAllResponses, getErrorCode, getExceptionList, getObjectAttribute, getObjectMap, getResponse, getResponses, getStringAttribute, getStringMap, removeResponse, removeResponse, setObjectAttribute, setStringAttribute

Constructor Details

AuthnContext

public AuthnContext()

AuthnContext

public AuthnContext<wbr>(Subject subject)

AuthnContext

public AuthnContext<wbr>(GenericTransportContext pCtx,
 IdentityStoreContext idStore,
 Credential credential)

AuthnContext

public AuthnContext<wbr>(AuthenticationContext authnContext,
 GenericTransportContext pCtx,
 IdentityStoreContext idStore,
 Credential credential)

Method Details

getCredential

public Credential getCredential()

Description copied from interface: AuthenticationContext

Get credential for the authentication.

Returns:

a {@link Credential) object.

getSubject

public Subject getSubject()

Description copied from interface: AuthenticationContext

Retrieves a Subject from the authentication context. If the subject is not available the method will return null.

Returns:

the subject

setSubject

public void setSubject<wbr>(Subject subject)

Description copied from interface: AuthenticationContext

sets a subject to the authentication context.

Parameters:

subject - Subject

getClientIPAddress

public String getClientIPAddress()

Description copied from interface: PluginContext

gets the client IP address. For HTTP protocol it will be the IP address of the browser.

Specified by:

getClientIPAddress in interface PluginContext

Overrides:

getClientIPAddress in class AbstractPluginContext

Returns:

IPAddress a String value;

getClientProfile

public ClientProfile getClientProfile()

Description copied from interface: PluginContext

returns the ClientProfile object that contains the client specific attributes.

Specified by:

getClientProfile in interface PluginContext

Overrides:

getClientProfile in class AbstractPluginContext

Returns:

the client profile

getSession

public AMSession getSession()

Description copied from interface: PluginContext

returns the OAM session object. OAMSession can be used to access session attributes.

Specified by:

getSession in interface PluginContext

Overrides:

getSession in class AbstractPluginContext

Returns:

OAMSession object.

getTransportContext

public GenericTransportContext getTransportContext()

Description copied from interface: PluginContext

Transport context encapsulate the transport related handling in the request object.

Specified by:

getTransportContext in interface PluginContext

Overrides:

getTransportContext in class AbstractPluginContext

Returns:

a object.

getIdentityStoreContext

public IdentityStoreContext getIdentityStoreContext()

Description copied from interface: PluginContext

returns the identity store context.

Specified by:

getIdentityStoreContext in interface PluginContext

Overrides:

getIdentityStoreContext in class AbstractPluginContext

Returns:

the identity store context

getAuthnModuleConfig

public AuthnModuleConfig getAuthnModuleConfig()

Returns:

setAuthnModuleConfig

public void setAuthnModuleConfig<wbr>(AuthnModuleConfig config)

getAuthenticationClass

public oracle.security.am.common.policy.runtime.AccessConstants.AUTH_CLASS getAuthenticationClass()

setAuthenticationClass

public void setAuthenticationClass<wbr>(oracle.security.am.common.policy.runtime.AccessConstants.AUTH_CLASS authClass)

toStringForm

public String toStringForm()

toStringForm

public String toStringForm<wbr>(boolean isLogStr)

fromString

public void fromString<wbr>(String token)

getKeyName

public String getKeyName()

setKeyName

public void setKeyName<wbr>(String keyName)

getObjName

public String getObjName()

setResourceURL

public void setResourceURL<wbr>(String resourceURL)

getResourceURL

public String getResourceURL()

getAuthnScheme

public PluginAuthnScheme getAuthnScheme()

Description copied from interface: AuthenticationContext

Returns the authentication scheme that initiated the authentication process. Configuration parameters for authetnication scheme will be available through PluginAuthnScheme object.

setAuthnScheme

public void setAuthnScheme<wbr>(PluginAuthnScheme authnScheme)

sets the authentication scheme

Parameters:

authnScheme -