Skip navigation links

Oracle Fusion Middleware Extensibility Java API Reference for Oracle Access Management Access Manager
11g Release 2 (11.1.2.1.0)

E27137-02


oracle.security.am.plugin
Interface GenericTransportContext


public interface GenericTransportContext

The GenericTransportContext class.

Since:
OAM 11.1.1.5.0
Version:
OAM 11.1.2.0.0

Nested Class Summary
static class GenericTransportContext.PARAM_TYPE
          Parameter type.

 

Method Summary
 java.lang.Object getAttribute(oracle.security.am.common.utilities.constant.CommonAttribute attribute)
          Gets the attribute.
 java.util.Iterator<oracle.security.am.common.utilities.constant.CommonAttribute> getAttributeNames()
          Gets the attribute names.
 java.util.Map<java.lang.String,java.lang.Object[]> getAttributes()
          Gets the attributes.
 java.lang.String getErrorCode()
          returns the error code.
 java.util.Locale getLocale()
           
 java.util.Map<java.lang.String,java.lang.String> getParameters()
          Gets the parameters.
 java.util.Map<java.lang.String,java.lang.String> getParameters(GenericTransportContext.PARAM_TYPE type)
          Gets the parameters.
 java.lang.String getParameterValue(java.lang.String parameterName)
          Gets the parameter value.
 java.lang.String getRequestURI()
          Gets the request uri.
 GenericTransportStore getSessionStore()
           
 GenericTransportToken getToken(java.lang.String tokenName, boolean isVersioned)
          Gets the token.
 java.lang.Object getTransportRequest()
           
 java.lang.Object getTransportSession(boolean create)
          Gets the transport session.
 java.lang.String getTransportSessionID()
          Set Session ID for the tranport session.
 java.lang.String getUserAgent()
           
 void setAttribute(oracle.security.am.common.utilities.constant.CommonAttribute attribute, java.lang.Object value)
          Sets the attribute.
 void setErrorCode(java.lang.String code)
          sets the error code.
 void setToken(GenericTransportToken token, boolean isVersioned)
          Sets the token.
 void setTransportSessionID(java.lang.String sessId)
          Sets the session ID for the transport.
 void unsetToken(GenericTransportToken token)
          Unset token providing the token object
 void unsetToken(java.lang.String tokenName)
          Unset token.

 

Method Detail

getRequestURI

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

getToken

GenericTransportToken getToken(java.lang.String tokenName,
                               boolean isVersioned)
Gets the token.
Parameters:
tokenName - the token name
isVersioned - the is versioned
Returns:
the token

getParameterValue

java.lang.String getParameterValue(java.lang.String parameterName)
Gets the parameter value.
Parameters:
parameterName - the parameter name
Returns:
the parameter value

setToken

void setToken(GenericTransportToken token,
              boolean isVersioned)
Sets the token.
Parameters:
token - the token
isVersioned - the is versioned

unsetToken

void unsetToken(java.lang.String tokenName)
Unset token.
Parameters:
tokenName - the token name

unsetToken

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

setAttribute

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

getAttributeNames

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

getAttribute

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

setTransportSessionID

void setTransportSessionID(java.lang.String sessId)
Sets the session ID for the transport. Http Session ID for http sessions
Parameters:
sessId -

getTransportSessionID

java.lang.String getTransportSessionID()
Set Session ID for the tranport session.
Returns:

getParameters

java.util.Map<java.lang.String,java.lang.String> getParameters()
Gets the parameters.
Returns:
the parameters

getParameters

java.util.Map<java.lang.String,java.lang.String> getParameters(GenericTransportContext.PARAM_TYPE type)
Gets the parameters.
Returns:
the parameters

getAttributes

java.util.Map<java.lang.String,java.lang.Object[]> getAttributes()
Gets the attributes.
Returns:
the attributes

getTransportSession

java.lang.Object getTransportSession(boolean create)
Gets the transport session.
Returns:
the transport session

getErrorCode

java.lang.String getErrorCode()
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

setErrorCode

void setErrorCode(java.lang.String code)
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

getSessionStore

GenericTransportStore getSessionStore()
Returns:

getTransportRequest

java.lang.Object getTransportRequest()
Returns:

getLocale

java.util.Locale getLocale()
Returns:

getUserAgent

java.lang.String getUserAgent()
Returns:

Skip navigation links

Oracle Fusion Middleware Extensibility Java API Reference for Oracle Access Management Access Manager
11g Release 2 (11.1.2.1.0)

E27137-02


Copyright © 2013, Oracle Corp. All Rights Reserved.