Package com.sun.identity.xacml.saml2

Interface XACMLAuthzDecisionQuery

  • All Superinterfaces:
    RequestAbstract
    All Known Implementing Classes:
    XACMLAuthzDecisionQueryImpl
    public interface XACMLAuthzDecisionQuery
extends RequestAbstract
    The XACMLAuthzDecisionQuery element is a SAML Query that extends SAML Protocol schema type RequestAbstractType. It allows an XACML PEP to submit an XACML Request Context in a SAML Query along with other information. This element is an alternative to SAML defined that allows an XACML PEP to communicate with an XACML PDP using SAML2 protocol.

    Schema: 

    <xs:element name="XACMLAuthzDecisionQuery"
         type="XACMLAuthzDecisionQueryType"/>
<xs:complexType name="XACMLAuthzDecisionQueryType">
  <xs:complexContent>
    <xs:extension base="samlp:RequestAbstractType">
      <xs:sequence>
        <xs:element ref="xacml-context:Request"/>
      <xs:sequence>
      <xs:attribute name="InputContextOnly"
                    type="boolean"
                    use="optional"
                    default="false"/>
      <xs:attribute name="ReturnContext"
                    type="boolean"
                    use="optional"
                    default="false"/>
    <xs:extension>
  <xs:complexContent>
<xs:complexType>
    Schema for base: 
      <complexType name="RequestAbstractType" abstract="true">
      <sequence>
          <element ref="saml:Issuer" minOccurs="0"/>
          <element ref="ds:Signature" minOccurs="0"/>
          <element ref="samlp:Extensions" minOccurs="0"/>
      <sequence>
      <attribute name="ID" type="ID" use="required"/>
      <attribute name="Version" type="string" use="required"/>
      <attribute name="IssueInstant" type="dateTime" use="required"/>
      <attribute name="Destination" type="anyURI" use="optional"/>
        <attribute name="Consent" type="anyURI" use="optional"/>
  <complexType>

    • Method Detail

      • getInputContextOnly

        boolean getInputContextOnly()
        Returns the XML attribute boolean value which governs the source of information that the PDP is allowed to use in making an authorization decision. If this attribute is "true" then it indiactes that the authorization decision has been made solely on the basis of information contained in the XACMLAuthzDecisionQuery; no external attributes have been used. If this value is "false" then the decision may have been made on the basis of external attributes not conatined in the XACMLAuthzDecisionQuery.
        Returns:
        boolean indicating the value of this attribute.

      • setInputContextOnly

        void setInputContextOnly​(boolean inputContextOnly)
                  throws XACMLException
        Sets the XML attribute boolean value which governs the source of information that the PDP is allowed to use in making an authorization decision. If this attribute is "true" then it indicates to the PDP that the authorization decision has to be made solely on the basis of information contained in the XACMLAuthzDecisionQuery; no external attributes may be used. If this value is "false" then the decision can be made on the basis of external attributes not conatined in the XACMlAuthzDecisionQuery.
        Parameters:
        inputContextOnly - boolean indicating the value of this attribute.
        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.

      • getReturnContext

        boolean getReturnContext()
        Returns the XML attribute boolean value which provides means to PEP to request that an xacml-context>Request element be included in the XACMlAuthzdecisionStatement resulting from the request. It also governs the contents of that element. If this attribite is "true" then the PDP SHALL include the xacml-context:Request element in the XACMLAuthzDecisionStatement element in the XACMLResponse. The xacml-context:Request SHALL include all the attributes supplied by the PEP in the AuthzDecisionQuery which were used in making the authz decision. Other addtional attributes which may have been used by the PDP may be included. If this attribute is "false" then the PDP SHALL NOT include the xacml-context:Request element in the XACMLAuthzDecisionStatement.
        Returns:
        boolean indicating the value of this attribute.

      • setReturnContext

        void setReturnContext​(boolean returnContext)
               throws XACMLException
        Sets the boolean value for this XML attribute
        Parameters:
        returnContext - boolean indicating the value of this attribute.
        Throws:
        XACMLExceptioXACMLException - 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.
        XACMLException
        See Also:
        getReturnContext()

      • getRequest

        Request getRequest()
        Returns the xacml-context:Request element of this object
        Returns:
        the xacml-context:Request elements of this object

      • setRequest

        void setRequest​(Request request)
         throws XACMLException
        Sets the xacml-context:Request element of this object
        Parameters:
        request - the xacml-context:Request element 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.

      • toXMLString

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

      • isMutable

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