com.bea.security.saml2.providers
Class SAML2AttributeInfo

java.lang.Object
  com.bea.security.saml2.providers.SAML2AttributeInfo

public class SAML2AttributeInfo
extends Object

This class represents a single Attribute of an AttributeStatement in a SAML 2.0 assertion.

ATTR_NAME_FORMAT_BASIC

public static final String ATTR_NAME_FORMAT_BASIC

URN for the basic attribute name format.

See Also:

Constant Field Values

SAML2AttributeInfo

public SAML2AttributeInfo()

Constructs an instance that represents a SAML2 Attribute with default fields.

SAML2AttributeInfo

public SAML2AttributeInfo(String attributeName,
                          Collection<String> attributeValues)

Constructs an instance that represents a SAML2 Attribute with specifiec information.

Parameters:

attributeName - the name of the attribute

attributeValues - a collection of attribute values

SAML2AttributeInfo

public SAML2AttributeInfo(String attributeName,
                          String attributeValue)

Constructs an instance that represents a SAML2 Attribute with specified information.

Parameters:

attributeName - the name of the attribute

attributeValue - a single attribute value

SAML2AttributeInfo

public SAML2AttributeInfo(String attributeName,
                          String attributeNameFormat,
                          String attributeFriendlyName,
                          Collection<String> attributeValues)

Constructs an instance that represents a SAML2 Attribute with specified information.

Parameters:

attributeName - the name of the attribute

attributeNameFormat - the name format of the attribute

attributeFriendlyName - the friendly name of the attribute

attributeValues - a collection of attribute values

getAttributeName

public String getAttributeName()

Gets the name of the attribute.

Returns:

the name of the attribute

setAttributeName

public void setAttributeName(String attributeName)

Sets the name of the attribute.

Parameters:

attributeName - the name of the attribute

getAttributeNameFormat

public String getAttributeNameFormat()

Gets the name format of the attribute. Defaults to SAML2AttributeInfo.ATTR_NAME_FORMAT_BASIC if not specified.

Returns:

the name format of the attribute

setAttributeNameFormat

public void setAttributeNameFormat(String attributeNameFormat)

Sets the name format of the attribute.

Parameters:

attributeNameFormat - the name format of the attribute

getAttributeFriendlyName

public String getAttributeFriendlyName()

Gets the friendly name of the attribute.

Returns:

the friendly name of the attribute

setAttributeFriendlyName

public void setAttributeFriendlyName(String attributeFriendlyName)

Sets the friendly name of the attribute.

Parameters:

attributeFriendlyName - the friendly name of the attribute

addAttributeValue

public void addAttributeValue(String attributeValue)

Adds a single String value to the end of this instance's collection of values.

Parameters:

attributeValue - the attribute value to be added

addAttributeValues

public void addAttributeValues(Collection<String> attributeValues)

Adds a collection of Strings representing the attribute's values.

Parameters:

attributeValues - the attribute's values

getAttributeValues

public Collection<String> getAttributeValues()

Returns a collection of Strings representing the attribute's values, in the order they were added.

Returns:

the attribute's values, null if this attribute has no values

toString

public String toString()

Overrides:

toString in class Object