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

Class EnvironmentImpl

java.lang.Object
com.sun.identity.xacml.context.impl.EnvironmentImpl
All Implemented Interfaces:
XmlSerializable, 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 Details

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

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

    • toDocumentFragment

      public DocumentFragment toDocumentFragment(Document document, boolean includeNSPrefix, boolean declareNS) throws com.sun.identity.saml2.common.SAML2Exception
      Description copied from interface: XmlSerializable
      Serializes the element into an XML DocumentFragment. A default implementation is provided for compatibility with legacy code that implements XmlSerializable.toXMLString(), but it is highly recommended to override this method.
      Specified by:
      toDocumentFragment in interface XmlSerializable
      Parameters:
      document - the parent Document to create the document fragment from.
      includeNSPrefix - whether to include a namespace prefix in the document elements.
      declareNS - whether to declare any namespaces or assume that they are already declared.
      Returns:
      the XML document fragment representing this SAML2 element.
      Throws:
      com.sun.identity.saml2.common.SAML2Exception - if the element cannot be serialized 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