org.jboss.security.xacml.bridge
Class WrapperPolicyFinderModule

java.lang.Object
  extended by org.jboss.security.xacml.sunxacml.finder.PolicyFinderModule
      extended by org.jboss.security.xacml.bridge.WrapperPolicyFinderModule

public class WrapperPolicyFinderModule
extends PolicyFinderModule

PolicyFinderModule that returns the enclosing Policy Object

Since:
Jul 6, 2007
Version:
$Revision$
Author:
Anil.Saldhana@redhat.com

Field Summary
protected  PolicyFinder policyFinder
           
 
Constructor Summary
WrapperPolicyFinderModule(Policy policy)
           
 
Method Summary
 PolicyFinderResult findPolicy(EvaluationCtx evaluationCtx)
          Tries to find one and only one matching policy given the request represented by the context data.
 PolicyFinderResult findPolicy(URI arg0, int arg1, VersionConstraints arg2, PolicyMetaData arg3)
          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 policyFinder)
          Initializes this module for use by the given finder.
 boolean isRequestSupported()
          Returns true if the module supports finding policies based on a request (ie, target matching).
 
Methods inherited from class org.jboss.security.xacml.sunxacml.finder.PolicyFinderModule
getIdentifier, invalidateCache, isIdReferenceSupported
 
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

WrapperPolicyFinderModule

public WrapperPolicyFinderModule(Policy policy)
Method Detail

init

public void init(PolicyFinder policyFinder)
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:
policyFinder - the PolicyFinder using this module
See Also:
PolicyFinderModule#init(com.sun.xacml.finder.PolicyFinder)

findPolicy

public PolicyFinderResult findPolicy(EvaluationCtx evaluationCtx)
Description copied from class: PolicyFinderModule
Tries to find one and only one matching policy given the request represented by the context data. 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:
evaluationCtx - the representation of the request
Returns:
the result of looking for a matching policy
See Also:
PolicyFinderModule#findPolicy(com.sun.xacml.EvaluationCtx)

findPolicy

public PolicyFinderResult findPolicy(URI arg0,
                                     int arg1,
                                     VersionConstraints arg2,
                                     PolicyMetaData arg3)
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:
arg0 - an identifier specifying some policy
arg1 - type of reference (policy or policySet) as identified by the fields in PolicyReference
arg2 - 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)
arg3 - the meta-data from the parent policy, which provides XACML version, factories, etc.
Returns:
the result of looking for a matching policy
See Also:
PolicyFinderModule#findPolicy(java.net.URI, int, com.sun.xacml.VersionConstraints, com.sun.xacml.PolicyMetaData)

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
See Also:
PolicyFinderModule.isRequestSupported()


Copyright © 2009 JBoss, a division of Red Hat, Inc.. All Rights Reserved.