org.forgerock.openam.entitlement.rest.model.json

Class TreePolicyRequest

java.lang.Object

org.forgerock.openam.entitlement.rest.model.json.PolicyRequest

org.forgerock.openam.entitlement.rest.model.json.TreePolicyRequest

public final class TreePolicyRequest
extends PolicyRequest

A policy request that takes a single resource and is used to render policy decisions for that resource and for all policies that match sub-resources of that resource.

Since:

12.0.0

Method Summary

Modifier and Type	Method and Description
List<Entitlement>	dispatch(PolicyEvaluator evaluator) Given the policy evaluator dispatch oneself as one knows best.
String	getResource()
static TreePolicyRequest	getTreePolicyRequest(org.forgerock.services.context.Context context, org.forgerock.json.resource.ActionRequest request, SSOTokenManager tokenManager) Gets a tree policy request based on the context and action request.

Methods inherited from class org.forgerock.openam.entitlement.rest.model.json.PolicyRequest

getApplication, getEnvironment, getPolicySubject, getRealm, getRestSubject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getResource

public String getResource()

dispatch

public List<Entitlement> dispatch(PolicyEvaluator evaluator)
                           throws EntitlementException

Description copied from class: PolicyRequest

Given the policy evaluator dispatch oneself as one knows best.

Specified by:

dispatch in class PolicyRequest

Parameters:

evaluator - the non-null policy evaluator

Returns:

a list of policy decisions retrieved from the evaluator

Throws:

EntitlementException - should dispatch and evaluation fail

getTreePolicyRequest

public static TreePolicyRequest getTreePolicyRequest(org.forgerock.services.context.Context context,
                                                     org.forgerock.json.resource.ActionRequest request,
                                                     SSOTokenManager tokenManager)
                                              throws EntitlementException

Gets a tree policy request based on the context and action request.

Parameters:

context - the context

request - the request

tokenManager - An SSOTokenManager instance.

Returns:

a tree policy request

Throws:

EntitlementException - should creating a tree policy request fail