org.forgerock.openam.scripting.api

Class ScriptedIdentity

java.lang.Object

org.forgerock.openam.scripting.api.ScriptedIdentity

public class ScriptedIdentity
extends Object

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

Constructor Summary

Constructors

Constructor and Description
ScriptedIdentity(AMIdentity amIdentity) The constructor for the ScriptedIdentity object

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String attributeName, String attributeValue)
Set	getAttribute(String attributeName) Retrieves a particular attribute's value
void	setAttribute(String attributeName, Object[] attributeValues) Sets the attribute's values.
void	store() Persists the current state of the user's attributes

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptedIdentity

public ScriptedIdentity(AMIdentity amIdentity)

The constructor for the ScriptedIdentity object

Parameters:

amIdentity - The amIdentity object containing the user information

Method Detail

getAttribute

public Set getAttribute(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

public void setAttribute(String attributeName,
                         Object[] 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

public void addAttribute(String attributeName,
                         String attributeValue)

store

public void store()

Persists the current state of the user's attributes