Package org.forgerock.am.identity.application

Interface IdentityService.IdentityAttributeUpdater

Enclosing interface:

IdentityService

public static interface IdentityService.IdentityAttributeUpdater

A builder which allows several changes to the attributes to be combined into a single update operation per attribute type. Several of these may exist at once, and an individual updater can have store called multiple times.

Method Summary

Modifier and Type	Method	Description
IdentityService.IdentityAttributeUpdater	removeAttributes(Set<String> attrNames)	Removes the attributes from the identity entry.
IdentityService.IdentityAttributeUpdater	setAttributes(Map attrMap)	Sets the values of attributes.
IdentityService.IdentityAttributeUpdater	setBinaryAttributes(Map attrMap)	Set the values of binary attributes.
void	store()	Stores the attributes of the object.

Method Detail

setAttributes

IdentityService.IdentityAttributeUpdater setAttributes(Map attrMap)
                                                throws IdRepoException,
                                                       SSOException

Sets the values of attributes. This method should be followed by the method "store" to commit the changes to the Repository. This method is only valid for Identity objects of type User and Agent.

Parameters:

attrMap - is a map of attribute name (String) to a Set of attribute values (String). It is arranged as: Map::attrMap --> Key: String::AttributeName Value: Set::AttributeValues (Set of String)

Throws:

IdRepoException - If there are repository related error conditions

SSOException - If user's single sign on token is invalid

setBinaryAttributes

IdentityService.IdentityAttributeUpdater setBinaryAttributes(Map attrMap)
                                                      throws IdRepoException,
                                                             SSOException

Set the values of binary attributes. This method should be followed by the method "store" to commit the changes to the Repository

This method is only valid for Identity objects of type User and Agent.

Parameters:

attrMap - Map of attribute-values to be set in the repository or repositories (if multiple plugins are configured for "edit")

Throws:

IdRepoException - If there are repository related error conditions

SSOException - If user's single sign on token is invalid

removeAttributes

IdentityService.IdentityAttributeUpdater removeAttributes(Set<String> attrNames)
                                                   throws IdRepoException,
                                                          SSOException

Removes the attributes from the identity entry. This method should be followed by a "store" to commit the changes to the Repository.

This method is only valid for Identity objects of type User and Agent.

Parameters:

attrNames - Set of attribute names to be removed

Throws:

IdRepoException - If there are repository related error conditions

SSOException - If the user's single sign on token is invalid

store

void store()
    throws IdRepoException,
           SSOException

Stores the attributes of the object.

This method is only valid for Identity objects of type User and Agent.

Throws:

IdRepoException - If there are repository related error conditions

SSOException - If user's single sign on token is invalid