oracle.security.am.plugin

Class PluginResponse

java.lang.Object

oracle.security.am.plugin.PluginResponse

All Implemented Interfaces:

PluginAttribute

public class PluginResponse
extends java.lang.Object
implements PluginAttribute

Responses that the plugin can be set to the execution contexts. Plugins can add the responses to the plug-in response using addResponse(PluginResponse response); method and the executor will extract the responses and set that to the respective contexts. Available attribute contexts are

• PluginAttributeContextType.REQUEST to the request context.
• PluginAttributeContextType.SESSION to OAM session object
• PluginAttributeContextType.REDIRECT as redirect URL used after the process.

This class can be used to set responses to the session and set re-direct URLS absed on the authentication module processing. The responses are set to the context after the last authentication module execution so subsequent modules can overwrite the responses set by a modules.

Since:

OAM 11.1.1.2.0

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name The name.
protected static java.lang.String	NAME_TAG
protected static java.lang.String	OBJ_ID
protected PluginAttributeContextType	type The type.
protected static java.lang.String	TYPE_TAG
protected java.lang.Object	value The value.
protected static java.lang.String	VALUE_TAG

Fields inherited from interface oracle.security.am.plugin.PluginAttribute

KEY_TAG

Constructor Summary

Constructors

Constructor and Description
PluginResponse() Default Constructor
PluginResponse(java.lang.String name, java.lang.String value, PluginAttributeContextType contextType) constructor to create the plug-in response that can be set to session request etc.

Method Summary

Modifier and Type	Method and Description
void	fromString(java.lang.String token)
java.lang.String	getKeyName()
java.lang.String	getName() returns the name of the response attribute.
java.lang.String	getObjName()
PluginAttributeContextType	getType() get the attribute context type.
java.lang.Object	getValue() Get the attribute value.
void	setKeyName(java.lang.String keyName)
void	setName(java.lang.String name) sets the name of the response attribute.
void	setType(PluginAttributeContextType type) sets the attribute context type.
void	setValue(java.lang.Object value) sets the attribute value.
java.lang.String	toStringForm()

Methods inherited from class java.lang.Object

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

Field Detail

type

protected PluginAttributeContextType type

The type.

name

protected java.lang.String name

The name.

value

protected java.lang.Object value

The value.

OBJ_ID

protected static final java.lang.String OBJ_ID

See Also:

Constant Field Values

NAME_TAG

protected static java.lang.String NAME_TAG

VALUE_TAG

protected static java.lang.String VALUE_TAG

TYPE_TAG

protected static java.lang.String TYPE_TAG

Constructor Detail

PluginResponse

public PluginResponse(java.lang.String name,
                      java.lang.String value,
                      PluginAttributeContextType contextType)

constructor to create the plug-in response that can be set to session request etc.

Parameters:

name - the name

value - the value

contextType - the context type

PluginResponse

public PluginResponse()

Default Constructor

Method Detail

getName

public java.lang.String getName()

returns the name of the response attribute.

Returns:

the name

setName

public void setName(java.lang.String name)

sets the name of the response attribute.

Parameters:

name - the new name

getType

public PluginAttributeContextType getType()

get the attribute context type.

Returns:

the type

setType

public void setType(PluginAttributeContextType type)

sets the attribute context type.

Parameters:

type - the new type

getValue

public java.lang.Object getValue()

Get the attribute value.

Returns:

the value

setValue

public void setValue(java.lang.Object value)

sets the attribute value.

Parameters:

value - the new value

toStringForm

public java.lang.String toStringForm()

Specified by:

toStringForm in interface PluginAttribute

fromString

public void fromString(java.lang.String token)

Specified by:

fromString in interface PluginAttribute

getKeyName

public java.lang.String getKeyName()

Specified by:

getKeyName in interface PluginAttribute

setKeyName

public void setKeyName(java.lang.String keyName)

Specified by:

setKeyName in interface PluginAttribute

getObjName

public java.lang.String getObjName()

Specified by:

getObjName in interface PluginAttribute