Package oracle.security.am.plugin

Interface GenericTransportHandler

public interface GenericTransportHandler
The GenericTransportHandler class.
Since:
NGAMv1.0

  • Method Details

    • getAttributesMap

      Map<String,<wbr>Object[]> getAttributesMap()
      Gets the attributes map.
      Returns:
      the attributes map

    • getRequestURI

      String getRequestURI()
      Gets the request uri.
      Returns:
      the request uri

    • getPropertiesMap

      Map<String,<wbr>String> getPropertiesMap()
      Gets the properties map.
      Returns:
      the properties map

    • getPropertiesMap

      Map<String,<wbr>String> getPropertiesMap<wbr>(GenericTransportContext.PARAM_TYPE type)
      Gets the properties map.
      Returns:
      the properties map

    • getToken

      GenericTransportToken getToken<wbr>(String tokenName, boolean isVersioned)
      Gets the token.
      Parameters:
      token - the transport token
      isVersioned - if the token is a versioned one
      Returns:
      the token

    • setToken

      void setToken<wbr>(GenericTransportToken token, boolean isVersioned)
      Sets the token.
      Parameters:
      token - the transport token
      isVersioned - if the token is a versioned one

    • getParameterValues

      String[] getParameterValues<wbr>(String parameterName)
      Gets the parameter values.
      Parameters:
      parameterName - the parameter name
      Returns:
      the parameter values

    • setAttribute

      void setAttribute<wbr>(oracle.security.am.common.utilities.constant.CommonAttribute attribute, Object value)
      Sets the attribute.
      Parameters:
      name - the name
      value - the value

    • getAttribute

      Object getAttribute<wbr>(oracle.security.am.common.utilities.constant.CommonAttribute attribute)
      Gets the attribute.
      Parameters:
      name - the name
      Returns:
      the attribute

    • unsetToken

      void unsetToken<wbr>(String tokenName)
      Unset token.
      Parameters:
      tokenName - the token name

    • unsetToken

      void unsetToken<wbr>(GenericTransportToken token)
      Unset token providing the token object
      Parameters:
      token -

    • getAttributeNames

      Iterator<oracle.security.am.common.utilities.constant.CommonAttribute> getAttributeNames()
      Gets the attribute names.
      Returns:
      the attribute names

    • getTransportSession

      Object getTransportSession<wbr>(boolean crate)

    • getSessionStore

      GenericTransportStore getSessionStore()
      Creates a session store using the attributes stored in the session.
      Returns:
      SessionStore object

    • getTransportRequest

      Object getTransportRequest()

    • getLocale

      Locale getLocale()

    • getUserAgent

      String getUserAgent()
      Returns the clients useragent information
      Returns:

    • getTokens

      List<GenericTransportToken> getTokens()
      Returns the list of tokens those were set using setToken().

    • getRequestMethod

      String getRequestMethod()
      The method returns the type of method used to hit the OAM server for access.
      Returns:
      Returns Method with which this request was made to OAM server, for example, GET, POST, PUT etc. The method may return null if the transport handler does not have a notion of access method, say for protocols like NAP.