com.sun.identity.saml2.assertion.impl

Class ProxyRestrictionImpl

java.lang.Object

com.sun.identity.saml2.assertion.impl.ProxyRestrictionImpl

All Implemented Interfaces:

ConditionAbstract, ProxyRestriction

public class ProxyRestrictionImpl
extends Object
implements ProxyRestriction

The ProxyRestriction specifies limitations that the asserting party imposes on relying parties that in turn wish to act as asserting parties and issue subsequent assertions of their own on the basis of the information contained in the original assertion. A relying party acting as an asserting party must not issue an assertion that itself violates the restrictions specified in this condition on the basis of an assertion containing such a condition.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUDIENCE_ELEMENT
static String	COUNT_ATTR
static String	PROXY_RESTRICTION_ELEMENT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List	getAudience() Returns the list of audiences to whom the asserting party permits new assertions to be issued on the basis of this assertion.
int	getCount() Returns the maximum number of indirections that the asserting party permits to exist between this assertion and an assertion which has ultimately been issued on the basis of it.
boolean	isMutable() Returns true if the object is mutable
void	makeImmutable() Makes the object immutable
void	setAudience(List audiences) Sets the list of audiences to whom the asserting party permits new assertions to be issued on the basis of this assertion.
void	setCount(int value) Sets the maximum number of indirections that the asserting party permits to exist between this assertion and an assertion which has ultimately been issued on the basis of it.
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

PROXY_RESTRICTION_ELEMENT

public static final String PROXY_RESTRICTION_ELEMENT

See Also:

Constant Field Values

COUNT_ATTR

public static final String COUNT_ATTR

See Also:

Constant Field Values

AUDIENCE_ELEMENT

public static final String AUDIENCE_ELEMENT

See Also:

Constant Field Values

Constructor Detail

ProxyRestrictionImpl

public ProxyRestrictionImpl()

Default constructor

ProxyRestrictionImpl

public ProxyRestrictionImpl(String xml)
                     throws SAML2Exception

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

Parameters:

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

Throws:

SAML2Exception - if it could not process the XML string

ProxyRestrictionImpl

public ProxyRestrictionImpl(Element element)
                     throws SAML2Exception

This constructor is used to build ProxyRestriction 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 ProxyRestriction object

Throws:

SAML2Exception - if it could not process the Element

Method Detail

getCount

public int getCount()

Returns the maximum number of indirections that the asserting party permits to exist between this assertion and an assertion which has ultimately been issued on the basis of it.

Specified by:

getCount in interface ProxyRestriction

Returns:

the count number

setCount

public void setCount(int value)
              throws SAML2Exception

Sets the maximum number of indirections that the asserting party permits to exist between this assertion and an assertion which has ultimately been issued on the basis of it.

Specified by:

setCount in interface ProxyRestriction

Parameters:

value - the count number

Throws:

SAML2Exception - if the object is immutable

getAudience

public List getAudience()

Returns the list of audiences to whom the asserting party permits new assertions to be issued on the basis of this assertion.

Specified by:

getAudience in interface ProxyRestriction

Returns:

a list of String represented audiences

setAudience

public void setAudience(List audiences)
                 throws SAML2Exception

Sets the list of audiences to whom the asserting party permits new assertions to be issued on the basis of this assertion.

Specified by:

setAudience in interface ProxyRestriction

Parameters:

audiences - a list of String represented audiences

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 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 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 ConditionAbstract

isMutable

public boolean isMutable()

Returns true if the object is mutable

Specified by:

isMutable in interface ConditionAbstract

Returns:

true if the object is mutable