Package oracle.security.am.plugin.impl

Class PluginTransportContext

java.lang.Object
oracle.security.am.plugin.impl.AbstractPluginTransportContext
oracle.security.am.plugin.impl.PluginTransportContext
All Implemented Interfaces:
GenericTransportContext
public class PluginTransportContext extends AbstractPluginTransportContext
Handle to the underlying transport protocol. The object will wrap the protocol specific object and give a common interface for protocol agnostic handling. In case of HTTP this object will hold the HTTPRequest and HTTPResponse objects and will be exposed in a protocol agnostic fashion.
Since:
OAM 11.1.1.2.0

  • Constructor Details

    • PluginTransportContext

      public PluginTransportContext<wbr>(GenericTransportHandler transportHandler)
      Instantiates a new PluginTransportContext.
      Parameters:
      transportHandler - the transport handler

  • Method Details

    • getAttribute

      public Object getAttribute<wbr>(oracle.security.am.common.utilities.constant.CommonAttribute attribute)
      Description copied from interface: GenericTransportContext
      Gets the attribute.
      Returns:
      the attribute

    • getAttributeNames

      public Iterator<oracle.security.am.common.utilities.constant.CommonAttribute> getAttributeNames()
      Description copied from interface: GenericTransportContext
      Gets the attribute names.
      Returns:
      the attribute names

    • getAttributes

      public Map<String,<wbr>Object[]> getAttributes()
      Description copied from interface: GenericTransportContext
      Gets the attributes.
      Returns:
      the attributes

    • getErrorCode

      public String getErrorCode()
      Description copied from interface: GenericTransportContext
      returns the error code. Error code will be used to disply the Error message at the client console. Error codes will be defined in the UI resource bundle.
      Returns:
      the errorCode

    • getLocale

      public Locale getLocale()
      Returns:

    • getParameterValue

      public String getParameterValue<wbr>(String parameterName)
      Description copied from interface: GenericTransportContext
      Gets the parameter value.
      Parameters:
      parameterName - the parameter name
      Returns:
      the parameter value

    • getParameters

      public Map<String,<wbr>String> getParameters()
      Description copied from interface: GenericTransportContext
      Gets the parameters.
      Returns:
      the parameters

    • getRequestURI

      public String getRequestURI()
      Description copied from interface: GenericTransportContext
      Gets the request uri.
      Returns:
      the request uri

    • getSessionStore

      public GenericTransportStore getSessionStore()
      Returns:

    • getToken

      public GenericTransportToken getToken<wbr>(String tokenName, boolean isVersioned)
      Description copied from interface: GenericTransportContext
      Gets the token.
      Parameters:
      tokenName - the token name
      isVersioned - the is versioned
      Returns:
      the token

    • getTransportRequest

      public Object getTransportRequest()
      Returns:

    • getTransportSession

      public Object getTransportSession<wbr>(boolean create)
      Description copied from interface: GenericTransportContext
      Gets the transport session.
      Returns:
      the transport session

    • getTransportSessionID

      public String getTransportSessionID()
      Description copied from interface: GenericTransportContext
      Set Session ID for the tranport session.
      Returns:

    • getUserAgent

      public String getUserAgent()
      Returns:

    • getRequestMethod

      public String getRequestMethod()
      Returns:

    • setAttribute

      public void setAttribute<wbr>(oracle.security.am.common.utilities.constant.CommonAttribute attribute, Object value)
      Description copied from interface: GenericTransportContext
      Sets the attribute.
      value - the value

    • setErrorCode

      public void setErrorCode<wbr>(String code)
      Description copied from interface: GenericTransportContext
      sets the error code. Error code will be used to disply the Error message at the client console. Error codes will be defined in the UI resource bundle.
      Parameters:
      code - the errorCode to set

    • setToken

      public void setToken<wbr>(GenericTransportToken token, boolean isVersioned)
      Description copied from interface: GenericTransportContext
      Sets the token.
      Parameters:
      token - the token
      isVersioned - the is versioned

    • setTransportSessionID

      public void setTransportSessionID<wbr>(String sessId)
      Description copied from interface: GenericTransportContext
      Sets the session ID for the transport. Http Session ID for http sessions

    • unsetToken

      public void unsetToken<wbr>(String tokenName)
      Description copied from interface: GenericTransportContext
      Unset token.
      Parameters:
      tokenName - the token name

    • unsetToken

      public void unsetToken<wbr>(GenericTransportToken token)
      Description copied from interface: GenericTransportContext
      Unset token providing the token object

    • getParameters

      public Map<String,<wbr>String> getParameters<wbr>(GenericTransportContext.PARAM_TYPE type)
      Description copied from interface: GenericTransportContext
      Gets the parameters.
      Returns:
      the parameters