Package org.opensaml.xacml.profile.saml
Interface XACMLAuthzDecisionQueryType
-
- All Superinterfaces:
RequestAbstractType,SAMLObject,SignableSAMLObject,SignableXMLObject,XACMLObject,XMLObject
public interface XACMLAuthzDecisionQueryType extends RequestAbstractType, XACMLObject
A SAML XACML profile XACMLAuthzDecisionQuery schema type.
-
-
Field Summary
Fields Modifier and Type Field Description static StringCOMBINEPOLICIES_ATTRIB_NAMECombinePolicies attribute name.static StringDEFAULT_ELEMENT_LOCAL_NAMEElement local name.static QNameDEFAULT_ELEMENT_NAME_XACML10Default element name for XACML 1.0.static QNameDEFAULT_ELEMENT_NAME_XACML11Default element name for XACML 1.1.static QNameDEFAULT_ELEMENT_NAME_XACML20Default element name for XACML 2.0.static QNameDEFAULT_ELEMENT_NAME_XACML30Default element name for XACML 3.0.static StringINPUTCONTEXTONLY_ATTRIB_NAMEInputContextOnly attribute name.static StringRETURNCONTEXT_ATTRIB_NAMEReturnContext attribute name.static StringTYPE_LOCAL_NAMELocal name of the XSI type.static QNameTYPE_NAME_XACML10QName of the XSI type.XACML1.0.static QNameTYPE_NAME_XACML11QName of the XSI type.XACML1.1.static QNameTYPE_NAME_XACML20QName of the XSI type.XACML2.0.static QNameTYPE_NAME_XACML30QName of the XSI type.XACML3.0.-
Fields inherited from interface org.opensaml.saml.saml2.core.RequestAbstractType
CONSENT_ATTRIB_NAME, DESTINATION_ATTRIB_NAME, EXPLICIT_CONSENT, ID_ATTRIB_NAME, IMPLICIT_CONSENT, INAPPLICABLE_CONSENT, ISSUE_INSTANT_ATTRIB_NAME, ISSUE_INSTANT_ATTRIB_QNAME, OBTAINED_CONSENT, PRIOR_CONSENT, TYPE_NAME, UNAVAILABLE_CONSENT, UNSPECIFIED_CONSENT, VERSION_ATTRIB_NAME
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description XSBooleanValuegetCombinePoliciesXSBooleanValue()Returns if the PDP can combine policies from the query and local policies.XSBooleanValuegetInputContextOnlyXSBooleanValue()True then use only information in the XACMLAuthzDecisionQuery, if false could use external XACML attributes.List<PolicyType>getPolicies()Gets the policies to be used while rendering a decision.List<PolicySetType>getPolicySets()Gets the policy sets to be used while rendering a decision.ReferencedPoliciesTypegetReferencedPolicies()Gets the reference to the policies to be used while rendering a decision.RequestTypegetRequest()Gets the request of the query.XSBooleanValuegetReturnContextXSBooleanValue()If true then include theRequestTypein the response.BooleanisCombinePolicies()Returns if the PDP can combine policies from the query and local policies.BooleanisInputContextOnly()True then use only information in the XACMLAuthzDecisionQuery, if false could use external XACML attributes.BooleanisReturnContext()If true then include theRequestTypein the response.voidsetCombinePolicies(Boolean combinePolicies)Sets if the PDP can combine policies from this query and the one locally.voidsetCombinePolicies(XSBooleanValue combinePolicies)Sets if the PDP can combine policies from this query and the one locally.voidsetInputContextOnly(Boolean inputContextOnly)Sets if external attributes is allowed in the decision, true if it's allowed.voidsetInputContextOnly(XSBooleanValue inputContextOnly)Sets if external attributes is allowed in the decision, true if it's allowed.voidsetReferencedPolicies(ReferencedPoliciesType policies)Sets the reference to the policies to be used while rendering a decision.voidsetRequest(RequestType request)Set's the XACML Request.voidsetReturnContext(Boolean returnContext)Set's if theRequestTypeshould be included inside the request message.voidsetReturnContext(XSBooleanValue returnContext)Set's if theRequestTypeshould 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_LOCAL_NAME
static final String DEFAULT_ELEMENT_LOCAL_NAME
Element local name.- See Also:
- Constant Field Values
-
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_LOCAL_NAME
static final String TYPE_LOCAL_NAME
Local name of the XSI type.- See Also:
- Constant Field Values
-
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
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
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<PolicyType> getPolicies()
Gets the policies to be used while rendering a decision.- Returns:
- policies to be used while rendering a decision
-
getPolicySets
List<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
RequestType getRequest()
Gets the request of the query.- Returns:
- XACMLRequest The request inside the query
-
getReturnContextXSBooleanValue
XSBooleanValue getReturnContextXSBooleanValue()
If true then include theRequestTypein the response.- Returns:
- boolean true if the
RequestTypeshould 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 theRequestTypein the response.- Returns:
- boolean if the
RequestTypeshould 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(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(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(RequestType request)
Set's the XACML Request.- Parameters:
request- The request of the decision query
-
setReturnContext
void setReturnContext(Boolean returnContext)
Set's if theRequestTypeshould be included inside the request message.- Parameters:
returnContext- is true if theRequestTypeshould be included inside the request message
-
setReturnContext
void setReturnContext(XSBooleanValue returnContext)
Set's if theRequestTypeshould be included inside the request message.- Parameters:
returnContext- is true if theRequestTypeshould be included inside the request message
-
-