summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/certsrv/policy/IPolicyProcessor.java
diff options
context:
space:
mode:
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/policy/IPolicyProcessor.java')
-rw-r--r--pki/base/common/src/com/netscape/certsrv/policy/IPolicyProcessor.java115
1 files changed, 64 insertions, 51 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/policy/IPolicyProcessor.java b/pki/base/common/src/com/netscape/certsrv/policy/IPolicyProcessor.java
index 5e2d297f9..834d462e0 100644
--- a/pki/base/common/src/com/netscape/certsrv/policy/IPolicyProcessor.java
+++ b/pki/base/common/src/com/netscape/certsrv/policy/IPolicyProcessor.java
@@ -17,6 +17,7 @@
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.policy;
+
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Vector;
@@ -24,22 +25,22 @@ import java.util.Vector;
import com.netscape.certsrv.base.EBaseException;
import com.netscape.certsrv.base.ISubsystem;
+
/**
- * 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.
+ * 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.
* <P>
- *
* <PRE>
* NOTE: The Policy Framework has been replaced by the Profile Framework.
* </PRE>
* <P>
- *
+ *
* @deprecated
* @version $Revision$, $Date$
*/
@@ -60,40 +61,42 @@ public interface IPolicyProcessor extends ISubsystem,
/**
* Returns the policy substore id.
- *
- * @return storeID The policy store id used by this processor.
+ *
+ * @return storeID The policy store id used by this processor.
*/
String getPolicySubstoreId();
/**
* Returns information on Policy impls.
- *
- * @return An enumeration of strings describing the information about policy
- * implementations. Currently only the the implementation id is
- * expected.
+ *
+ * @return An enumeration of strings describing the information
+ * about policy implementations. Currently only the
+ * the implementation id is expected.
*/
Enumeration getPolicyImplsInfo();
/**
* Returns the rule implementations registered with this processor.
- *
- * @return An Enumeration of uninitialized IPolicyRule objects.
+ *
+ * @return An Enumeration of uninitialized IPolicyRule
+ * objects.
*/
Enumeration getPolicyImpls();
/**
* Returns an implementation identified by a given id.
- *
- * @param id The implementation id.
+ *
+ * @param id The implementation id.
* @return The uninitialized instance of the policy rule.
*/
IPolicyRule getPolicyImpl(String id);
/**
- * Returns configuration for an implmentation.
- *
- * @param id The implementation id.
- * @return A vector of name/value pairs in the form of name=value.
+ * Returns configuration for an implmentation.
+ *
+ * @param id The implementation id.
+ * @return A vector of name/value pairs in the form of
+ * name=value.
*/
Vector getPolicyImplConfig(String id);
@@ -101,48 +104,53 @@ public interface IPolicyProcessor extends ISubsystem,
* Deletes a policy implementation identified by an impl id.
*
*
- * @param id The impl id of the policy to be deleted. There shouldn't be any
- * active instance for this implementation.
+ * @param id The impl id of the policy to be deleted.
+ * There shouldn't be any active instance for this
+ * implementation.
* @exception EBaseException is thrown if an error occurs in deletion.
*/
- void deletePolicyImpl(String id) throws EBaseException;
+ void deletePolicyImpl(String id)
+ throws EBaseException;
/**
* Adds a policy implementation identified by an impl id.
*
- * @param id The impl id of the policy to be added. The id should be unique.
- * @param classPath The fully qualified path for the implementation.
+ * @param id The impl id of the policy to be added.
+ * The id should be unique.
+ * @param classPath The fully qualified path for the implementation.
* @exception EBaseException is thrown if an error occurs in addition.
*/
- void addPolicyImpl(String id, String classPath) throws EBaseException;
+ void addPolicyImpl(String id, String classPath)
+ throws EBaseException;
/**
* Returns information on Policy instances.
- *
- * @return An Enumeration of Strings describing the information about policy
- * rule instances.
+ *
+ * @return An Enumeration of Strings describing the information
+ * about policy rule instances.
*/
Enumeration getPolicyInstancesInfo();
/**
* Returns policy instances registered with this processor.
- *
+ *
* @return An Enumeration of policy instances.
*/
Enumeration getPolicyInstances();
/**
* Returns instance configuration for a given instance id.
- *
- * @param id The rule id.
- * @return A vector of name/value pairs in the form of name=value.
+ *
+ * @param id The rule id.
+ * @return A vector of name/value pairs in the form of
+ * name=value.
*/
Vector getPolicyInstanceConfig(String id);
/**
* Returns instance configuration for a given instance id.
- *
- * @param id The rule id.
+ *
+ * @param id The rule id.
* @return the policy instance identified by the id.
*/
IPolicyRule getPolicyInstance(String id);
@@ -150,36 +158,41 @@ public interface IPolicyProcessor extends ISubsystem,
/**
* Deletes a policy instance identified by an instance id.
*
- * @param id The instance id of the policy to be deleted.
+ * @param id The instance id of the policy to be deleted.
* @exception EBaseException is thrown if an error occurs in deletion.
*/
- void deletePolicyInstance(String id) throws EBaseException;
+ void deletePolicyInstance(String id)
+ throws EBaseException;
/**
- * Adds a policy instance
+ * Adds a policy instance
*
- * @param id The impl id of the policy to be added. The id should be unique.
+ * @param id The impl id of the policy to be added.
+ * The id should be unique.
* @param ht a Hashtable of config params.
* @exception EBaseException is thrown if an error occurs in addition.
*/
- void addPolicyInstance(String id, Hashtable ht) throws EBaseException;
+ void addPolicyInstance(String id, Hashtable ht)
+ throws EBaseException;
/**
- * Modifies a policy instance
+ * Modifies a policy instance
*
- * @param id The impl id of the policy to be modified. The policy instance
- * with this id should be present.
+ * @param id The impl id of the policy to be modified.
+ * The policy instance with this id should be present.
* @param ht a Hashtable of config params.
* @exception EBaseException is thrown if an error occurs in addition.
*/
- void modifyPolicyInstance(String id, Hashtable ht) throws EBaseException;
+ void modifyPolicyInstance(String id, Hashtable ht)
+ throws EBaseException;
/**
* Modifies policy ordering.
- *
+ *
* @param policyOrderStr The comma separated list of instance ids.
- *
+ *
*/
void changePolicyInstanceOrdering(String policyOrderStr)
- throws EBaseException;
+ throws EBaseException;
}
+