Package oracle.security.am.plugin

Interface PluginContext

All Superinterfaces:
PluginAttribute
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.
Since:
OAM 11.1.1.2.0

  • Method Details

    • getObjectAttribute

      Object getObjectAttribute<wbr>(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

      String getStringAttribute<wbr>(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<wbr>(String attrName, 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<wbr>(String attrName, 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

      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

      List<Exception> getExceptionList()
      Returns the list of exceptions encountered during the processing.
      Returns:
      the exception list

    • addException

      void addException<wbr>(Exception exception)
      Adds an exception to the list.
      Parameters:
      exception - the exception

    • getObjectMap

      Map<String,<wbr>Object> getObjectMap()
      Returns the Object attribute map.
      Returns:
      the object map

    • getStringMap

      Map<String,<wbr>String> 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

      void addResponse<wbr>(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

      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

      oracle.security.am.engines.common.identity.api.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

      List<PluginResponse> getResponses<wbr>(PluginAttributeContextType type)
      returns all the attributes for the target context.
      Parameters:
      type -
      Returns:
      List<PluginResponse>

    • getResponse

      PluginResponse getResponse<wbr>(PluginAttributeContextType type, String name)
      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

      void setStartingStep<wbr>(String startingStep)
      Sets the starting step of the Composite authentication module.
      Parameters:
      startingStep -

    • removeResponse

      void removeResponse<wbr>(PluginAttributeContextType type)
      Removes the response of the specified type
      Parameters:
      type -

    • removeResponse

      void removeResponse<wbr>(PluginAttributeContextType type, 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<wbr>(ExecutionAction executionAction)
      Sets the Execution.
      Parameters:
      ExecutionAction -

    • setStateAttribute

      void setStateAttribute<wbr>(String attributeName, Object attributeValue)
      Sets the plugin state that can be used across plugins
      Parameters:
      attributeName - : attributeName represents the name of the plugin state
      attributeValue - : value to be stored in the state attribute

    • getStateAttribute

      Object getStateAttribute<wbr>(String attributeName)
      Returns the pluginStateAttribute value or null if the state is not available
      Parameters:
      attributeName - : the name of the plugin state attribute

    • deleteStateAttribute

      void deleteStateAttribute<wbr>(String attributeName)
      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

      HashMap<String,<wbr>Object> getAllStateAttributes()
      Returns all the plugin state attributes and their values