Package com.sun.identity.xacml.context.impl

Class EnvironmentImpl

  • All Implemented Interfaces:
    Environment
    @SupportedAll
public class EnvironmentImpl
extends Object
implements Environment
    The Environment element specifies information about the environment requested in the Request context by listing a sequence of Attribute elements associated with the environment. 

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

    • Constructor Detail

      • EnvironmentImpl

        public EnvironmentImpl()
        Creates a new instance of EnvironmentImpl

      • EnvironmentImpl

        public EnvironmentImpl​(String xml)
                throws XACMLException
        This constructor is used to build Environment object from a XML string.
        Parameters:
        xml - A java.lang.String representing a Environment object
        Throws:
        XACMLException - if it could not process the XML string

      • EnvironmentImpl

        public EnvironmentImpl​(Element element)
                throws XACMLException
        This constructor is used to build Environment 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 Environment object
        Throws:
        XACMLException - if it could not process the Element

    • Method Detail

      • getAttributes

        public List getAttributes()
        Description copied from interface: Environment
        Returns zero to many Attribute elements of this object. If no attributes and present, empty List will be returned.
        Specified by:
        getAttributes in interface Environment
        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 Environment
        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 Environment
        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

      • makeImmutable

        public void makeImmutable()
        Makes the object immutable
        Specified by:
        makeImmutable in interface Environment

      • isMutable

        public boolean isMutable()
        Checks if the object is mutable
        Specified by:
        isMutable in interface Environment
        Returns:
        true if the object is mutable, false otherwise