|
Oracle Access Manager Extensibility Java API Reference 11g Release 1 (11.1.1.5) E22473-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PluginContext
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.
Method Summary | |
---|---|
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.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 |
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 |
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. |
Method Detail |
---|
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>
PluginResponse getResponse(PluginAttributeContextType type, java.lang.String name)
type
-PluginResponse
java.lang.String getImplType()
|
Oracle Access Manager Extensibility Java API Reference 11g Release 1 (11.1.1.5) E22473-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |