com.sun.identity.saml2.assertion

Interface Attribute

public interface Attribute

The Attribute element identifies an attribute by name and optionally includes its value(s). It has the AttributeType complex type.

 <complexType name="AttributeType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}
         AttributeValue" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="FriendlyName"
       type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="Name" use="required"
       type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="NameFormat"
       type="{http://www.w3.org/2001/XMLSchema}anyURI" />
     </restriction>
   </complexContent>
 </complexType>
 

Method Summary

Modifier and Type	Method and Description
EncryptedAttribute	encrypt(EncryptionConfig encryptionConfig, String recipientEntityID) Returns an EncryptedAttribute object.
Map	getAnyAttribute() Returns the anyAttribute of the attribute.
List	getAttributeValue() Returns the AttributeValue(s) of the Attribute.
List<String>	getAttributeValueString() Returns the AttributeValue(s) of the Attribute.
String	getFriendlyName() Returns the FriendlyName of the attribute.
String	getName() Returns the Name of the attribute.
String	getNameFormat() Returns the NameFormat of the attribute.
boolean	isMutable() Returns the mutability of the object.
void	makeImmutable() Makes the object immutable.
void	setAnyAttribute(Map value) Sets the anyAttribute of the attribute.
void	setAttributeValue(List value) Sets the AttributeValue(s) of the Attribute.
void	setAttributeValueString(List value) Sets the value of AttributeValue element(s).
void	setFriendlyName(String value) Sets the FriendlyName of the attribute.
void	setName(String value) Sets the Name of the attribute.
void	setNameFormat(String value) Sets the NameFormat of the attribute.
String	toXMLString() Returns a String representation of the element.
String	toXMLString(boolean includeNS, boolean declareNS) Returns a String representation of the element.

Method Detail

makeImmutable

void makeImmutable()

Makes the object immutable.

isMutable

boolean isMutable()

Returns the mutability of the object.

Returns:

true if the object is mutable; false otherwise.

getAttributeValue

List getAttributeValue()

Returns the AttributeValue(s) of the Attribute.

Returns:

List of xml String representing AttributeValue(s) of the Attribute.

See Also:

Attribute.setAttributeValue(List)

setAttributeValue

void setAttributeValue(List value)
                throws SAML2Exception

Sets the AttributeValue(s) of the Attribute.

Parameters:

value - List of xml String representing the new AttributeValue element(s).

Throws:

SAML2Exception - if the object is immutable.

See Also:

Attribute.getAttributeValue()

getAttributeValueString

List<String> getAttributeValueString()

Returns the AttributeValue(s) of the Attribute.

Returns:

List of String representing the value of AttributeValue(s).

See Also:

Attribute.setAttributeValueString(List)

setAttributeValueString

void setAttributeValueString(List value)
                      throws SAML2Exception

Sets the value of AttributeValue element(s).

Parameters:

value - List of String representing the value of the new AttributeValue element(s).

Throws:

SAML2Exception - if the object is immutable.

See Also:

Attribute.getAttributeValueString()

getName

String getName()

Returns the Name of the attribute.

Returns:

the Name of the attribute.

See Also:

Attribute.setName(String)

setName

void setName(String value)
      throws SAML2Exception

Sets the Name of the attribute.

Parameters:

value - new Name of the attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

Attribute.getName()

getNameFormat

String getNameFormat()

Returns the NameFormat of the attribute.

Returns:

the value of NameFormat.

See Also:

Attribute.setNameFormat(String)

setNameFormat

void setNameFormat(String value)
            throws SAML2Exception

Sets the NameFormat of the attribute.

Parameters:

value - new NameFormat of the attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

Attribute.getNameFormat()

getFriendlyName

String getFriendlyName()

Returns the FriendlyName of the attribute.

Returns:

the value of FriendlyName of the attribute.

See Also:

Attribute.setFriendlyName(String)

setFriendlyName

void setFriendlyName(String value)
              throws SAML2Exception

Sets the FriendlyName of the attribute.

Parameters:

value - new FriendlyName of the attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

Attribute.getFriendlyName()

getAnyAttribute

Map getAnyAttribute()

Returns the anyAttribute of the attribute.

Returns:

A Map containing name/value pairs of anyAttribute. Both the name and value are String object types.

See Also:

Attribute.setAnyAttribute(Map)

setAnyAttribute

void setAnyAttribute(Map value)
              throws SAML2Exception

Sets the anyAttribute of the attribute.

Parameters:

value - Map of name/value pairs to be set. Both the name and value are String object types.

Throws:

SAML2Exception - if the object is immutable.

See Also:

Attribute.getAnyAttribute()

encrypt

EncryptedAttribute encrypt(EncryptionConfig encryptionConfig,
                           String recipientEntityID)
                    throws SAML2Exception

Returns an EncryptedAttribute object.

Parameters:

encryptionConfig - The encryption config.

recipientEntityID - Unique identifier of the recipient, it is used as the index to the cached secret key so that the key can be reused for the same recipient; It can be null in which case the secret key will be generated every time and will not be cached and reused. Note that the generation of a secret key is a relatively expensive operation.

Returns:

EncryptedAttribute object

Throws:

SAML2Exception - if error occurs during the encryption process.

toXMLString

String toXMLString()
            throws SAML2Exception

Returns a String representation of the element.

Returns:

A string containing the valid XML for this element. By default name space name is prepended to the element name.

Throws:

SAML2Exception - if the object does not conform to the schema.

toXMLString

String toXMLString(boolean includeNS,
                   boolean declareNS)
            throws SAML2Exception

Returns a String representation of the element.

Parameters:

includeNS - Determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - Determines whether or not the namespace is declared within the Element.

Returns:

A string containing the valid XML for this element

Throws:

SAML2Exception - if the object does not conform to the schema.