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

Class PolicyContext

java.lang.Object

com.broadleafcommerce.data.tracking.core.policy.PolicyContext

public class PolicyContext
extends Object

A thread context to keep track of Policy aspects during validation. This facilitates inheritance of properties from parent Policy declarations during the flow of validation. For example, an initial Policy annotation could declare Policy.permissionRoots(), which are inherited by other Policy declarations on a more generic service that might only declare Policy.operationTypes().

Author:

Jeff Fischer

Constructor Summary

Constructors

Constructor	Description
PolicyContext()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static void	clear(String signature)
PolicyInformation	derivePolicyInformation(PolicyInformation start)	Embellish the current PolicyInformation with any inherited information from a parent PolicyInformation instance in logic flow.
boolean	equals(Object o)
static PolicyContext	getContext()
Map<String,PolicyInformation>	getContextPolicies()
PolicyInformation	getMostDerivedPolicyInformation()	Policy validation flows may "stack" as a codepath progresses, and become more derived via derivePolicyInformation(PolicyInformation).
int	hashCode()
void	setContextPolicies(Map<String,PolicyInformation> contextPolicies)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PolicyContext

public PolicyContext()

Method Details

derivePolicyInformation

public PolicyInformation derivePolicyInformation(PolicyInformation start)

Embellish the current PolicyInformation with any inherited information from a parent PolicyInformation instance in logic flow.

Parameters:

start - The current PolicyInformation instance

Returns:

The embellished PolicyInformation instance

getContext

public static PolicyContext getContext()

getMostDerivedPolicyInformation

@Nullable
public PolicyInformation getMostDerivedPolicyInformation()

Policy validation flows may "stack" as a codepath progresses, and become more derived via derivePolicyInformation(PolicyInformation). This is a convenience method that can be used to get the "last" or "most derived" policy information from getContextPolicies().

Returns:

the "last" or "most derived" policy information from getContextPolicies(). If getContextPolicies() is empty, this will return null.

clear

public static void clear(String signature)

getContextPolicies

public Map<String,PolicyInformation> getContextPolicies()

setContextPolicies

public void setContextPolicies(Map<String,PolicyInformation> contextPolicies)

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