Package oracle.security.am.plugin
Interface PluginContext
- All Superinterfaces:
PluginAttribute
- All Known Subinterfaces:
AuthenticationContext
- All Known Implementing Classes:
AbstractAuthnContext
,AbstractPluginContext
,AuthnContext
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.
- Since:
- OAM 11.1.1.2.0
-
Field Summary
Fields inherited from interface oracle.security.am.plugin.PluginAttribute
KEY_TAG
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addErrorCode<wbr>(oracle.security.am.common.utilities.constant.ErrorCode errorCode)
Adds an error code to the list of errors.void
addException<wbr>(Exception exception)
Adds an exception to the list.void
addResponse<wbr>(PluginResponse response)
Add a response to the context.void
deleteStateAttribute<wbr>(String attributeName)
Deletes the plugin state attribute that was set earlier.Returns the Execution Action.returns all the responses configured.Returns all the plugin state attributes and their valuesgets the client IP address.returns theClientProfile
object that contains the client specific attributes.oracle.security.am.common.utilities.constant.ErrorCode
returns the error code for the last error that occured during the execution.Returns the list of exceptions encountered during the processing.returns the identity store context.Returns the implementation type of the plug-in context implementationgetObjectAttribute<wbr>(String atrName)
This method returns the object attribute specified by the attribute name parameter.Returns the Object attribute map.getResponse<wbr>(PluginAttributeContextType type, String name)
returns the attributes for the target context and the name.getResponses<wbr>(PluginAttributeContextType type)
returns all the attributes for the target context.returns the OAM session object.Returns the starting step of the Composite Authentication module.getStateAttribute<wbr>(String attributeName)
Returns the pluginStateAttribute value or null if the state is not availablegetStringAttribute<wbr>(String atrName)
This method gives the String attribute specified by the attribute name parameter.Retuns the string attribute map.Transport context encapsulate the transport related handling in the request object.void
removeResponse<wbr>(PluginAttributeContextType type)
Removes the response of the specified typevoid
removeResponse<wbr>(PluginAttributeContextType type, String name)
Removes the response of the specified type and namevoid
setAction<wbr>(ExecutionAction executionAction)
Sets the Execution.void
setObjectAttribute<wbr>(String attrName, Object attrValue)
This method sets a Object attribute specified by the attribute name parameter and value.void
setStartingStep<wbr>(String startingStep)
Sets the starting step of the Composite authentication module.void
setStateAttribute<wbr>(String attributeName, Object attributeValue)
Sets the plugin state that can be used across pluginsvoid
setStringAttribute<wbr>(String attrName, 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 Details
-
getObjectAttribute
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
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
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 nameattrValue
- the attr value
-
setObjectAttribute
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 nameattrValue
- the attr value
-
getClientIPAddress
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
Returns the list of exceptions encountered during the processing.- Returns:
- the exception list
-
addException
Adds an exception to the list.- Parameters:
exception
- the exception
-
getObjectMap
Returns the Object attribute map.- Returns:
- the object map
-
getStringMap
Retuns the string attribute map.- Returns:
-
addErrorCode
void addErrorCode<wbr>(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
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
List<PluginResponse> getAllResponses()returns all the responses configured.- Returns:
PluginResponse
object
-
getClientProfile
ClientProfile getClientProfile()returns theClientProfile
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
returns all the attributes for the target context.- Parameters:
type
-- Returns:
List<PluginResponse>
-
getResponse
returns the attributes for the target context and the name.- Parameters:
type
-- Returns:
PluginResponse
-
getImplType
String getImplType()Returns the implementation type of the plug-in context implementation- Returns:
-
getStartingStep
String getStartingStep()Returns the starting step of the Composite Authentication module. This is set appropriately after the plugin executes a PAUSE- Returns:
-
setStartingStep
Sets the starting step of the Composite authentication module.- Parameters:
startingStep
-
-
removeResponse
Removes the response of the specified type- Parameters:
type
-
-
removeResponse
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
Sets the Execution.- Parameters:
ExecutionAction
-
-
setStateAttribute
Sets the plugin state that can be used across plugins- Parameters:
attributeName
- : attributeName represents the name of the plugin stateattributeValue
- : value to be stored in the state attribute
-
getStateAttribute
Returns the pluginStateAttribute value or null if the state is not available- Parameters:
attributeName
- : the name of the plugin state attribute
-
deleteStateAttribute
Deletes the plugin state attribute that was set earlier. This will make the state unavailable for subsequent plugins.- Parameters:
attributeName
- : the name of the plugin state attribute
-
getAllStateAttributes
Returns all the plugin state attributes and their values
-