org.apereo.services.persondir.support

Interface IAdditionalDescriptors

All Superinterfaces:

IPersonAttributes, java.security.Principal, java.io.Serializable

All Known Implementing Classes:

AdditionalDescriptors, MediatingAdditionalDescriptors

public interface IAdditionalDescriptors
extends IPersonAttributes

Interface that describes what is essentially a mutable IPersonAttributes object

Author:

Eric Dalquist

Method Summary

Modifier and Type	Method and Description
void	addAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> attributes)
java.util.List<java.lang.Object>	removeAttribute(java.lang.String name)
void	setAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> attributes) This should be atomic to the view of other methods on this interface.
java.util.List<java.lang.Object>	setAttributeValues(java.lang.String name, java.util.List<java.lang.Object> values) Sets the specified attribute values
void	setName(java.lang.String name)

Methods inherited from interface org.apereo.services.persondir.IPersonAttributes

getAttributes, getAttributeValue, getAttributeValues

Methods inherited from interface java.security.Principal

equals, getName, hashCode, implies, toString

Method Detail

setName

void setName(java.lang.String name)

Parameters:

name - The user name for the attributes

addAttributes

void addAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> attributes)

Parameters:

attributes - Attributes to add to the existing attribute Map

setAttributes

void setAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> attributes)

This should be atomic to the view of other methods on this interface.

Parameters:

attributes - Replace all existing attributes witht he specified Map

setAttributeValues

java.util.List<java.lang.Object> setAttributeValues(java.lang.String name,
                                                    java.util.List<java.lang.Object> values)

Sets the specified attribute values

Parameters:

name - Name of the attribute, must not be null

values - Values for the attribute, may be null

Returns:

The previous values for the attribute if they existed

removeAttribute

java.util.List<java.lang.Object> removeAttribute(java.lang.String name)

Parameters:

name - Removes the specified attribute, must not be null

Returns:

The removed values for the attribute if they existed