Package com.sun.identity.xacml.context

Interface Request

  • All Superinterfaces:
    XmlSerializable
    All Known Implementing Classes:
    RequestImpl
    @SupportedAll
public interface Request
extends XmlSerializable
    The Request element is the top-level element in the XACML context scehema. Its an abstraction layer used by the policy language. It contains Subject, Resource, Action and Environment elements. 

     <xs:complexType name="RequestType">
   <xs:sequence>
     <xs:element ref="xacml-context:Subject" maxOccurs="unbounded"/>
     <xs:element ref="xacml-context:Resource" maxOccurs="unbounded"/>
     <xs:element ref="xacml-context:Action"/>
     <xs:element ref="xacml-context:Environment"/>
   <xs:sequence>
 <xs:complexType>

    • Method Detail

      • getSubjects

        List getSubjects()
        Returns the one to many Subject elements of this object
        Returns:
        the Subject elements of this object

      • setSubjects

        void setSubjects​(List subjects)
          throws XACMLException
        Sets the one to many Subject elements of this object
        Parameters:
        subjects - the one to many Subject elements of this object
        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.

      • getResources

        List getResources()
        Returns the one to many Resource elements of this object
        Returns:
        the Resource elements of this object

      • setResources

        void setResources​(List resources)
           throws XACMLException
        Sets the one to many Resource elements of this object
        Parameters:
        resources - the one to many Resource elements of this object
        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.

      • getAction

        Action getAction()
        Returns the instance of Action
        Returns:
        instance of Action

      • setAction

        void setAction​(Action action)
        throws XACMLException
        Sets the instance of Action
        Parameters:
        action - instance of Action
        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.

      • getEnvironment

        Environment getEnvironment()
        Returns the instance of Environment
        Returns:
        the instance of Environment

      • setEnvironment

        void setEnvironment​(Environment env)
             throws XACMLException
        Sets the instance of Environment
        Parameters:
        env - instance of Environment
        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

        default String toXMLString​(boolean includeNSPrefix,
                           boolean declareNS)
                    throws XACMLException
        Returns a String representation of this object
        Specified by:
        toXMLString in interface XmlSerializable
        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

        void makeImmutable()
        Makes the object immutable

      • isMutable

        boolean isMutable()
        Checks if the object is mutable
        Returns:
        true if the object is mutable, false otherwise