Package 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 Object implements PluginContext

  • Constructor Details

    • AbstractPluginContext

      public AbstractPluginContext()

  • Method Details

    • addErrorCode

      public void addErrorCode<wbr>(oracle.security.am.common.utilities.constant.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<wbr>(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<wbr>(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 List<PluginResponse> getAllResponses()
      Description copied from interface: PluginContext
      returns all the responses configured.
      Specified by:
      getAllResponses in interface PluginContext
      Returns:
      PluginResponse object

    • getErrorCode

      public oracle.security.am.common.utilities.constant.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 List<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 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 Object getObjectAttribute<wbr>(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 Map<String,<wbr>Object> getObjectMap()
      Description copied from interface: PluginContext
      Returns the Object attribute map.
      Specified by:
      getObjectMap in interface PluginContext
      Returns:
      the object map

    • getStringAttribute

      public String getStringAttribute<wbr>(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 Map<String,<wbr>String> getStringMap()
      Description copied from interface: PluginContext
      Retuns the string attribute map.
      Specified by:
      getStringMap in interface PluginContext
      Returns:

    • setObjectAttribute

      public void setObjectAttribute<wbr>(String attrName, 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<wbr>(String attrName, 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 List<PluginResponse> getResponses<wbr>(PluginAttributeContextType type)
      Description copied from interface: PluginContext
      returns all the attributes for the target context.
      Specified by:
      getResponses in interface PluginContext
      Returns:
      List<PluginResponse>

    • getResponse

      public PluginResponse getResponse<wbr>(PluginAttributeContextType type, 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<wbr>(PluginAttributeContextType type)
      Description copied from interface: PluginContext
      Removes the response of the specified type
      Specified by:
      removeResponse in interface PluginContext

    • removeResponse

      public void removeResponse<wbr>(PluginAttributeContextType type, String name)
      Description copied from interface: PluginContext
      Removes the response of the specified type and name
      Specified by:
      removeResponse in interface PluginContext