Skip navigation links

oracle.security.am.plugin.impl
Class UserContextData

java.lang.Object
oracle.security.am.plugin.impl.UserContextData

All Implemented Interfaces:

ContextData

public class UserContextData

extends java.lang.Object

implements ContextData

The UserContextData specifies the meta data: name, display name and type of parameter that needs to be collected by the login page. For example when we want to collect user name from the login application - where name of the attribute is "form_username"
final UserContextData userNameContext = new UserContextData("form_username", "form_username",
new CredentialMetaData(PluginConstants.TEXT));
The UserContextData can be used to specify the login page URL that the user needs to go to in order to collect credentials. CredentialMetaData of type URL specifies the login page URL.
For example: final UserContextData urlContext = new UserContextData(loginPageURL, new CredentialMetaData("URL"));

The UserContextData can be used to also pass query parameters to the login page URL.
CredentialMetaData of type QUERY_STRING specifies the query parameters that need to be sent with the loginPageURL.
This can be used/processed by the login page. Any kind of information can be passed as query parameters.
For example: String queryString = "queryParam1=testParameter";
final UserContextData queryStringContext =new UserContextData(queryString, new CredentialMetaData("QUERY_STRING"));

Since:

OAM 11.1.1.5.2

Version:

OAM 11.1.2.0.0

Constructor Summary

UserContextData()
Default constructor

UserContextData(java.lang.String name, CredentialMetaData credentialMetaData)
Constructor

UserContextData(java.lang.String name, java.lang.String displayName, CredentialMetaData credentialMetaData)
Constructor

UserContextData(java.lang.String name, java.lang.String displayName, CredentialMetaData credentialMetaData, int displayOrder)
Constructor

UserContextData(java.lang.String name, java.lang.String displayName, java.lang.String value, CredentialMetaData credentialMetaData)
Constructor

Method Summary

ContextMetaData	getContextMetaData() returns meta data associated to the context data object.
java.lang.String	getDisplayName() return display name.
java.lang.String	getName()
int	getOrder()
java.lang.String	getValue() return the data value.
void	setContextMetaData(ContextMetaData contextMetaData) sets the meta data for the data.
void	setDisplayName(java.lang.String displayName)
void	setName(java.lang.String name)
void	setOrder(int order)
void	setValue(java.lang.String value) sets a value to the data.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserContextData

public UserContextData()

Default constructor

UserContextData

public UserContextData(java.lang.String name,
                       CredentialMetaData credentialMetaData)

Constructor

Parameters:

name -

credentialMetaData -

UserContextData

public UserContextData(java.lang.String name,
                       java.lang.String displayName,
                       java.lang.String value,
                       CredentialMetaData credentialMetaData)

Constructor

Parameters:

name -

displayName -

value -

credentialMetaData -

UserContextData

public UserContextData(java.lang.String name,
                       java.lang.String displayName,
                       CredentialMetaData credentialMetaData)

Constructor

Parameters:

name -

displayName -

credentialMetaData -

UserContextData

public UserContextData(java.lang.String name,
                       java.lang.String displayName,
                       CredentialMetaData credentialMetaData,
                       int displayOrder)

Constructor

Parameters:

name -

displayName -

credentialMetaData -

displayOrder - define the order in which the parameters needs to be displayed in UI.

Method Detail

getContextMetaData

public ContextMetaData getContextMetaData()

Description copied from interface: ContextData

returns meta data associated to the context data object.

Specified by:

getContextMetaData in interface ContextData

Returns:

a ContextMetaData object.

setContextMetaData

public void setContextMetaData(ContextMetaData contextMetaData)

Description copied from interface: ContextData

sets the meta data for the data.

Specified by:

setContextMetaData in interface ContextData

getName

public java.lang.String getName()

Specified by:

getName in interface ContextData

Returns:

String value.

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: ContextData

return display name.

Specified by:

getDisplayName in interface ContextData

Returns:

a String value.

setName

public void setName(java.lang.String name)

setDisplayName

public void setDisplayName(java.lang.String displayName)

getValue

public java.lang.String getValue()

Description copied from interface: ContextData

return the data value.

Specified by:

getValue in interface ContextData

Returns:

a String value.

setValue

public void setValue(java.lang.String value)

Description copied from interface: ContextData

sets a value to the data.

Specified by:

setValue in interface ContextData

setOrder

public void setOrder(int order)

getOrder

public int getOrder()

Specified by:

getOrder in interface ContextData

Skip navigation links