org.example.azapi
Interface AzResourceActionAssociation


public interface AzResourceActionAssociation

The AzResourceActionAssociation is a pairing of an AzResource entity (aka: AzEntity), and an AzAction entity (aka: AzEntity), for the purpose of submitting the pair as a specific resource/action pair for which an authorization decision can be obtained.

Every XACML PDP authorization decision request requires one Resource element and one Action element. The AzResource and AzAction in this AzResourceActionAssociation are in one to one correspondence with the basis of construction of the XACML Resource and XACML Action elements that are submitted to the PDP when this AzResourceActionAssociation is part of an AzRequestContext submitted to an AzService.decide() call.
In general, one AzService.decide() call can make multiple PDP authorization requests, but each individual request in the set of requests will have a unique AzResourceActionAssociation object that is the basis of that individual request.
When AzResponseContext is returned the AzResourceActionAssociation object reference will be available for programmatic correlation of multiple requests with multiple results.
In addition, other correlation is also made available including a user readable CorrelationID, and the resource-id and action-id associated with the AzResource and AzAction entities if available.

Author:
rlevinson

Method Summary
 boolean equals(AzResourceActionAssociation azResourceActionAssociation)
          Compare this association with another for equality based on object reference.
 AzEntity<AzCategoryIdAction> getAzAction()
          Get the AzAction entity component of the association.
 AzEntity<AzCategoryIdResource> getAzResource()
          Get the AzResource entity component of the association.
 AzResourceActionAssociationId getAzResourceActionAssociationId()
          Get the helper object from the association that contains the resource-id and action-id if present.
 int getCorrelationId()
          An integer correlation id is created when the association is created.
 

Method Detail

getAzAction

AzEntity<AzCategoryIdAction> getAzAction()
Get the AzAction entity component of the association.

Returns:
the "AzAction" associated with this AzResourceActionAssociation object

getAzResource

AzEntity<AzCategoryIdResource> getAzResource()
Get the AzResource entity component of the association.

Returns:
the "AzResource" associated with this AzResourceActionAssociation object

getAzResourceActionAssociationId

AzResourceActionAssociationId getAzResourceActionAssociationId()
Get the helper object from the association that contains the resource-id and action-id if present.

Returns:
the AzResourceActionAssociationId helper object

equals

boolean equals(AzResourceActionAssociation azResourceActionAssociation)
Compare this association with another for equality based on object reference.

Parameters:
azResourceActionAssociation -
Returns:
a boolean true if the AzResourceActionAssociations are identical, otherwise false

getCorrelationId

int getCorrelationId()
An integer correlation id is created when the association is created. This integer is intended for informal user-friendly correlation of results. It has no corresponding reference in XACML.

Returns:
an int that may be used to assist correlating the AzResourceActionAssociations in the AzRequestContext with those found in the AzResponseContext