Package com.sun.identity.xacml.context

Interface Environment

All Known Implementing Classes:

EnvironmentImpl

public interface Environment

The Environment element contains information about the enviroment of the Request context by listing a sequence of Attribute elements associated with the environment. These are the environment attributes which are NOT associated with any of Subject, Resource or Action of the request.

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

Method Summary

Modifier and Type	Method	Description
List	getAttributes()	Returns zero to many Attribute elements of this object.
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

Method Detail

getAttributes

List getAttributes()

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

Returns:

the Attribute elements of this object

setAttributes

void setAttributes(List attributes)
            throws XACMLException

Sets the Attribute elements of this object

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 isMutable on the object.

toXMLString

String toXMLString(boolean includeNSPrefix,
                   boolean declareNS)
            throws XACMLException

Returns a String representation of this object

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

String toXMLString()
            throws XACMLException

Returns a string representation of this object

Returns:

a string representation of this object

Throws:

XACMLException - if conversion fails for any reason

makeImmutable

void makeImmutable()

Makes the object immutable

isMutable

boolean isMutable()

Checks if the object is mutable

Returns:

true if the object is mutable, false otherwise