Package org.forgerock.openam.scripting.api.identity

Class ScriptedIdentity

java.lang.Object

org.forgerock.openam.scripting.api.identity.ScriptedIdentity

@Supported
public class ScriptedIdentity
extends Object

A wrapper class to limit an authentication script's exposure to a AmIdentity object

Method Summary

Modifier and Type	Method	Description
void	addAttribute(String attributeName, String attributeValue)	Adds a new attribute value to the existing set for the named attribute.
String[]	getAttributeValues(String attributeName)	Retrieves a particular attribute's value
void	setAttribute(String attributeName, String[] attributeValues)	Sets the attribute's values.

Methods inherited from class java.lang.Object

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

Method Details

getAttributeValues

@Supported
public String[] getAttributeValues(String attributeName)

Retrieves a particular attribute's value

Parameters:

attributeName - The name of the attribute to be retrieved

Returns:

The value of the attribute

setAttribute

@Supported
public void setAttribute(String attributeName,
 String[] attributeValues)

Sets the attribute's values. If the attribute already exists all existing values will be overridden. If it doesn't exist, it will be created.

Parameters:

attributeName - The name of the attribute

attributeValues - The values of the attribute

addAttribute

@Supported
public void addAttribute(String attributeName,
 String attributeValue)

Adds a new attribute value to the existing set for the named attribute. If the identity does not have any existing values, this sets the attribute to have the single value provided.

Parameters:

attributeName - The name of the attribute

attributeValue - The value of the attribute to add