Interface XACMLAuthzDecisionQueryType

  • All Superinterfaces:
    org.opensaml.saml.saml2.core.RequestAbstractType, org.opensaml.saml.common.SAMLObject, org.opensaml.saml.common.SignableSAMLObject, org.opensaml.xmlsec.signature.SignableXMLObject, org.opensaml.xacml.XACMLObject, org.opensaml.core.xml.XMLObject

    public interface XACMLAuthzDecisionQueryType
    extends org.opensaml.saml.saml2.core.RequestAbstractType, org.opensaml.xacml.XACMLObject
    A SAML XACML profile XACMLAuthzDecisionQuery schema type.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.opensaml.core.xml.schema.XSBooleanValue getCombinePoliciesXSBooleanValue()
      Returns if the PDP can combine policies from the query and local policies.
      org.opensaml.core.xml.schema.XSBooleanValue getInputContextOnlyXSBooleanValue()
      True then use only information in the XACMLAuthzDecisionQuery, if false could use external XACML attributes.
      List<org.opensaml.xacml.policy.PolicyType> getPolicies()
      Gets the policies to be used while rendering a decision.
      List<org.opensaml.xacml.policy.PolicySetType> getPolicySets()
      Gets the policy sets to be used while rendering a decision.
      ReferencedPoliciesType getReferencedPolicies()
      Gets the reference to the policies to be used while rendering a decision.
      org.opensaml.xacml.ctx.RequestType getRequest()
      Gets the request of the query.
      org.opensaml.core.xml.schema.XSBooleanValue getReturnContextXSBooleanValue()
      If true then include the RequestType in the response.
      Boolean isCombinePolicies()
      Returns if the PDP can combine policies from the query and local policies.
      Boolean isInputContextOnly()
      True then use only information in the XACMLAuthzDecisionQuery, if false could use external XACML attributes.
      Boolean isReturnContext()
      If true then include the RequestType in the response.
      void setCombinePolicies​(Boolean combinePolicies)
      Sets if the PDP can combine policies from this query and the one locally.
      void setCombinePolicies​(org.opensaml.core.xml.schema.XSBooleanValue combinePolicies)
      Sets if the PDP can combine policies from this query and the one locally.
      void setInputContextOnly​(Boolean inputContextOnly)
      Sets if external attributes is allowed in the decision, true if it's allowed.
      void setInputContextOnly​(org.opensaml.core.xml.schema.XSBooleanValue inputContextOnly)
      Sets if external attributes is allowed in the decision, true if it's allowed.
      void setReferencedPolicies​(ReferencedPoliciesType policies)
      Sets the reference to the policies to be used while rendering a decision.
      void setRequest​(org.opensaml.xacml.ctx.RequestType request)
      Set's the XACML Request.
      void setReturnContext​(Boolean returnContext)
      Set's if the RequestType should be included inside the request message.
      void setReturnContext​(org.opensaml.core.xml.schema.XSBooleanValue returnContext)
      Set's if the RequestType should be included inside the request message.
      • Methods inherited from interface org.opensaml.saml.saml2.core.RequestAbstractType

        getConsent, getDestination, getExtensions, getID, getIssueInstant, getIssuer, getVersion, setConsent, setDestination, setExtensions, setID, setIssueInstant, setIssuer, setVersion
      • Methods inherited from interface org.opensaml.saml.common.SignableSAMLObject

        getSignatureReferenceID
      • Methods inherited from interface org.opensaml.xmlsec.signature.SignableXMLObject

        getSignature, isSigned, setSignature
      • Methods inherited from interface org.opensaml.core.xml.XMLObject

        detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation
    • Field Detail

      • DEFAULT_ELEMENT_NAME_XACML10

        static final QName DEFAULT_ELEMENT_NAME_XACML10
        Default element name for XACML 1.0.
      • DEFAULT_ELEMENT_NAME_XACML11

        static final QName DEFAULT_ELEMENT_NAME_XACML11
        Default element name for XACML 1.1.
      • DEFAULT_ELEMENT_NAME_XACML20

        static final QName DEFAULT_ELEMENT_NAME_XACML20
        Default element name for XACML 2.0.
      • DEFAULT_ELEMENT_NAME_XACML30

        static final QName DEFAULT_ELEMENT_NAME_XACML30
        Default element name for XACML 3.0.
      • TYPE_NAME_XACML10

        static final QName TYPE_NAME_XACML10
        QName of the XSI type.XACML1.0.
      • TYPE_NAME_XACML11

        static final QName TYPE_NAME_XACML11
        QName of the XSI type.XACML1.1.
      • TYPE_NAME_XACML20

        static final QName TYPE_NAME_XACML20
        QName of the XSI type.XACML2.0.
      • TYPE_NAME_XACML30

        static final QName TYPE_NAME_XACML30
        QName of the XSI type.XACML3.0.
      • INPUTCONTEXTONLY_ATTRIB_NAME

        static final String INPUTCONTEXTONLY_ATTRIB_NAME
        InputContextOnly attribute name.
        See Also:
        Constant Field Values
      • RETURNCONTEXT_ATTRIB_NAME

        static final String RETURNCONTEXT_ATTRIB_NAME
        ReturnContext attribute name.
        See Also:
        Constant Field Values
      • COMBINEPOLICIES_ATTRIB_NAME

        static final String COMBINEPOLICIES_ATTRIB_NAME
        CombinePolicies attribute name.
        See Also:
        Constant Field Values
    • Method Detail

      • getCombinePoliciesXSBooleanValue

        org.opensaml.core.xml.schema.XSBooleanValue getCombinePoliciesXSBooleanValue()
        Returns if the PDP can combine policies from the query and local policies.
        Returns:
        XSBooleanValue true if the PDP can combine policies from the query and locally
      • getInputContextOnlyXSBooleanValue

        org.opensaml.core.xml.schema.XSBooleanValue getInputContextOnlyXSBooleanValue()
        True then use only information in the XACMLAuthzDecisionQuery, if false could use external XACML attributes.
        Returns:
        if the use of just attributes in the XACMLAuthzDecisionQuery is allowed
      • getPolicies

        List<org.opensaml.xacml.policy.PolicyType> getPolicies()
        Gets the policies to be used while rendering a decision.
        Returns:
        policies to be used while rendering a decision
      • getPolicySets

        List<org.opensaml.xacml.policy.PolicySetType> getPolicySets()
        Gets the policy sets to be used while rendering a decision.
        Returns:
        policy sets to be used while rendering a decision
      • getReferencedPolicies

        ReferencedPoliciesType getReferencedPolicies()
        Gets the reference to the policies to be used while rendering a decision.
        Returns:
        references to the policies to be used while rendering a decision
      • setReferencedPolicies

        void setReferencedPolicies​(ReferencedPoliciesType policies)
        Sets the reference to the policies to be used while rendering a decision.
        Parameters:
        policies - reference to the policies to be used while rendering a decision
      • getRequest

        org.opensaml.xacml.ctx.RequestType getRequest()
        Gets the request of the query.
        Returns:
        XACMLRequest The request inside the query
      • getReturnContextXSBooleanValue

        org.opensaml.core.xml.schema.XSBooleanValue getReturnContextXSBooleanValue()
        If true then include the RequestType in the response.
        Returns:
        boolean true if the RequestType should be included in the response
      • isCombinePolicies

        Boolean isCombinePolicies()
        Returns if the PDP can combine policies from the query and local policies.
        Returns:
        true if the PDP can combine policies from the query and locally
      • isInputContextOnly

        Boolean isInputContextOnly()
        True then use only information in the XACMLAuthzDecisionQuery, if false could use external XACML attributes.
        Returns:
        boolean true then use of just attributes in the XACMLAuthzDecisionQuery is allowed
      • isReturnContext

        Boolean isReturnContext()
        If true then include the RequestType in the response.
        Returns:
        boolean if the RequestType should be included in the response
      • setCombinePolicies

        void setCombinePolicies​(Boolean combinePolicies)
        Sets if the PDP can combine policies from this query and the one locally.
        Parameters:
        combinePolicies - If true then the PDP can combine policies from this query and the one locally
      • setCombinePolicies

        void setCombinePolicies​(org.opensaml.core.xml.schema.XSBooleanValue combinePolicies)
        Sets if the PDP can combine policies from this query and the one locally.
        Parameters:
        combinePolicies - If true then the PDP can combine policies from this query and the one locally
      • setInputContextOnly

        void setInputContextOnly​(Boolean inputContextOnly)
        Sets if external attributes is allowed in the decision, true if it's allowed.
        Parameters:
        inputContextOnly - if external attributes is allowed in the decision, true if it's allowed.
      • setInputContextOnly

        void setInputContextOnly​(org.opensaml.core.xml.schema.XSBooleanValue inputContextOnly)
        Sets if external attributes is allowed in the decision, true if it's allowed.
        Parameters:
        inputContextOnly - if external attributes is allowed in the decision, true if it's allowed.
      • setRequest

        void setRequest​(org.opensaml.xacml.ctx.RequestType request)
        Set's the XACML Request.
        Parameters:
        request - The request of the decision query
      • setReturnContext

        void setReturnContext​(Boolean returnContext)
        Set's if the RequestType should be included inside the request message.
        Parameters:
        returnContext - is true if the RequestType should be included inside the request message
      • setReturnContext

        void setReturnContext​(org.opensaml.core.xml.schema.XSBooleanValue returnContext)
        Set's if the RequestType should be included inside the request message.
        Parameters:
        returnContext - is true if the RequestType should be included inside the request message