diff options
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.java | 100 |
1 files changed, 49 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 09f2415a1..11927a03f 100644 --- a/pki/base/common/src/com/netscape/certsrv/policy/IPolicyProcessor.java +++ b/pki/base/common/src/com/netscape/certsrv/policy/IPolicyProcessor.java @@ -17,7 +17,6 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.policy; - import java.util.Enumeration; import java.util.Hashtable; import java.util.Vector; @@ -25,22 +24,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. * <P> + * * <PRE> * NOTE: The Policy Framework has been replaced by the Profile Framework. * </PRE> * <P> - * + * * @deprecated * @version $Revision$, $Date$ */ @@ -61,42 +60,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. + * about policy implementations. Currently only the + * the implementation id is expected. */ Enumeration<String> getPolicyImplsInfo(); /** * Returns the rule implementations registered with this processor. - * - * @return An Enumeration of uninitialized IPolicyRule - * objects. + * + * @return An Enumeration of uninitialized IPolicyRule + * objects. */ Enumeration<IPolicyRule> 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. + * Returns configuration for an implmentation. + * + * @param id The implementation id. * @return A vector of name/value pairs in the form of - * name=value. + * name=value. */ Vector<String> getPolicyImplConfig(String id); @@ -104,53 +103,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; + 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; + 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<String> getPolicyInstancesInfo(); /** * Returns policy instances registered with this processor. - * + * * @return An Enumeration of policy instances. */ - Enumeration<IPolicyRule> getPolicyInstances(); + Enumeration<IPolicyRule> getPolicyInstances(); /** * Returns instance configuration for a given instance id. - * - * @param id The rule id. + * + * @param id The rule id. * @return A vector of name/value pairs in the form of - * name=value. + * name=value. */ - Vector<String> getPolicyInstanceConfig(String id); + Vector<String> 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); @@ -158,41 +157,40 @@ 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; + 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<String, String> ht) - throws EBaseException; + 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<String, String> ht) - throws EBaseException; + throws EBaseException; /** * Modifies policy ordering. - * + * * @param policyOrderStr The comma separated list of instance ids. - * + * */ void changePolicyInstanceOrdering(String policyOrderStr) - throws EBaseException; + throws EBaseException; } - |