Skip navigation links

oracle.security.am.plugin
Interface GenericTransportContext

public interface GenericTransportContext

The GenericTransportContext holds the transport specific properties. All the transport specific properties like HTTP Request Session etc for HTTP and other objects for OAM and other protocols can be accessed from transport context.

Since:

OAM 11.1.1.5.0

Version:

OAM 11.1.1.5.0

Method Summary

java.lang.Object	getAttribute(CommonAttribute attribute) Gets the attribute.
java.util.Iterator<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() Gets the locale.
java.util.Map<java.lang.String,java.lang.String>	getParameters() 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() Gets the GenericTransportStore object.
GenericTransportToken	getToken(java.lang.String tokenName, boolean isVersioned) Gets the token.
java.lang.Object	getTransportRequest() gets the TranportRequest object.
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() Gets the user agent name.
void	setAttribute(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(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

setAttribute

void setAttribute(CommonAttribute attribute,
                  java.lang.Object value)

Sets the attribute.

Parameters:

name - the name

value - the value

getAttributeNames

java.util.Iterator<CommonAttribute> getAttributeNames()

Gets the attribute names.

Returns:

the attribute names

getAttribute

java.lang.Object getAttribute(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

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()

Gets the GenericTransportStore object.

Returns:

getTransportRequest

java.lang.Object getTransportRequest()

gets the TranportRequest object. This object can be cast to transport specific object based on the protocol like HTTPREquest.

Returns:

getLocale

java.util.Locale getLocale()

Gets the locale.

Returns:

getUserAgent

java.lang.String getUserAgent()

Gets the user agent name.

Returns:

Skip navigation links