net.shibboleth.idp.attribute

Class IdPAttribute

java.lang.Object

net.shibboleth.idp.attribute.IdPAttribute

All Implemented Interfaces:

Cloneable, Comparable<IdPAttribute>

Direct Known Subclasses:

IdPRequestedAttribute

@NotThreadSafe
public class IdPAttribute
extends Object
implements Comparable<IdPAttribute>, Cloneable

Each attribute represents one piece of information about a user and has associated encoders used to turn that information in to protocol-specific formats. Instances of IdPAttribute are compared using their IDs. That is, two attributes are considered the same if they have the same ID, regardless of whether their display names, descriptions, values, or encoders are the same.

Field Summary

Fields

Modifier and Type	Field and Description
private static com.google.common.base.Function<IdPAttributeValue<?>,IdPAttributeValue<?>>	convertNullValues helper Function to convert null to EmptyAttributeValue.
private Map<Locale,String>	displayDescriptions Localized human readable descriptions of attribute.
private Map<Locale,String>	displayNames Localized human intelligible attribute names.
private Set<AttributeEncoder<?>>	encoders Encoders that may be used to encode this attribute.
private String	id ID of this attribute.
private List<IdPAttributeValue<?>>	values Values for this attribute.

Constructor Summary

Constructors

Constructor and Description
IdPAttribute(String attributeId) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
private Map<Locale,String>	checkedNamesFrom(Map<Locale,String> inputMap) Process input to setDisplayNames(Map) and {setDisplayDescriptions(Map) to strip out null input, null keys, and null values.
IdPAttribute	clone() Clones an attribute.
int	compareTo(IdPAttribute other)
boolean	equals(Object obj)
Map<Locale,String>	getDisplayDescriptions() Gets the localized human readable description of attribute.
Map<Locale,String>	getDisplayNames() Gets the localized human readable name of the attribute.
Set<AttributeEncoder<?>>	getEncoders() Gets the list of attribute encoders usable with this attribute.
String	getId() Gets the unique ID of the attribute.
List<IdPAttributeValue<?>>	getValues() Get the unmodifiable ordered collection of values of the attribute.
int	hashCode()
void	setDisplayDescriptions(Map<Locale,String> newDescriptions) Replaces the existing display descriptions for this attribute with the given ones.
void	setDisplayNames(Map<Locale,String> newNames) Replaces the existing display names for this attribute with the given ones.
void	setEncoders(Collection<AttributeEncoder<?>> newEncoders) Replaces the existing encoders for this attribute with the given encoders.
void	setValues(Collection<? extends IdPAttributeValue<?>> newValues) Replaces the existing values for this attribute with the given values.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

convertNullValues

private static com.google.common.base.Function<IdPAttributeValue<?>,IdPAttributeValue<?>> convertNullValues

helper Function to convert null to EmptyAttributeValue.

id

@Nonnull
private final String id

ID of this attribute.

displayNames

@Nonnull
private Map<Locale,String> displayNames

Localized human intelligible attribute names.

displayDescriptions

@Nonnull
private Map<Locale,String> displayDescriptions

Localized human readable descriptions of attribute.

values

@Nonnull
private List<IdPAttributeValue<?>> values

Values for this attribute.

encoders

@Nonnull
private Set<AttributeEncoder<?>> encoders

Encoders that may be used to encode this attribute.

Constructor Detail

IdPAttribute

public IdPAttribute(@Nonnull@NotEmpty@ParameterName(name="attributeId")
            String attributeId)

Constructor.

Parameters:

attributeId - unique identifier of the attribute

Method Detail

getId

@Nonnull
@NotEmpty
public String getId()

Gets the unique ID of the attribute. This ID need not be related to any protocol-specific attribute identifiers.

Returns:

unique ID of the attribute

getDisplayNames

@Nonnull
@NonnullElements
@Unmodifiable
public Map<Locale,String> getDisplayNames()

Gets the localized human readable name of the attribute.

Returns:

human readable name of the attribute

checkedNamesFrom

@Nonnull
@NonnullElements
@Unmodifiable
private Map<Locale,String> checkedNamesFrom(@Nullable@NullableElements
                                                                       Map<Locale,String> inputMap)

Process input to setDisplayNames(Map) and {setDisplayDescriptions(Map) to strip out null input, null keys, and null values.

Parameters:

inputMap - the input map.

Returns:

the unmodifiable, non null-containing output.

setDisplayNames

public void setDisplayNames(@Nullable@NullableElements
                   Map<Locale,String> newNames)

Replaces the existing display names for this attribute with the given ones.

Parameters:

newNames - the new names for this attribute

getDisplayDescriptions

@Nonnull
@NonnullElements
@Unmodifiable
public Map<Locale,String> getDisplayDescriptions()

Gets the localized human readable description of attribute.

Returns:

human readable description of attribute

setDisplayDescriptions

public void setDisplayDescriptions(@Nullable@NullableElements
                          Map<Locale,String> newDescriptions)

Replaces the existing display descriptions for this attribute with the given ones.

Parameters:

newDescriptions - the new descriptions for this attribute

getValues

@Nonnull
@NonnullElements
@Unmodifiable
@NotLive
public List<IdPAttributeValue<?>> getValues()

Get the unmodifiable ordered collection of values of the attribute.

Returns:

values of the attribute

setValues

public void setValues(@Nullable@NullableElements
             Collection<? extends IdPAttributeValue<?>> newValues)

Replaces the existing values for this attribute with the given values.

Parameters:

newValues - the new values for this attribute

getEncoders

@Nonnull
@NonnullElements
@Unmodifiable
@NotLive
public Set<AttributeEncoder<?>> getEncoders()

Gets the list of attribute encoders usable with this attribute.

Returns:

attribute encoders usable with this attribute

setEncoders

public void setEncoders(@Nullable@NullableElements
               Collection<AttributeEncoder<?>> newEncoders)

Replaces the existing encoders for this attribute with the given encoders.

Parameters:

newEncoders - the new encoders for this attribute

compareTo

public int compareTo(IdPAttribute other)

Specified by:

compareTo in interface Comparable<IdPAttribute>

clone

@Nonnull
public IdPAttribute clone()
                   throws CloneNotSupportedException

Clones an attribute. The clone will contains defensive copies of this objects display descriptions and names, encoders, and values. The elements of each collection, however, are not themselves cloned.

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object