Package com.sun.identity.saml2.assertion.impl

Class AudienceRestrictionImpl

java.lang.Object

com.sun.identity.saml2.assertion.impl.ConditionAbstractImpl

com.sun.identity.saml2.assertion.impl.AudienceRestrictionImpl

All Implemented Interfaces:

AudienceRestriction, ConditionAbstract

public class AudienceRestrictionImpl
extends ConditionAbstractImpl
implements AudienceRestriction

The AudienceRestriction specifies that the assertion is addressed to one or more specific Audiences.

Field Summary

Fields

Modifier and Type	Field	Description
static String	AUDIENCE_ELEMENT
static String	AUDIENCE_RESTRICTION_ELEMENT

Constructor Summary

Constructors

Constructor	Description
AudienceRestrictionImpl()	Default constructor
AudienceRestrictionImpl(String xml)	This constructor is used to build AudienceRestriction object from a XML string.
AudienceRestrictionImpl(Element element)	This constructor is used to build AudienceRestriction object from a block of existing XML that has already been built into a DOM.

Method Summary

Modifier and Type	Method	Description
List<String>	getAudience()	Returns a list of String represented audiences
boolean	isMutable()	Returns true if the object is mutable
void	makeImmutable()	Makes the object immutable
void	setAudience(List audiences)	Sets the audiences
String	toXMLString()	Returns a String representation
String	toXMLString(boolean includeNSPrefix, boolean declareNS)	Returns a String representation

Methods inherited from class java.lang.Object

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

Field Detail

AUDIENCE_RESTRICTION_ELEMENT

public static String AUDIENCE_RESTRICTION_ELEMENT

AUDIENCE_ELEMENT

public static String AUDIENCE_ELEMENT

Constructor Detail

AudienceRestrictionImpl

public AudienceRestrictionImpl()

Default constructor

AudienceRestrictionImpl

public AudienceRestrictionImpl(String xml)
                        throws SAML2Exception

This constructor is used to build AudienceRestriction object from a XML string.

Parameters:

xml - A java.lang.String representing a AudienceRestriction object

Throws:

SAML2Exception - if it could not process the XML string

AudienceRestrictionImpl

public AudienceRestrictionImpl(Element element)
                        throws SAML2Exception

This constructor is used to build AudienceRestriction object from a block of existing XML that has already been built into a DOM.

Parameters:

element - A org.w3c.dom.Element representing DOM tree for AudienceRestriction object

Throws:

SAML2Exception - if it could not process the Element

Method Detail

getAudience

public List<String> getAudience()

Returns a list of String represented audiences

Specified by:

getAudience in interface AudienceRestriction

Returns:

a list of String represented audiences

setAudience

public void setAudience(List audiences)
                 throws SAML2Exception

Sets the audiences

Specified by:

setAudience in interface AudienceRestriction

Parameters:

audiences - List of audiences as URI strings

Throws:

SAML2Exception - if the object is immutable

toXMLString

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

Returns a String representation

Specified by:

toXMLString in interface AudienceRestriction

Specified by:

toXMLString in interface ConditionAbstract

Parameters:

includeNSPrefix - 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 representation

Throws:

SAML2Exception - if something is wrong during conversion

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation

Specified by:

toXMLString in interface AudienceRestriction

Specified by:

toXMLString in interface ConditionAbstract

Returns:

A String representation

Throws:

SAML2Exception - if something is wrong during conversion

makeImmutable

public void makeImmutable()

Makes the object immutable

Specified by:

makeImmutable in interface AudienceRestriction

Specified by:

makeImmutable in interface ConditionAbstract

Overrides:

makeImmutable in class ConditionAbstractImpl

isMutable

public boolean isMutable()

Returns true if the object is mutable

Specified by:

isMutable in interface AudienceRestriction

Specified by:

isMutable in interface ConditionAbstract

Overrides:

isMutable in class ConditionAbstractImpl

Returns:

true if the object is mutable