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

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.security.am.plugin.GenericTransportContext

GenericTransportContext.PARAM_TYPE

Field Summary

Fields inherited from class oracle.security.am.plugin.impl.AbstractPluginTransportContext

m_requestURI, m_transportHandler, m_transportSessionId

Constructor Summary

Constructors

Constructor and Description
PluginTransportContext(GenericTransportHandler transportHandler) Instantiates a new PluginTransportContext.

Method Summary

Modifier and Type	Method and Description
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()
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	getRequestMethod()
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(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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginTransportContext

public PluginTransportContext(GenericTransportHandler transportHandler)

Instantiates a new PluginTransportContext.

Parameters:

transportHandler - the transport handler

Method Detail

getAttribute

public java.lang.Object getAttribute(CommonAttribute attribute)

Description copied from interface: GenericTransportContext

Gets the attribute.

Returns:

the attribute

getAttributeNames

public java.util.Iterator<CommonAttribute> getAttributeNames()

Description copied from interface: GenericTransportContext

Gets the attribute names.

Returns:

the attribute names

getAttributes

public java.util.Map<java.lang.String,java.lang.Object[]> getAttributes()

Description copied from interface: GenericTransportContext

Gets the attributes.

Returns:

the attributes

getErrorCode

public java.lang.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 java.util.Locale getLocale()

Returns:

getParameterValue

public java.lang.String getParameterValue(java.lang.String parameterName)

Description copied from interface: GenericTransportContext

Gets the parameter value.

Parameters:

parameterName - the parameter name

Returns:

the parameter value

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()

Description copied from interface: GenericTransportContext

Gets the parameters.

Returns:

the parameters

getRequestURI

public java.lang.String getRequestURI()

Description copied from interface: GenericTransportContext

Gets the request uri.

Returns:

the request uri

getSessionStore

public GenericTransportStore getSessionStore()

Returns:

getToken

public GenericTransportToken getToken(java.lang.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 java.lang.Object getTransportRequest()

Returns:

getTransportSession

public java.lang.Object getTransportSession(boolean create)

Description copied from interface: GenericTransportContext

Gets the transport session.

Returns:

the transport session

getTransportSessionID

public java.lang.String getTransportSessionID()

Description copied from interface: GenericTransportContext

Set Session ID for the tranport session.

Returns:

getUserAgent

public java.lang.String getUserAgent()

Returns:

getRequestMethod

public java.lang.String getRequestMethod()

Returns:

setAttribute

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

Description copied from interface: GenericTransportContext

Sets the attribute.

value - the value

setErrorCode

public void setErrorCode(java.lang.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(GenericTransportToken token,
                     boolean isVersioned)

Description copied from interface: GenericTransportContext

Sets the token.

Parameters:

token - the token

isVersioned - the is versioned

setTransportSessionID

public void setTransportSessionID(java.lang.String sessId)

Description copied from interface: GenericTransportContext

Sets the session ID for the transport. Http Session ID for http sessions

unsetToken

public void unsetToken(java.lang.String tokenName)

Description copied from interface: GenericTransportContext

Unset token.

Parameters:

tokenName - the token name

unsetToken

public void unsetToken(GenericTransportToken token)

Description copied from interface: GenericTransportContext

Unset token providing the token object

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters(GenericTransportContext.PARAM_TYPE type)

Description copied from interface: GenericTransportContext

Gets the parameters.

Returns:

the parameters