org.example.azapi
Interface AzResponseContext


public interface AzResponseContext

The AzResponseContext which is returned by an AzService.decide call corresponds to the XML Response Context Defined by XACML.

Each response can be correlated to the specific request based on the values of the AzResourceActionAssociation associated with each AzResult object in the AzResponseContext.

Author:
rlevinson

Method Summary
 AzResult getResult(AzResourceActionAssociation azAssociation)
          Returns the AzResult object which is associated with a specific AzResourceAssociation object.
 java.util.Set<AzResult> getResults()
          Returns a Set of zero to n AzResult objects that are contained in the Response.
 

Method Detail

getResult

AzResult getResult(AzResourceActionAssociation azAssociation)
Returns the AzResult object which is associated with a specific AzResourceAssociation object.
The AzResourceAssociation object must be from the Set of AzResourceAssociation objects that were in the AzRequestContext object that was the basis for this AzResponseContext object.

Parameters:
azAssociation - an AzResourceActionAssociation object, generally from the associated AzRequestContext
Returns:
the AzResult object associated with the requesting AzResourceActionAssociation object parameter

getResults

java.util.Set<AzResult> getResults()
Returns a Set of zero to n AzResult objects that are contained in the Response.

This method returns all the AzResult objects in the Response. The caller can then use the java.util.Set to iterate through the AzResult objects.

Correlation of output AzResults with input AzResourceAssociation may be managed using the AzResourceActionAssociation object reference by correlating the object returned in the AzResult with one of the objects submitted in the AzRequestContext.

Alternative correlation mechanisms include using the locally defined AzResourceActionAssociation.getCorrelationId() identifier, which may be used to provide more user-friendly identifiers. In addition, one may use the standard XACML 2.0 ResourceId attribute (which may not produce unambiguous results depending on the set of requests where duplicates or omissions may exist). Finally, it is possible that there will emerge xml:id attributes that the ContextHandler may apply in proprietary profiles or the currently planned XACML 3.0 multiple resource profile.

Returns:
the Set containing the AzResults in this AzResponseContext