public interface PluginContext extends PluginAttribute
KEY_TAG
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.
|
void |
deleteStateAttribute(java.lang.String attributeName)
Deletes the plugin state attribute that was set earlier.
|
ExecutionAction |
getAction()
Returns the Execution Action.
|
java.util.List<PluginResponse> |
getAllResponses()
returns all the responses configured.
|
java.util.HashMap<java.lang.String,java.lang.Object> |
getAllStateAttributes()
Returns all the plugin state attributes and their values
|
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.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.Object |
getStateAttribute(java.lang.String attributeName)
Returns the pluginStateAttribute value or null if the state is not available
|
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 |
setStateAttribute(java.lang.String attributeName,
java.lang.Object attributeValue)
Sets the plugin state that can be used across plugins
|
void |
setStringAttribute(java.lang.String attrName,
java.lang.String attrValue)
This method sets a String attribute specified by the attribute name
parameter and value.
|
fromString, getKeyName, getObjName, setKeyName, toStringForm
java.lang.Object getObjectAttribute(java.lang.String atrName)
atrName
- String
attribute name value.java.lang.String getStringAttribute(java.lang.String atrName)
atrName
- String
attribute name value.void setStringAttribute(java.lang.String attrName, java.lang.String attrValue)
attrName
- the attr nameattrValue
- the attr valuevoid setObjectAttribute(java.lang.String attrName, java.lang.Object attrValue)
attrName
- the attr nameattrValue
- the attr valuejava.lang.String getClientIPAddress()
GenericTransportContext getTransportContext()
java.util.List<java.lang.Exception> getExceptionList()
void addException(java.lang.Exception exception)
exception
- the exceptionjava.util.Map<java.lang.String,java.lang.Object> getObjectMap()
java.util.Map<java.lang.String,java.lang.String> getStringMap()
void addErrorCode(ErrorCode errorCode)
errorCode
- the error codeErrorCode getErrorCode()
void addResponse(PluginResponse response)
response
- PluginResponse
objectjava.util.List<PluginResponse> getAllResponses()
PluginResponse
objectClientProfile getClientProfile()
ClientProfile
object that contains
the client specific attributes.IdentityStoreContext getIdentityStoreContext()
AMSession getSession()
OAMSession
object.java.util.List<PluginResponse> getResponses(PluginAttributeContextType type)
type
- List
PluginResponse getResponse(PluginAttributeContextType type, java.lang.String name)
type
- PluginResponse
java.lang.String getImplType()
java.lang.String getStartingStep()
void setStartingStep(java.lang.String startingStep)
startingStep
- void removeResponse(PluginAttributeContextType type)
type
- void removeResponse(PluginAttributeContextType type, java.lang.String name)
type
- name
- ExecutionAction getAction()
void setAction(ExecutionAction executionAction)
ExecutionAction
- void setStateAttribute(java.lang.String attributeName, java.lang.Object attributeValue)
attributeName
- : attributeName represents the name of the plugin stateattributeValue:
- value to be stored in the state attributejava.lang.Object getStateAttribute(java.lang.String attributeName)
attributeName
- : the name of the plugin state attributevoid deleteStateAttribute(java.lang.String attributeName)
attributeName:
- the name of the plugin state attributejava.util.HashMap<java.lang.String,java.lang.Object> getAllStateAttributes()