com.sun.identity.xacml.policy.impl

Class ObligationsImpl

java.lang.Object

com.sun.identity.xacml.policy.impl.ObligationsImpl

All Implemented Interfaces:

Obligations

public class ObligationsImpl
extends Object
implements Obligations

The Obligations element is a container of one or more Obligations issuded by authorization authority.

Constructor Summary

Constructors

Constructor and Description
ObligationsImpl() Default constructor
ObligationsImpl(Element element) Constructs an ObligationsImpl object from an XML DOM element
ObligationsImpl(String xml) Constructs an ObligationsImpl object from an XML string

Method Summary

Modifier and Type	Method and Description
void	addObligation(Obligation obligation) Adds an Obligation to this object.
List	getObligations() Returns the Obligation objects set in this Obligations
boolean	isMutable() Checks if this object is mutable
void	makeImmutable() Makes this object immutable
void	setObligations(List obligations) Sets the Obligation objects of this Obligations
String	toXMLString() Returns a string representation of this object
String	toXMLString(boolean includeNSPrefix, boolean declareNS) Returns a string representation of this object

Methods inherited from class java.lang.Object

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

Constructor Detail

ObligationsImpl

public ObligationsImpl()

Default constructor

ObligationsImpl

public ObligationsImpl(String xml)
                throws XACMLException

Constructs an ObligationsImpl object from an XML string

Parameters:

xml - string representing an ObligationsImpl object

Throws:

XACMLException - if the XML string could not be processed

ObligationsImpl

public ObligationsImpl(Element element)
                throws XACMLException

Constructs an ObligationsImpl object from an XML DOM element

Parameters:

element - XML DOM element representing a ObligationsImpl object.

Throws:

XACMLException - If the DOM element could not be processed.

Method Detail

getObligations

public List getObligations()

Returns the Obligation objects set in this Obligations

Specified by:

getObligations in interface Obligations

Returns:

the Obligation objects set in this Obligations

setObligations

public void setObligations(List obligations)
                    throws XACMLException

Sets the Obligation objects of this Obligations

Specified by:

setObligations in interface Obligations

Parameters:

obligations - the Obligation objects to set in this Obligations

Throws:

XACMLException - if the object is immutable.

addObligation

public void addObligation(Obligation obligation)
                   throws XACMLException

Adds an Obligation to this object.

Specified by:

addObligation in interface Obligations

Parameters:

obligation - the Obligation to add.

Throws:

XACMLException - if the object is immutable.

toXMLString

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

Returns a string representation of this object

Specified by:

toXMLString in interface Obligations

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:

XACMLException - if conversion fails for any reason

toXMLString

public String toXMLString()
                   throws XACMLException

Returns a string representation of this object

Specified by:

toXMLString in interface Obligations

Returns:

a string representation

Throws:

XACMLException - if conversion fails for any reason

makeImmutable

public void makeImmutable()

Makes this object immutable

Specified by:

makeImmutable in interface Obligations

isMutable

public boolean isMutable()

Checks if this object is mutable

Specified by:

isMutable in interface Obligations

Returns:

true if the object is mutable, false otherwise