org.jboss.security.xacml.bridge

Class PolicySetFinderModule

java.lang.Object

org.jboss.security.xacml.sunxacml.finder.PolicyFinderModule

org.jboss.security.xacml.bridge.PolicySetFinderModule

Direct Known Subclasses:

PPSPolicySetFinderModule, RPSPolicySetFinderModule

public class PolicySetFinderModule
extends PolicyFinderModule

PolicyFinderModule for PolicySet

Since:

Jul 6, 2007

Version:

$Revision$

Author:

Anil.Saldhana@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
protected PolicyFinder	policyFinder

Constructor Summary

Constructors

Constructor and Description
PolicySetFinderModule()
PolicySetFinderModule(PolicySet policySet)
PolicySetFinderModule(PolicySet policySet, List<AbstractPolicy> policies)

Method Summary

Methods

Modifier and Type	Method and Description
PolicyFinderResult	findPolicy(EvaluationCtx context) Finds the applicable policy (if there is one) for the given context.
PolicyFinderResult	findPolicy(URI idReference, int type, VersionConstraints constraints, PolicyMetaData parentMetaData) Tries to find one and only one matching policy given the idReference If more than one policy is found, this is an error and must be reported as such.
void	init(PolicyFinder finder) Initializes this module for use by the given finder.
boolean	isIdReferenceSupported() Always returns true, since reference-based retrieval is supported.
boolean	isRequestSupported() Returns true if the module supports finding policies based on a request (ie, target matching).
void	set(PolicySet ps, List<AbstractPolicy> policies)

Methods inherited from class org.jboss.security.xacml.sunxacml.finder.PolicyFinderModule

getIdentifier, invalidateCache

Methods inherited from class java.lang.Object

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

Field Detail

policyFinder

protected PolicyFinder policyFinder

Constructor Detail

PolicySetFinderModule

public PolicySetFinderModule()

PolicySetFinderModule

public PolicySetFinderModule(PolicySet policySet)

PolicySetFinderModule

public PolicySetFinderModule(PolicySet policySet,
                     List<AbstractPolicy> policies)

Method Detail

init

public void init(PolicyFinder finder)

Description copied from class: PolicyFinderModule

Initializes this module for use by the given finder. Typically this is called when a PDP is initialized with a PDPConfig containing the given PolicyFinder. Because PolicyFinderModules usually need to parse policies, and this requires knowing their PolicyFinder, parsing is usually done at or after this point in the lifetime of this module. This might also be a good time to reset any internal caches or temporary data. Note that this method may be called more than once in the lifetime of a module.

Specified by:

init in class PolicyFinderModule

Parameters:

finder - the PolicyFinder using this module

findPolicy

public PolicyFinderResult findPolicy(EvaluationCtx context)

Finds the applicable policy (if there is one) for the given context.

Overrides:

findPolicy in class PolicyFinderModule

Parameters:

context - the evaluation context

Returns:

an applicable policy, if one exists, or an error

findPolicy

public PolicyFinderResult findPolicy(URI idReference,
                            int type,
                            VersionConstraints constraints,
                            PolicyMetaData parentMetaData)

Description copied from class: PolicyFinderModule

Tries to find one and only one matching policy given the idReference If more than one policy is found, this is an error and must be reported as such. If no policies are found, then an empty result must be returned. By default this method returns an empty result. This method should never return null.

Overrides:

findPolicy in class PolicyFinderModule

Parameters:

idReference - an identifier specifying some policy

type - type of reference (policy or policySet) as identified by the fields in PolicyReference

constraints - any optional constraints on the version of the referenced policy (this will never be null, but it may impose no constraints, and in fact will never impose constraints when used from a pre-2.0 XACML policy)

parentMetaData - the meta-data from the parent policy, which provides XACML version, factories, etc.

Returns:

the result of looking for a matching policy

isRequestSupported

public boolean isRequestSupported()

Description copied from class: PolicyFinderModule

Returns true if the module supports finding policies based on a request (ie, target matching). By default this method returns false.

Overrides:

isRequestSupported in class PolicyFinderModule

Returns:

true if request retrieval is supported

isIdReferenceSupported

public boolean isIdReferenceSupported()

Always returns true, since reference-based retrieval is supported.

Overrides:

isIdReferenceSupported in class PolicyFinderModule

Returns:

true

set

public void set(PolicySet ps,
       List<AbstractPolicy> policies)