Skip navigation links

oracle.security.am.plugin
Interface PluginContext

All Superinterfaces:

PluginAttribute

All Known Subinterfaces:

AuthenticationContext

public interface PluginContext

extends PluginAttribute

Context used by the plug-ins to retrieve the attributes and set the attributes to be used by other plug-ins that gets executed in the flow. All the string attributes stored in the context will be persisted and retrieved while the execution resumes. All custom java object needs to be persisted should be serialized to string and save to the context and should be retrieved in the plug-in. Custom java object serialization and de serialization should be handled by plug-in.

Since:

OAM 11.1.1.5.0

Version:

OAM 11.1.2.0.0

Field Summary

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

KEY_TAG

Method Summary

void	addErrorCode(oracle.security.am.common.utilities.constant.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.
ExecutionAction	getAction() Returns the Execution Action.
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.
oracle.security.am.common.utilities.constant.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.String	getImplType() Returns the implementation type of the plug-in context implementation
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	getStartingStep() Returns the starting step of the Composite Authentication module.
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	setAction(ExecutionAction executionAction) Sets the Execution.
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	setStartingStep(java.lang.String startingStep) Sets the starting step of the Composite authentication module.
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 interface oracle.security.am.plugin.PluginAttribute

fromString, getKeyName, getObjName, setKeyName, toStringForm

Method Detail

getObjectAttribute

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

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.

Parameters:

atrName - String attribute name value.

Returns:

the object attribute

getStringAttribute

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

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.

Parameters:

atrName - String attribute name value.

Returns:

the string attribute

setStringAttribute

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

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.

Parameters:

attrName - the attr name

attrValue - the attr value

setObjectAttribute

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

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.

Parameters:

attrName - the attr name

attrValue - the attr value

getClientIPAddress

java.lang.String getClientIPAddress()

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

Returns:

IPAddress a String value;

getTransportContext

GenericTransportContext getTransportContext()

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

Returns:

a object.

getExceptionList

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

Returns the list of exceptions encountered during the processing.

Returns:

the exception list

addException

void addException(java.lang.Exception exception)

Adds an exception to the list.

Parameters:

exception - the exception

getObjectMap

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

Returns the Object attribute map.

Returns:

the object map

getStringMap

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

Retuns the string attribute map.

Returns:

addErrorCode

void addErrorCode(oracle.security.am.common.utilities.constant.ErrorCode errorCode)

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.

Parameters:

errorCode - the error code

getErrorCode

oracle.security.am.common.utilities.constant.ErrorCode getErrorCode()

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

Returns:

the error code

addResponse

void addResponse(PluginResponse response)

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

Parameters:

response - PluginResponse object

getAllResponses

java.util.List<PluginResponse> getAllResponses()

returns all the responses configured.

Returns:

PluginResponse object

getClientProfile

ClientProfile getClientProfile()

returns the ClientProfile object that contains the client specific attributes.

Returns:

the client profile

getIdentityStoreContext

IdentityStoreContext getIdentityStoreContext()

returns the identity store context.

Returns:

the identity store context

getSession

AMSession getSession()

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

Returns:

OAMSession object.

getResponses

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

returns all the attributes for the target context.

Parameters:

type -

Returns:

List<PluginResponse>

getResponse

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

returns the attributes for the target context and the name.

Parameters:

type -

Returns:

PluginResponse

getImplType

java.lang.String getImplType()

Returns the implementation type of the plug-in context implementation

Returns:

getStartingStep

java.lang.String getStartingStep()

Returns the starting step of the Composite Authentication module. This is set appropriately after the plugin executes a PAUSE

Returns:

setStartingStep

void setStartingStep(java.lang.String startingStep)

Sets the starting step of the Composite authentication module.

Parameters:

startingStep -

removeResponse

void removeResponse(PluginAttributeContextType type)

Removes the response of the specified type

Parameters:

type -

removeResponse

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

Removes the response of the specified type and name

Parameters:

type -

name -

getAction

ExecutionAction getAction()

Returns the Execution Action. This is set appropriately after the plugin executes a PAUSE

Returns:

setAction

void setAction(ExecutionAction executionAction)

Sets the Execution.

Parameters:

ExecutionAction -

Skip navigation links