PolicyEvaluator (OpenSSO Public API)

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

com.sun.identity.policy
クラス PolicyEvaluator

java.lang.Object
  com.sun.identity.policy.PolicyEvaluator

public class PolicyEvaluator
extends Object
extends Object

The class PolicyEvaluator evaluates policies and provides policy decisions.

フィールドの概要
`static String`	`ALL_RESOURCES` Constant used to identity all the resources of a service type.
`static String`	`EMPTY_RESOURCE_NAME` Constant used to identity empty resource

コンストラクタの概要
`PolicyEvaluator(String serviceTypeName)` Constructor to create a `PolicyEvaluator` given the `ServiceType` name.

メソッドの概要
`void`	`addPolicyListener(PolicyListener policyListener)` Adds a policy listener that would be notified whenever a policy is added, removed or changed
`PolicyDecision`	`getPolicyDecision(SSOToken token, String resourceName, Set actionNames, Map envParameters)` Evaluates privileges of the user to perform the specified actions on the specified resource.
`Set`	`getProtectedResourcesIgnoreConditions(SSOToken token, String rootResource)` Gets protected resources for a user identified by single sign on token Conditions defined in the policies are ignored while computing protected resources.
`ResourceResult`	`getResourceResult(SSOToken token, String resourceName, String scope, Map envParameters)` 推奨されていません。 Use `getResourceResults()`
`Set`	`getResourceResults(SSOToken token, String resourceName, String scope, Map envParameters)` Gets resource result objects given a resource name.
`boolean`	`isAllowed(SSOToken token, String resourceName, String actionName, Map envParameters)` Evaluates simple privileges of boolean type.
`void`	`removePolicyListener(PolicyListener policyListener)` Removes a policy listener that was previously registered to receive notifications whenever a policy is added, removed or changed.

フィールドの詳細

ALL_RESOURCES

public static final String ALL_RESOURCES

Constant used to identity all the resources of a service type. The resources include the sub resources of all resource prefixes of resource type

関連項目:: 定数フィールド値

EMPTY_RESOURCE_NAME

public static final String EMPTY_RESOURCE_NAME

Constant used to identity empty resource

関連項目:: 定数フィールド値

コンストラクタの詳細

PolicyEvaluator

public PolicyEvaluator(String serviceTypeName)
                throws SSOException,
                       NameNotFoundException,
                       PolicyException

Constructor to create a PolicyEvaluator given the


 ServiceType

name.

パラメータ:: serviceTypeName - the name of the ServiceType for which this evaluator can be used.
例外:: SSOException - if SSOToken used by PolicyEvaluator is invalid; NameNotFoundException - if the service with name serviceTypeName is not found; PolicyException - for any other abnormal condition

メソッドの詳細

isAllowed

public boolean isAllowed(SSOToken token,
                         String resourceName,
                         String actionName,
                         Map envParameters)
                  throws SSOException,
                         PolicyException

Evaluates simple privileges of boolean type. The privilege indicate if the user can perform specified action on the specified resource. The evaluation depends on user's application environment parameters. Invoking this method would result in PolicyException, if the syntax for the actionName is not declared to be boolean, in the service schema.

パラメータ:: token - single sign on token of the user evaluating policies; resourceName - name of the resource the user is trying to access; actionName - name of the action the user is trying to perform on the resource; envParameters - run-time environment parameters
戻り値:: the result of the evaluation as a boolean value
例外:: SSOException - single-sign-on token invalid or expired; PolicyException - for any other abnormal condition

getPolicyDecision

public PolicyDecision getPolicyDecision(SSOToken token,
                                        String resourceName,
                                        Set actionNames,
                                        Map envParameters)
                                 throws SSOException,
                                        PolicyException

Evaluates privileges of the user to perform the specified actions on the specified resource. The evaluation depends on user's application environment parameters.

パラメータ:: token - single sign on token of the user evaluating policies; resourceName - name of the resource the user is trying to access; actionNames - Set of names(String) of the action the user is trying to perform on the resource; envParameters - Map of run-time environment parameters
戻り値:: policy decision
例外:: SSOException - single-sign-on token invalid or expired; PolicyException - for any other abnormal condition

