org.apereo.services.persondir.support

Class AdditionalDescriptors

java.lang.Object

org.apereo.services.persondir.support.AdditionalDescriptors

All Implemented Interfaces:

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

public class AdditionalDescriptors
extends java.lang.Object
implements IAdditionalDescriptors

Implementation of IPersonAttributes for use with AdditionalDescriptorsPersonAttributeDao. Unlike most other implementations, AdditionalDescriptors is mutable. An instance of this class typically lives for the duration of a session or application, and external components are expected to add attributes to the collection after creation.

Author:

awills

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdditionalDescriptors()

Method Summary

Modifier and Type	Method and Description
void	addAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> attributes)
boolean	equals(java.lang.Object object)
java.util.Map<java.lang.String,java.util.List<java.lang.Object>>	getAttributes()
java.lang.Object	getAttributeValue(java.lang.String name)
java.util.List<java.lang.Object>	getAttributeValues(java.lang.String name)
java.lang.String	getName()
int	hashCode()
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)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.security.Principal

implies

Constructor Detail

AdditionalDescriptors

public AdditionalDescriptors()

Method Detail

getAttributeValue

public java.lang.Object getAttributeValue(java.lang.String name)

Specified by:

getAttributeValue in interface IPersonAttributes

getAttributeValues

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

Specified by:

getAttributeValues in interface IPersonAttributes

getAttributes

public java.util.Map<java.lang.String,java.util.List<java.lang.Object>> getAttributes()

Specified by:

getAttributes in interface IPersonAttributes

getName

public java.lang.String getName()

Specified by:

getName in interface java.security.Principal

setName

public void setName(java.lang.String name)

Specified by:

setName in interface IAdditionalDescriptors

Parameters:

name - The user name for the attributes

addAttributes

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

Specified by:

addAttributes in interface IAdditionalDescriptors

Parameters:

attributes - Attributes to add to the existing attribute Map

setAttributes

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

Description copied from interface: IAdditionalDescriptors

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

Specified by:

setAttributes in interface IAdditionalDescriptors

Parameters:

attributes - Replace all existing attributes witht he specified Map

setAttributeValues

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

Description copied from interface: IAdditionalDescriptors

Sets the specified attribute values

Specified by:

setAttributeValues in interface IAdditionalDescriptors

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

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

Specified by:

removeAttribute in interface IAdditionalDescriptors

Parameters:

name - Removes the specified attribute, must not be null

Returns:

The removed values for the attribute if they existed

equals

public boolean equals(java.lang.Object object)

Specified by:

equals in interface java.security.Principal

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Specified by:

hashCode in interface java.security.Principal

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

toString

public java.lang.String toString()

Specified by:

toString in interface java.security.Principal

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()