Package oracle.security.am.plugin

Class PluginResponse

java.lang.Object
oracle.security.am.plugin.PluginResponse
All Implemented Interfaces:
PluginAttribute
public class PluginResponse extends Object implements PluginAttribute
Responses that the plugin can be set to the execution contexts. Plugins can add the responses to the plug-in response using addResponse(PluginResponse response); method and the executor will extract the responses and set that to the respective contexts. Available attribute contexts are
  • PluginAttributeContextType.REQUEST to the request context.
  • PluginAttributeContextType.SESSION to OAM session object
  • PluginAttributeContextType.REDIRECT as redirect URL used after the process.
This class can be used to set responses to the session and set re-direct URLS absed on the authentication module processing. The responses are set to the context after the last authentication module execution so subsequent modules can overwrite the responses set by a modules.
Since:
OAM 11.1.1.2.0

  • Constructor Details

    • PluginResponse

      public PluginResponse<wbr>(String name, String value, PluginAttributeContextType contextType)
      constructor to create the plug-in response that can be set to session request etc.
      Parameters:
      name - the name
      value - the value
      contextType - the context type

    • PluginResponse

      public PluginResponse<wbr>(String name, String value, PluginAttributeContextType contextType, Map<String,<wbr>Object> additionalParam)
      constructor to create the plug-in response that can be set to session request etc.
      Parameters:
      name - the name
      value - the value
      contextType - the context type
      additionalParam - the additionalParam

    • PluginResponse

      public PluginResponse()
      Default Constructor

  • Method Details

    • getAdditionalParam

      public Map<String,<wbr>Object> getAdditionalParam()

    • setAdditionalParam

      public void setAdditionalParam<wbr>(Map<String,<wbr>Object> additionalParam)

    • getName

      public String getName()
      returns the name of the response attribute.
      Returns:
      the name

    • setName

      public void setName<wbr>(String name)
      sets the name of the response attribute.
      Parameters:
      name - the new name

    • getType

      public PluginAttributeContextType getType()
      get the attribute context type.
      Returns:
      the type

    • setType

      public void setType<wbr>(PluginAttributeContextType type)
      sets the attribute context type.
      Parameters:
      type - the new type

    • getValue

      public Object getValue()
      Get the attribute value.
      Returns:
      the value

    • setValue

      public void setValue<wbr>(Object value)
      sets the attribute value.
      Parameters:
      value - the new value

    • toStringForm

      public String toStringForm()
      Specified by:
      toStringForm in interface PluginAttribute

    • fromString

      public void fromString<wbr>(String token)
      Specified by:
      fromString in interface PluginAttribute

    • getKeyName

      public String getKeyName()
      Specified by:
      getKeyName in interface PluginAttribute

    • setKeyName

      public void setKeyName<wbr>(String keyName)
      Specified by:
      setKeyName in interface PluginAttribute

    • getObjName

      public String getObjName()
      Specified by:
      getObjName in interface PluginAttribute