Class GenericPolicyProcessor

java.lang.Object

org.dogtagpki.legacy.policy.PolicyProcessor

org.dogtagpki.legacy.core.policy.GenericPolicyProcessor

public class GenericPolicyProcessor
extends PolicyProcessor

This is a Generic policy processor. The three main functions of this class are: 1. To initialize policies by reading policy configuration from the config file, and maintain 5 sets of policies - viz Enrollment, Renewal, Revocation and KeyRecovery and KeyArchival. 2. To apply the configured policies on the given request. 3. To enable policy listing/configuration via MCC console. Since the policy processor also implements the IPolicy interface the processor itself presents itself as one big policy to the request processor.

Version:

$Revision$, $Date$

Author:

kanda

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	DEF_POLICIES
static final Hashtable<String, IExpression>	DEF_UNDELETABLE_POLICIES
protected CMSEngine	engine
static org.slf4j.Logger	logger
protected IAuthority	mAuthority
protected ConfigStore	mConfig
protected EngineConfig	mGlobalStore

Fields inherited from class PolicyProcessor

PROP_CLASS, PROP_DEF_POLICIES, PROP_ENABLE, PROP_IMPL, PROP_IMPL_NAME, PROP_ORDER, PROP_PREDICATE, PROP_RULE, PROP_UNDELETABLE_POLICIES

Constructor Summary

Constructors

Constructor	Description
GenericPolicyProcessor()
GenericPolicyProcessor(boolean initSystemPolicies)

Method Summary

Modifier and Type	Method	Description
void	addPolicyImpl(String id, String classPath)	Adds a policy implementation identified by an impl id.
void	addPolicyInstance(String id, Hashtable<String,String> ht)	Adds a policy instance
PolicyResult	apply(Request request)	Apply policies on the given request.
void	changePolicyInstanceOrdering(String policyOrderStr)	Modifies policy ordering.
void	deletePolicyImpl(String id)	Deletes a policy implementation identified by an impl id.
void	deletePolicyInstance(String id)	Deletes a policy instance identified by an instance id.
IAuthority	getAuthority()
CMSEngine	getCMSEngine()
ConfigStore	getConfigStore()	Returns the configuration store.
String	getId()
PolicyRule	getPolicyImpl(String id)	Returns an implementation identified by a given id.
Vector<String>	getPolicyImplConfig(String id)	Returns configuration for an implmentation.
Enumeration<PolicyRule>	getPolicyImpls()	Returns the rule implementations registered with this processor.
Enumeration<String>	getPolicyImplsInfo()	Returns information on Policy impls.
PolicyRule	getPolicyInstance(String id)	Returns instance configuration for a given instance id.
Vector<String>	getPolicyInstanceConfig(String id)	Returns instance configuration for a given instance id.
Enumeration<PolicyRule>	getPolicyInstances()	Returns policy instances registered with this processor.
Enumeration<String>	getPolicyInstancesInfo()	Returns information on Policy instances.
String	getPolicySubstoreId()	Returns the policy substore id.
void	init(IAuthority owner, ConfigStore config)	Initializes the PolicyProcessor
boolean	isProfileRequest(Request request)
void	modifyPolicyInstance(String id, Hashtable<String,String> ht)	Modifies a policy instance
void	printPolicies()
void	setCMSEngine(CMSEngine engine)
void	setId(String id)
void	shutdown()	Shuts down this subsystem.
void	startup()

Methods inherited from class Object

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

Field Details

logger

public static org.slf4j.Logger logger

engine

protected CMSEngine engine

mConfig

protected ConfigStore mConfig

mGlobalStore

protected EngineConfig mGlobalStore

mAuthority

protected IAuthority mAuthority

DEF_POLICIES

public static final String[] DEF_POLICIES

DEF_UNDELETABLE_POLICIES

public static final Hashtable<String, IExpression> DEF_UNDELETABLE_POLICIES

Constructor Details

GenericPolicyProcessor

public GenericPolicyProcessor()

GenericPolicyProcessor

public GenericPolicyProcessor(boolean initSystemPolicies)

Method Details

getCMSEngine

public CMSEngine getCMSEngine()

setCMSEngine

public void setCMSEngine(CMSEngine engine)

setId

public void setId(String id)
           throws EBaseException

Throws:

EBaseException

getId

public String getId()

startup

public void startup()
             throws EBaseException

Throws:

EBaseException

shutdown

public void shutdown()

Shuts down this subsystem.

getAuthority

public IAuthority getAuthority()

Specified by:

getAuthority in class PolicyProcessor

getConfigStore

public ConfigStore getConfigStore()

Returns the configuration store.

Returns:

configuration store

init

public void init(IAuthority owner,
 ConfigStore config)
          throws EBaseException

Initializes the PolicyProcessor

Parameters:

owner - owner of this subsystem

config - configuration of this subsystem

Throws:

EBaseException - failed to initialize this Subsystem.

isProfileRequest

public boolean isProfileRequest(Request request)

apply

public PolicyResult apply(Request request)

Apply policies on the given request.

Parameters:

request - The given request

Returns:

The policy result object.

printPolicies

public void printPolicies()

getPolicySubstoreId

public String getPolicySubstoreId()

Description copied from class: PolicyProcessor

Returns the policy substore id.

Specified by:

getPolicySubstoreId in class PolicyProcessor

Returns:

storeID The policy store id used by this processor.

getPolicyImpls

public Enumeration<PolicyRule> getPolicyImpls()

Description copied from class: PolicyProcessor

Returns the rule implementations registered with this processor.

Specified by:

getPolicyImpls in class PolicyProcessor

Returns:

An Enumeration of uninitialized IPolicyRule objects.

getPolicyImplsInfo

public Enumeration<String> getPolicyImplsInfo()

Description copied from class: PolicyProcessor

Returns information on Policy impls.

Specified by:

getPolicyImplsInfo in class PolicyProcessor

Returns:

An enumeration of strings describing the information about policy implementations. Currently only the the implementation id is expected.

getPolicyImpl

public PolicyRule getPolicyImpl(String id)

Description copied from class: PolicyProcessor

Returns an implementation identified by a given id.

Specified by:

getPolicyImpl in class PolicyProcessor

Parameters:

id - The implementation id.

Returns:

The uninitialized instance of the policy rule.

getPolicyImplConfig

public Vector<String> getPolicyImplConfig(String id)

Description copied from class: PolicyProcessor

Returns configuration for an implmentation.

Specified by:

getPolicyImplConfig in class PolicyProcessor

Parameters:

id - The implementation id.

Returns:

A vector of name/value pairs in the form of name=value.

deletePolicyImpl

public void deletePolicyImpl(String id)
                      throws EBaseException

Description copied from class: PolicyProcessor

Deletes a policy implementation identified by an impl id.

Specified by:

deletePolicyImpl in class PolicyProcessor

Parameters:

id - The impl id of the policy to be deleted. There shouldn't be any active instance for this implementation.

Throws:

EBaseException - is thrown if an error occurs in deletion.

addPolicyImpl

public void addPolicyImpl(String id,
 String classPath)
                   throws EBaseException

Description copied from class: PolicyProcessor

Adds a policy implementation identified by an impl id.

Specified by:

addPolicyImpl in class PolicyProcessor

Parameters:

id - The impl id of the policy to be added. The id should be unique.

classPath - The fully qualified path for the implementation.

Throws:

EBaseException - is thrown if an error occurs in addition.

getPolicyInstances

public Enumeration<PolicyRule> getPolicyInstances()

Description copied from class: PolicyProcessor

Returns policy instances registered with this processor.

Specified by:

getPolicyInstances in class PolicyProcessor

Returns:

An Enumeration of policy instances.

getPolicyInstancesInfo

public Enumeration<String> getPolicyInstancesInfo()

Description copied from class: PolicyProcessor

Returns information on Policy instances.

Specified by:

getPolicyInstancesInfo in class PolicyProcessor

Returns:

An Enumeration of Strings describing the information about policy rule instances.

getPolicyInstance

public PolicyRule getPolicyInstance(String id)

Description copied from class: PolicyProcessor

Returns instance configuration for a given instance id.

Specified by:

getPolicyInstance in class PolicyProcessor

Parameters:

id - The rule id.

Returns:

the policy instance identified by the id.

getPolicyInstanceConfig

public Vector<String> getPolicyInstanceConfig(String id)

Description copied from class: PolicyProcessor

Returns instance configuration for a given instance id.

Specified by:

getPolicyInstanceConfig in class PolicyProcessor

Parameters:

id - The rule id.

Returns:

A vector of name/value pairs in the form of name=value.

deletePolicyInstance

public void deletePolicyInstance(String id)
                          throws EBaseException

Description copied from class: PolicyProcessor

Deletes a policy instance identified by an instance id.

Specified by:

deletePolicyInstance in class PolicyProcessor

Parameters:

id - The instance id of the policy to be deleted.

Throws:

EBaseException - is thrown if an error occurs in deletion.

addPolicyInstance

public void addPolicyInstance(String id,
 Hashtable<String,String> ht)
                       throws EBaseException

Description copied from class: PolicyProcessor

Adds a policy instance

Specified by:

addPolicyInstance in class PolicyProcessor

Parameters:

id - The impl id of the policy to be added. The id should be unique.

ht - a Hashtable of config params.

Throws:

EBaseException - is thrown if an error occurs in addition.

modifyPolicyInstance

public void modifyPolicyInstance(String id,
 Hashtable<String,String> ht)
                          throws EBaseException

Description copied from class: PolicyProcessor

Modifies a policy instance

Specified by:

modifyPolicyInstance in class PolicyProcessor

Parameters:

id - The impl id of the policy to be modified. The policy instance with this id should be present.

ht - a Hashtable of config params.

Throws:

EBaseException - is thrown if an error occurs in addition.

changePolicyInstanceOrdering

public void changePolicyInstanceOrdering(String policyOrderStr)
                                  throws EBaseException

Description copied from class: PolicyProcessor

Modifies policy ordering.

Specified by:

changePolicyInstanceOrdering in class PolicyProcessor

Parameters:

policyOrderStr - The comma separated list of instance ids.

Throws:

EBaseException