oracle.security.am.plugin.impl

Class AbstractPluginContext

java.lang.Object

oracle.security.am.plugin.impl.AbstractPluginContext

All Implemented Interfaces:

PluginAttribute, PluginContext

Direct Known Subclasses:

AbstractAuthnContext

public abstract class AbstractPluginContext
extends java.lang.Object
implements PluginContext

Field Summary

Fields

Modifier and Type	Field and Description
protected AMSession	amSession
protected java.lang.String	clientIPAddress
protected ClientProfile	clientProfile
protected java.util.List<java.lang.Exception>	exceptionList
protected java.util.Map<java.lang.String,java.lang.Object>	objectMap
protected java.util.List<PluginResponse>	pluginResponses
protected java.util.Map<java.lang.String,java.lang.String>	stringMap
protected GenericTransportContext	transportContext

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

KEY_TAG

Constructor Summary

Constructors

Constructor and Description
AbstractPluginContext()

Method Summary

Modifier and Type	Method and Description
void	addErrorCode(ErrorCode errorCode) Adds an error code to the list of errors.
void	addException(java.lang.Exception exception) Adds an exception to the list.
void	addResponse(PluginResponse response) Add a response to the context.
java.util.List<PluginResponse>	getAllResponses() returns all the responses configured.
java.lang.String	getClientIPAddress() gets the client IP address.
ClientProfile	getClientProfile() returns the ClientProfile object that contains the client specific attributes.
ErrorCode	getErrorCode() returns the error code for the last error that occured during the execution.
java.util.List<java.lang.Exception>	getExceptionList() Returns the list of exceptions encountered during the processing.
IdentityStoreContext	getIdentityStoreContext() returns the identity store context.
java.lang.Object	getObjectAttribute(java.lang.String atrName) This method returns the object attribute specified by the attribute name parameter.
java.util.Map<java.lang.String,java.lang.Object>	getObjectMap() Returns the Object attribute map.
PluginResponse	getResponse(PluginAttributeContextType type, java.lang.String name) returns the attributes for the target context and the name.
java.util.List<PluginResponse>	getResponses(PluginAttributeContextType type) returns all the attributes for the target context.
AMSession	getSession() returns the OAM session object.
java.lang.String	getStringAttribute(java.lang.String atrName) This method gives the String attribute specified by the attribute name parameter.
java.util.Map<java.lang.String,java.lang.String>	getStringMap() Retuns the string attribute map.
GenericTransportContext	getTransportContext() Transport context encapsulate the transport related handling in the request object.
void	removeResponse(PluginAttributeContextType type) Removes the response of the specified type
void	removeResponse(PluginAttributeContextType type, java.lang.String name) Removes the response of the specified type and name
void	setObjectAttribute(java.lang.String attrName, java.lang.Object attrValue) This method sets a Object attribute specified by the attribute name parameter and value.
void	setStringAttribute(java.lang.String attrName, java.lang.String attrValue) This method sets a String attribute specified by the attribute name parameter and value.

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.PluginContext

deleteStateAttribute, getAction, getAllStateAttributes, getImplType, getStartingStep, getStateAttribute, setAction, setStartingStep, setStateAttribute

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

fromString, getKeyName, getObjName, setKeyName, toStringForm

Field Detail

stringMap

protected java.util.Map<java.lang.String,java.lang.String> stringMap

objectMap

protected java.util.Map<java.lang.String,java.lang.Object> objectMap

exceptionList

protected java.util.List<java.lang.Exception> exceptionList

pluginResponses

protected java.util.List<PluginResponse> pluginResponses

clientProfile

protected ClientProfile clientProfile

transportContext

protected GenericTransportContext transportContext

amSession

protected AMSession amSession

clientIPAddress

protected java.lang.String clientIPAddress

Constructor Detail

AbstractPluginContext

public AbstractPluginContext()

Method Detail

addErrorCode

public void addErrorCode(ErrorCode errorCode)

Description copied from interface: PluginContext

Adds an error code to the list of errors. Error code will be translated to a fixed set of messages that will be displayed to the user if needed.

Specified by:

addErrorCode in interface PluginContext

Parameters:

errorCode - the error code

addException

public void addException(java.lang.Exception exception)

Description copied from interface: PluginContext

Adds an exception to the list.

Specified by:

addException in interface PluginContext

Parameters:

exception - the exception

addResponse

