com.sun.identity.xacml.context.impl

Class ActionImpl

java.lang.Object

com.sun.identity.xacml.context.impl.ActionImpl

All Implemented Interfaces:

Action

public class ActionImpl
extends Object
implements Action

The Action element specifies information about the action requested in the Request context by listing a sequence of Attribute elements associated with the action.

 <xs:element name="Action" type="xacml-context:ActionType"/>
 <xs:complexType name="ActionType">
    <xs:sequence>
       <xs:element ref="xacml-context:Attribute" minOccurs="0"
       maxOccurs="unbounded"/>
    <xs:sequence>
 <xs:complexType>
 

Constructor Summary

Constructors

Constructor and Description
ActionImpl() Creates a new instance of ActionImpl
ActionImpl(Element element) This constructor is used to build Action object from a block of existing XML that has already been built into a DOM.
ActionImpl(String xml) This constructor is used to build Action object from a XML string.

Method Summary

Modifier and Type	Method and Description
List	getAttributes() Returns zero to many Attribute elements of this object If no attributes and present, empty List will be returned.
boolean	isMutable() Checks if the object is mutable
void	makeImmutable() Makes the object immutable
void	setAttributes(List attributes) Sets the Attribute elements of this object
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

ActionImpl

public ActionImpl()

Creates a new instance of ActionImpl

ActionImpl

public ActionImpl(String xml)
           throws XACMLException

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

Parameters:

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

Throws:

XACMLException - if it could not process the XML string

ActionImpl

public ActionImpl(Element element)
           throws XACMLException

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

Throws:

XACMLException - if it could not process the Element

Method Detail

getAttributes

public List getAttributes()

Description copied from interface: Action

Returns zero to many Attribute elements of this object If no attributes and present, empty List will be returned.

Specified by:

getAttributes in interface Action

Returns:

the Attribute elements of this object

setAttributes

public void setAttributes(List attributes)
                   throws XACMLException

Sets the Attribute elements of this object

Specified by:

setAttributes in interface Action

Parameters:

attributes - Attribute elements of this object attributes could be an empty List, if no attributes are present.

Throws:

XACMLException - if the object is immutable An object is considered immutable if makeImmutable() has been invoked on it. It can be determined by calling mutable on the object.

toXMLString

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

Returns a String representation of this object

Specified by:

toXMLString in interface Action

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 of this object

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 Action

Returns:

a string representation of this object

Throws:

XACMLException - if conversion fails for any reason

makeImmutable

public void makeImmutable()

Makes the object immutable

Specified by:

makeImmutable in interface Action

isMutable

public boolean isMutable()

Checks if the object is mutable

Specified by:

isMutable in interface Action

Returns:

true if the object is mutable, false otherwise