oracle.security.am.plugin

Interface GenericTransportHandler

public interface GenericTransportHandler

The GenericTransportHandler class.

Since:

NGAMv1.0

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[]>	getAttributesMap() Gets the attributes map.
java.util.Locale	getLocale()
java.lang.String[]	getParameterValues(java.lang.String parameterName) Gets the parameter values.
java.util.Map<java.lang.String,java.lang.String>	getPropertiesMap() Gets the properties map.
java.util.Map<java.lang.String,java.lang.String>	getPropertiesMap(GenericTransportContext.PARAM_TYPE type) Gets the properties map.
java.lang.String	getRequestMethod() The method returns the type of method used to hit the OAM server for access.
java.lang.String	getRequestURI() Gets the request uri.
GenericTransportStore	getSessionStore() Creates a session store using the attributes stored in the session.
GenericTransportToken	getToken(java.lang.String tokenName, boolean isVersioned) Gets the token.
java.util.List<GenericTransportToken>	getTokens() Returns the list of tokens those were set using setToken().
java.lang.Object	getTransportRequest()
java.lang.Object	getTransportSession(boolean crate)
java.lang.String	getUserAgent() Returns the clients useragent information
void	setAttribute(CommonAttribute attribute, java.lang.Object value) Sets the attribute.
void	setToken(GenericTransportToken token, boolean isVersioned) Sets the token.
void	unsetToken(GenericTransportToken token) Unset token providing the token object
void	unsetToken(java.lang.String tokenName) Unset token.

Method Detail

getAttributesMap

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

Gets the attributes map.

Returns:

the attributes map

getRequestURI

java.lang.String getRequestURI()

Gets the request uri.

Returns:

the request uri

getPropertiesMap

java.util.Map<java.lang.String,java.lang.String> getPropertiesMap()

Gets the properties map.

Returns:

the properties map

getPropertiesMap

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

Gets the properties map.

Returns:

the properties map

getToken

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

Sets the token.

Parameters:

token - the transport token

isVersioned - if the token is a versioned one

getParameterValues

java.lang.String[] getParameterValues(java.lang.String parameterName)

Gets the parameter values.

Parameters:

parameterName - the parameter name

Returns:

the parameter values

setAttribute

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

Sets the attribute.

Parameters:

name - the name

value - the value

getAttribute

java.lang.Object getAttribute(CommonAttribute attribute)

Gets the attribute.

Parameters:

name - the name

Returns:

the attribute

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 -

getAttributeNames

java.util.Iterator<CommonAttribute> getAttributeNames()

Gets the attribute names.

Returns:

the attribute names

getTransportSession

java.lang.Object getTransportSession(boolean crate)

getSessionStore

GenericTransportStore getSessionStore()

Creates a session store using the attributes stored in the session.

Returns:

SessionStore object

getTransportRequest

java.lang.Object getTransportRequest()

getLocale

java.util.Locale getLocale()

getUserAgent

java.lang.String getUserAgent()

Returns the clients useragent information

Returns:

getTokens

java.util.List<GenericTransportToken> getTokens()

Returns the list of tokens those were set using setToken().

getRequestMethod

java.lang.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.