public void addResponse(PluginResponse response)

Description copied from interface: PluginContext

Add a response to the context. PluginResponse object need to be defined to set the context to which the attribute should be added.

Specified by:

addResponse in interface PluginContext

Parameters:

response - PluginResponse object

getAllResponses

public java.util.List<PluginResponse> getAllResponses()

Description copied from interface: PluginContext

returns all the responses configured.

Specified by:

getAllResponses in interface PluginContext

Returns:

PluginResponse object

getErrorCode

public ErrorCode getErrorCode()

Description copied from interface: PluginContext

returns the error code for the last error that occured during the execution.

Specified by:

getErrorCode in interface PluginContext

Returns:

the error code

getExceptionList

public java.util.List<java.lang.Exception> getExceptionList()

Description copied from interface: PluginContext

Returns the list of exceptions encountered during the processing.

Specified by:

getExceptionList in interface PluginContext

Returns:

the exception list

getClientIPAddress

public java.lang.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

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

Returns:

the client profile

getIdentityStoreContext

public IdentityStoreContext getIdentityStoreContext()

Description copied from interface: PluginContext

returns the identity store context.

Specified by:

getIdentityStoreContext in interface PluginContext

Returns:

the identity store context

getObjectAttribute

public java.lang.Object getObjectAttribute(java.lang.String atrName)

Description copied from interface: PluginContext

This method returns the object attribute specified by the attribute name parameter. All the data in the plug-in context will be stored in Object Map or String map and the data manipulation and access will be done using the get*Attribute, set*Attribute methods.

Specified by:

getObjectAttribute in interface PluginContext

Parameters:

atrName - String attribute name value.

Returns:

the object attribute

getObjectMap

public java.util.Map<java.lang.String,java.lang.Object> getObjectMap()

Description copied from interface: PluginContext

Returns the Object attribute map.

Specified by:

getObjectMap in interface PluginContext

Returns:

the object map

getStringAttribute

public java.lang.String getStringAttribute(java.lang.String atrName)

Description copied from interface: PluginContext

This method gives the String attribute specified by the attribute name parameter. All the data in the plug-in context will be stored in Object Map or String map and the data manipulation and access will be done using the get*Attribute, set*Attribute methods.

Specified by:

getStringAttribute in interface PluginContext

Parameters:

atrName - String attribute name value.

Returns:

the string attribute

getStringMap

public java.util.Map<java.lang.String,java.lang.String> getStringMap()

Description copied from interface: PluginContext

Retuns the string attribute map.

Specified by:

getStringMap in interface PluginContext

Returns:

setObjectAttribute

public void setObjectAttribute(java.lang.String attrName,
                               java.lang.Object attrValue)

Description copied from interface: PluginContext

This method sets a Object attribute specified by the attribute name parameter and value. All the data in the plug-in context will be stored in Object Map or String map and the data manipulation and access will be done using the get*Attribute, set*Attribute methods.

Specified by:

setObjectAttribute in interface PluginContext

Parameters:

attrName - the attr name

attrValue - the attr value

setStringAttribute

public void setStringAttribute(java.lang.String attrName,
                               java.lang.String attrValue)

Description copied from interface: PluginContext

This method sets a String attribute specified by the attribute name parameter and value. All the data in the plug-in context will be stored in Object Map or String map and the data manipulation and access will be done using the get*Attribute, set*Attribute methods.

Specified by:

setStringAttribute in interface PluginContext

Parameters:

attrName - the attr name

attrValue - the attr value

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

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

Returns:

a object.

getResponses

public java.util.List<PluginResponse> getResponses(PluginAttributeContextType type)

Description copied from interface: PluginContext

returns all the attributes for the target context.

Specified by:

getResponses in interface PluginContext

Returns:

List

getResponse

public PluginResponse getResponse(PluginAttributeContextType type,
                                  java.lang.String name)

Description copied from interface: PluginContext

returns the attributes for the target context and the name.

Specified by:

getResponse in interface PluginContext

Returns:

PluginResponse

removeResponse

public void removeResponse(PluginAttributeContextType type)

Description copied from interface: PluginContext

Removes the response of the specified type

Specified by:

removeResponse in interface PluginContext

removeResponse

public void removeResponse(PluginAttributeContextType type,
                           java.lang.String name)

Description copied from interface: PluginContext

Removes the response of the specified type and name

Specified by:

removeResponse in interface PluginContext