Package com.broadleafcommerce.data.tracking.core.policy.trackable

Class TrackableEntityPolicyEvaluator

java.lang.Object

com.broadleafcommerce.data.tracking.core.policy.trackable.TrackableEntityPolicyEvaluator

All Implemented Interfaces:

PolicyEvaluator

public class TrackableEntityPolicyEvaluator
extends Object
implements PolicyEvaluator

Default implementation of PermissionEvaluator responsible for checking the validity of a requested mutating method call on a Trackable entity given the current Spring Security authority and additional ContextInfo information.

This validation generally encapsulates checks not only against the current Spring Security principal granted authorities, but also against the application and catalog information in play and the user's authorization to read or mutate records for the application and/or catalog.

Author:

Jeff Fischer

Constructor Summary

Constructors

Constructor	Description
TrackableEntityPolicyEvaluator(PolicyUtils policyUtils)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
PolicyUtils	getPolicyUtils()
int	hashCode()
protected boolean	isOwnerPolicy(PolicyInformation policy)	Does this policy contain IdentityType.OWNER?
String	toString()
PolicyResponse	validate(Map<Integer,Object> methodParams, PolicyInformation policy, ContextInfo contextInfo, OperationType operationType)	Validate security context required to execute a method annotated with Policy.
PolicyResponse	validateReadOutput(Object output, PolicyInformation policy)	Validate the output of a read method for methods annotated with a Policy of the IdentityType.OWNER type and a matching user of the owner type (see TrackablePolicyUtils#isOwnerUser()).
protected PolicyResponse	validateRequestedOperation(Map<Integer,Object> methodParams, PolicyInformation policy, ContextInfo contextInfo, OperationType operationType, TrackablePolicyUtils trackablePolicyUtils)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TrackableEntityPolicyEvaluator

public TrackableEntityPolicyEvaluator(PolicyUtils policyUtils)

Method Detail

validate

public PolicyResponse validate(Map<Integer,Object> methodParams,
                               PolicyInformation policy,
                               ContextInfo contextInfo,
                               OperationType operationType)

Description copied from interface: PolicyEvaluator

Validate security context required to execute a method annotated with Policy.

Specified by:

validate in interface PolicyEvaluator

Parameters:

methodParams - The method parameters in the method call being validated

policy - The Policy annotation on the method

Returns:

The result of the validation

isOwnerPolicy

protected boolean isOwnerPolicy(PolicyInformation policy)

Does this policy contain IdentityType.OWNER?

Parameters:

policy - The policy information

Returns:

true if this is an OWNER policy, else false.

validateRequestedOperation

protected PolicyResponse validateRequestedOperation(Map<Integer,Object> methodParams,
                                                    PolicyInformation policy,
                                                    ContextInfo contextInfo,
                                                    OperationType operationType,
                                                    TrackablePolicyUtils trackablePolicyUtils)

validateReadOutput

public PolicyResponse validateReadOutput(Object output,
                                         PolicyInformation policy)

Description copied from interface: PolicyEvaluator

Validate the output of a read method for methods annotated with a Policy of the IdentityType.OWNER type and a matching user of the owner type (see TrackablePolicyUtils#isOwnerUser()).

Specified by:

validateReadOutput in interface PolicyEvaluator

Parameters:

output - The results of the read operation

policy - The Policy annotation on the method

Returns:

The result of the validation

getPolicyUtils

public PolicyUtils getPolicyUtils()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object