org.example.azapi
Interface AzResult


public interface AzResult

Author:
rlevinson

Method Summary
 AzDecision getAzDecision()
          Returns a value drawn from the AzDecision type.
 AzObligations getAzObligations()
          Returns the AzObligations object, which can contain 0 or more AzObligations (AzEntity).
 AzResourceActionAssociation getAzResourceActionAssociation()
          A convenience method to return the combined AzResource, AzAction object references (AzResourceActionAssociation) for this AzResult.
 AzStatusCode getAzStatusCode()
          Returns one of the Enum OK, MISSINGATTRIBUTE or ERROR belonging to type AzStatusCode
 AzEntity<AzCategoryIdStatusDetail> getAzStatusDetail()
          May be used to return an arbitrary object from the PDP.
 java.lang.String getResourceId()
          Returns the optional XACML ResourceId attribute.
 java.lang.String getStatusMessage()
          Returns an informational string message, if provided by the PDP.
 

Method Detail

getAzDecision

AzDecision getAzDecision()
Returns a value drawn from the AzDecision type.

Returns:
the AzDecision Enum associated with this AzResult

getAzStatusCode

AzStatusCode getAzStatusCode()
Returns one of the Enum OK, MISSINGATTRIBUTE or ERROR belonging to type AzStatusCode

Returns:
the AzStatusCode associated with this AzResult

getStatusMessage

java.lang.String getStatusMessage()
Returns an informational string message, if provided by the PDP.

Returns:
a String containing the status message

getAzStatusDetail

AzEntity<AzCategoryIdStatusDetail> getAzStatusDetail()
May be used to return an arbitrary object from the PDP. In the most well-defined XACML case, when a MissingAttribute code is returned, it must take the form of a Set contained in the "AzStatusDetail" entity (AzEntity).

Returns:
the AzStatusDetail entity associated with this AzResult, if present, otherwise null.

getAzObligations

AzObligations getAzObligations()
Returns the AzObligations object, which can contain 0 or more AzObligations (AzEntity).

Returns:
the AzObligations object associated with this AzResult, otherwise null

getResourceId

java.lang.String getResourceId()
Returns the optional XACML ResourceId attribute. AzXacmlStrings.X_ATTR_RESOURCE_ID , if present, that may be returned by the PDP in the XACML Result element. The ResourceId is intended to identify the resource about which the authorization decision is made.

If not present, then it is assumed the decision refers to the resource-id specified in the Request.

Returns:
a String containing the XACML resource-id attribute.

getAzResourceActionAssociation

AzResourceActionAssociation getAzResourceActionAssociation()
A convenience method to return the combined AzResource, AzAction object references (AzResourceActionAssociation) for this AzResult.
This object is guaranteed to be uniquely associated with the corresponding AzResourceActionAssociation that was submitted to the PDP based on a specific pair of AzResource and AzAction objects and which produced this AzResult.

Returns:
azResourceActionAssociation
See Also:
AzResourceActionAssociation.equals(org.example.azapi.AzResourceActionAssociation)