GenericTransportHandler (Oracle Access Manager Extensibility Java API Reference)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle Access Manager Extensibility Java API Reference
11g Release 1 (11.1.1.5)
E22473-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.security.am.plugin
Interface GenericTransportHandler

public interface GenericTransportHandler

The GenericTransportHandler Transport handler defines the interface for transport specific properties.

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[]>`	`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.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.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(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

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

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: