com.netscape.certsrv.policy
Interface IPolicyProcessor

All Superinterfaces:
IPolicy, ISubsystem

Deprecated.

public interface IPolicyProcessor
extends ISubsystem, IPolicy

A generic interface for a policy processor. By making a processor extend the policy interface, we make even the processor a rule - which makes sense because a processor may be based on some rule such as evaluate all policies before returning the final result or return as soon as one of the policies return a failure and so on. By making both processor and policy rules implement a common interface, one can write rules that are processors as well.

 NOTE:  The Policy Framework has been replaced by the Profile Framework.
 

Version:
$Revision: 1226 $, $Date: 2010-08-19 14:16:41 -0700 (Thu, 19 Aug 2010) $

Field Summary
static java.lang.String PROP_CLASS
          Deprecated.  
static java.lang.String PROP_DEF_POLICIES
          Deprecated.  
static java.lang.String PROP_ENABLE
          Deprecated.  
static java.lang.String PROP_IMPL
          Deprecated.  
static java.lang.String PROP_IMPL_NAME
          Deprecated.  
static java.lang.String PROP_ORDER
          Deprecated.  
static java.lang.String PROP_PREDICATE
          Deprecated.  
static java.lang.String PROP_RULE
          Deprecated.  
static java.lang.String PROP_UNDELETABLE_POLICIES
          Deprecated.  
 
Method Summary
 void addPolicyImpl(java.lang.String id, java.lang.String classPath)
          Deprecated. Adds a policy implementation identified by an impl id.
 void addPolicyInstance(java.lang.String id, java.util.Hashtable ht)
          Deprecated. Adds a policy instance
 void changePolicyInstanceOrdering(java.lang.String policyOrderStr)
          Deprecated. Modifies policy ordering.
 void deletePolicyImpl(java.lang.String id)
          Deprecated. Deletes a policy implementation identified by an impl id.
 void deletePolicyInstance(java.lang.String id)
          Deprecated. Deletes a policy instance identified by an instance id.
 ISubsystem getAuthority()
          Deprecated.  
 IPolicyRule getPolicyImpl(java.lang.String id)
          Deprecated. Returns an implementation identified by a given id.
 java.util.Vector getPolicyImplConfig(java.lang.String id)
          Deprecated. Returns configuration for an implmentation.
 java.util.Enumeration getPolicyImpls()
          Deprecated. Returns the rule implementations registered with this processor.
 java.util.Enumeration getPolicyImplsInfo()
          Deprecated. Returns information on Policy impls.
 IPolicyRule getPolicyInstance(java.lang.String id)
          Deprecated. Returns instance configuration for a given instance id.
 java.util.Vector getPolicyInstanceConfig(java.lang.String id)
          Deprecated. Returns instance configuration for a given instance id.
 java.util.Enumeration getPolicyInstances()
          Deprecated. Returns policy instances registered with this processor.
 java.util.Enumeration getPolicyInstancesInfo()
          Deprecated. Returns information on Policy instances.
 java.lang.String getPolicySubstoreId()
          Deprecated. Returns the policy substore id.
 void modifyPolicyInstance(java.lang.String id, java.util.Hashtable ht)
          Deprecated. Modifies a policy instance
 
Methods inherited from interface com.netscape.certsrv.base.ISubsystem
getConfigStore, getId, init, setId, shutdown, startup
 
Methods inherited from interface com.netscape.certsrv.request.IPolicy
apply
 

Field Detail

PROP_DEF_POLICIES

static final java.lang.String PROP_DEF_POLICIES
Deprecated. 
See Also:
Constant Field Values

PROP_UNDELETABLE_POLICIES

static final java.lang.String PROP_UNDELETABLE_POLICIES
Deprecated. 
See Also:
Constant Field Values

PROP_ENABLE

static final java.lang.String PROP_ENABLE
Deprecated. 
See Also:
Constant Field Values

PROP_RULE

static final java.lang.String PROP_RULE
Deprecated. 
See Also:
Constant Field Values

PROP_CLASS

static final java.lang.String PROP_CLASS
Deprecated. 
See Also:
Constant Field Values

PROP_IMPL_NAME

static final java.lang.String PROP_IMPL_NAME
Deprecated. 
See Also:
Constant Field Values

PROP_PREDICATE

static final java.lang.String PROP_PREDICATE
Deprecated. 
See Also:
Constant Field Values

PROP_IMPL

static final java.lang.String PROP_IMPL
Deprecated. 
See Also:
Constant Field Values

PROP_ORDER

static final java.lang.String PROP_ORDER
Deprecated. 
See Also:
Constant Field Values
Method Detail

getAuthority

ISubsystem getAuthority()
Deprecated. 

getPolicySubstoreId

java.lang.String getPolicySubstoreId()
Deprecated. 
Returns the policy substore id.

Returns:
storeID The policy store id used by this processor.

getPolicyImplsInfo

java.util.Enumeration getPolicyImplsInfo()
Deprecated. 
Returns information on Policy impls.

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

getPolicyImpls

java.util.Enumeration getPolicyImpls()
Deprecated. 
Returns the rule implementations registered with this processor.

Returns:
An Enumeration of uninitialized IPolicyRule objects.

getPolicyImpl

IPolicyRule getPolicyImpl(java.lang.String id)
Deprecated. 
Returns an implementation identified by a given id.

Parameters:
id - The implementation id.
Returns:
The uninitialized instance of the policy rule.

getPolicyImplConfig

java.util.Vector getPolicyImplConfig(java.lang.String id)
Deprecated. 
Returns configuration for an implmentation.

Parameters:
id - The implementation id.
Returns:
A vector of name/value pairs in the form of name=value.

deletePolicyImpl

void deletePolicyImpl(java.lang.String id)
                      throws EBaseException
Deprecated. 
Deletes a policy implementation identified by an impl id.

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

void addPolicyImpl(java.lang.String id,
                   java.lang.String classPath)
                   throws EBaseException
Deprecated. 
Adds a policy implementation identified by an impl id.

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.

getPolicyInstancesInfo

java.util.Enumeration getPolicyInstancesInfo()
Deprecated. 
Returns information on Policy instances.

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

getPolicyInstances

java.util.Enumeration getPolicyInstances()
Deprecated. 
Returns policy instances registered with this processor.

Returns:
An Enumeration of policy instances.

getPolicyInstanceConfig

java.util.Vector getPolicyInstanceConfig(java.lang.String id)
Deprecated. 
Returns instance configuration for a given instance id.

Parameters:
id - The rule id.
Returns:
A vector of name/value pairs in the form of name=value.

getPolicyInstance

IPolicyRule getPolicyInstance(java.lang.String id)
Deprecated. 
Returns instance configuration for a given instance id.

Parameters:
id - The rule id.
Returns:
the policy instance identified by the id.

deletePolicyInstance

void deletePolicyInstance(java.lang.String id)
                          throws EBaseException
Deprecated. 
Deletes a policy instance identified by an instance id.

Parameters:
id - The instance id of the policy to be deleted.
Throws:
EBaseException - is thrown if an error occurs in deletion.

addPolicyInstance

void addPolicyInstance(java.lang.String id,
                       java.util.Hashtable ht)
                       throws EBaseException
Deprecated. 
Adds a policy instance

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

void modifyPolicyInstance(java.lang.String id,
                          java.util.Hashtable ht)
                          throws EBaseException
Deprecated. 
Modifies a policy instance

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

void changePolicyInstanceOrdering(java.lang.String policyOrderStr)
                                  throws EBaseException
Deprecated. 
Modifies policy ordering.

Parameters:
policyOrderStr - The comma separated list of instance ids.
Throws:
EBaseException