com.sun.identity.saml2.assertion.impl

Class AttributeStatementImpl

java.lang.Object

com.sun.identity.saml2.assertion.impl.AttributeStatementImpl

All Implemented Interfaces:

AttributeStatement, Statement

public class AttributeStatementImpl
extends Object
implements AttributeStatement

This is a default implementation of AttributeStatement. The AttributeStatement element describes a statement by the SAML authority asserting that the assertion subject is associated with the specified attributes. It is of type AttributeStatementType.

 <complexType name="AttributeStatementType">
   <complexContent>
     <extension base="{urn:oasis:names:tc:SAML:2.0:assertion}
       StatementAbstractType">
       <choice maxOccurs="unbounded">
         <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}Attribute"/>
         <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}
         EncryptedAttribute"/>
       </choice>
     </extension>
   </complexContent>
 </complexType>
 

Constructor Summary

Constructors

Constructor and Description
AttributeStatementImpl() Class constructor.
AttributeStatementImpl(Element element) Class constructor with AttributeStatement in Element format.
AttributeStatementImpl(String xmlString) Class constructor with AttributeStatement in xml string format.

Method Summary

Modifier and Type	Method and Description
List<Attribute>	getAttribute() Returns Attribute(s) of the statement.
List<EncryptedAttribute>	getEncryptedAttribute() Returns EncryptedAttribute(s) of the statement.
boolean	isMutable() Returns the mutability of the object.
void	makeImmutable() Makes the object immutable.
void	setAttribute(List<Attribute> value) Sets Attribute(s) of the statement.
void	setEncryptedAttribute(List value) Sets EncryptedAttribute(s) of the statement.
String	toXMLString() Returns a String representation of the element.
String	toXMLString(boolean includeNS, boolean declareNS) Returns a String representation of the element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttributeStatementImpl

public AttributeStatementImpl()

Class constructor. Caller may need to call setters to populate the object.

AttributeStatementImpl

public AttributeStatementImpl(Element element)
                       throws SAML2Exception

Class constructor with AttributeStatement in Element format.

Throws:

SAML2Exception

AttributeStatementImpl

public AttributeStatementImpl(String xmlString)
                       throws SAML2Exception

Class constructor with AttributeStatement in xml string format.

Throws:

SAML2Exception

Method Detail

getAttribute

public List<Attribute> getAttribute()

Returns Attribute(s) of the statement.

Specified by:

getAttribute in interface AttributeStatement

Returns:

List of Attribute(s) in the statement.

See Also:

setAttribute(List)

setAttribute

public void setAttribute(List<Attribute> value)
                  throws SAML2Exception

Sets Attribute(s) of the statement.

Specified by:

setAttribute in interface AttributeStatement

Parameters:

value - List of new Attribute(s).

Throws:

SAML2Exception - if the object is immutable.

See Also:

getAttribute()

getEncryptedAttribute

public List<EncryptedAttribute> getEncryptedAttribute()

Returns EncryptedAttribute(s) of the statement.

Specified by:

getEncryptedAttribute in interface AttributeStatement

Returns:

List of EncryptedAttribute(s) in the statement.

See Also:

setEncryptedAttribute(List)

setEncryptedAttribute

public void setEncryptedAttribute(List value)
                           throws SAML2Exception

Sets EncryptedAttribute(s) of the statement.

Specified by:

setEncryptedAttribute in interface AttributeStatement

Parameters:

value - List of new EncryptedAttribute(s).

Throws:

SAML2Exception - if the object is immutable.

See Also:

getEncryptedAttribute()

makeImmutable

public void makeImmutable()

Makes the object immutable.

Specified by:

makeImmutable in interface Statement

isMutable

public boolean isMutable()

Returns the mutability of the object.

Specified by:

isMutable in interface Statement

Returns:

true if the object is mutable; false otherwise.

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation of the element.

Specified by:

toXMLString in interface Statement

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

public String toXMLString(boolean includeNS,
                          boolean declareNS)
                   throws SAML2Exception

Returns a String representation of the element.

Specified by:

toXMLString in interface Statement

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.