getProtectedResourcesIgnoreConditions

public Set getProtectedResourcesIgnoreConditions(SSOToken token,
                                                 String rootResource)
                                          throws SSOException,
                                                 PolicyException

Gets protected resources for a user identified by single sign on token Conditions defined in the policies are ignored while computing protected resources. Only resources that are sub resources of the given rootResource or equal to the given rootResource would be returned. If all policies applicable to a resource are only referral policies, no ProtectedResource would be returned for such a resource.

パラメータ:: token - single sign on token of the user; rootResource - only resources that are sub resources of the given rootResource or equal to the given rootResource would be returned rootResource would be returned. If PolicyEvaluator.ALL_RESOURCES is passed as rootResource, resources under all root resources of the service type are considered while computing protected resources.
戻り値:: Set of protected resources. The set contains ProtectedResource objects.
例外:: SSOException - if single sign on token is invalid; PolicyException - for any other abnormal condition
関連項目:: ProtectedResource

getResourceResults

public Set getResourceResults(SSOToken token,
                              String resourceName,
                              String scope,
                              Map envParameters)
                       throws SSOException,
                              PolicyException

Gets resource result objects given a resource name. The set contains ResourceResult objects for all resources that would affect policy decisions for any resource associated with the argument resource name. To determine whether to include the ResourceResult of a resource, we compare argument resource name and policy resource name, treating wild characters in the policy resource name as wild. If the comparison resulted in EXACT_MATCH, WILD_CARD_MACTH or SUB_RESOURCE_MACTH, the resource result would be included.

パラメータ:

token - single sign on token of the user evaluating policies

resourceName - name of the resource

scope - indicates whether to compute the resource result based on the policy decision for only the resourceName or all the resources associated with the resource name. The valid scope values are:

ResourceResult.SUBTREE_SCOPE
ResourceResult.STRICT_SUBTREE_SCOPE
ResourceResult.SELF_SCOPE

getResourceResult

public ResourceResult getResourceResult(SSOToken token,
                                        String resourceName,
                                        String scope,
                                        Map envParameters)
                                 throws SSOException,
                                        PolicyException

推奨されていません。 Use getResourceResults()

Gets resource result given a resource name. ResourceResult is a tree representation of policy decisions for all resources rooted at the resource name. To determine whether a resource defined in the policy is a sub resource of argument resource name, argument resource name and policy resource name are compared, treating wild characters as literals. If comparison resulted in EXACT_MACTH or SUB_RESOURCE_MACTH, the resource would be included

パラメータ:

token - single sign on token of the user evaluating policies

resourceName - name of the resource

scope - indicates whether to compute the resource result based on the policy decision for only the resourceName or all the resources associated with the resource name. The valid scope values are:

ResourceResult.SUBTREE_SCOPE
ResourceResult.STRICT_SUBTREE_SCOPE
ResourceResult.SELF_SCOPE

If the scope is ResourceResult.SUBTREE_SCOPE or ResourceResult.STRICT_SUBTREE_SCOPE, the method will return a ResourceResult object that contains the policy decisions regarding the resourceName and its sub resources. If the scope is ResourceResult.SELF_SCOPE, the method will return a ResourceResult object that contains the policy decision regarding the resourceName only. Note, scope values ResourceResult.SUBTREE_SCOPE and ResourceResult.STRICT_SUBTREE_SCOPE are being treated as the same for backword compatibility reasons. This method is being deprecated. The method getResourceResults() should be used instead.

envParameters - run-time environment parameters

戻り値:

ResourceResult.

例外:

SSOException - if token is invalid

PolicyException - for any other abnormal condition

addPolicyListener

public void addPolicyListener(PolicyListener policyListener)

Adds a policy listener that would be notified whenever a policy is added, removed or changed

パラメータ:: policyListener - the listener to be added

removePolicyListener

public void removePolicyListener(PolicyListener policyListener)

Removes a policy listener that was previously registered to receive notifications whenever a policy is added, removed or changed. It is not an error to attempt to remove a listener that was not registered. It would return silently.