diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/policy/IPolicyRule.java')
-rw-r--r-- | pki/base/common/src/com/netscape/certsrv/policy/IPolicyRule.java | 51 |
1 files changed, 24 insertions, 27 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/policy/IPolicyRule.java b/pki/base/common/src/com/netscape/certsrv/policy/IPolicyRule.java index d80a0d0c..aa4dcde8 100644 --- a/pki/base/common/src/com/netscape/certsrv/policy/IPolicyRule.java +++ b/pki/base/common/src/com/netscape/certsrv/policy/IPolicyRule.java @@ -17,7 +17,6 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.policy; - import java.util.Vector; import com.netscape.certsrv.base.EBaseException; @@ -26,20 +25,19 @@ import com.netscape.certsrv.base.ISubsystem; import com.netscape.certsrv.request.IRequest; import com.netscape.certsrv.request.PolicyResult; - /** * Interface for a policy rule. * <P> + * * <PRE> * NOTE: The Policy Framework has been replaced by the Profile Framework. * </PRE> * <P> - * + * * @deprecated * @version $Revision$, $Date$ */ -public interface IPolicyRule - extends com.netscape.certsrv.request.IPolicy { +public interface IPolicyRule extends com.netscape.certsrv.request.IPolicy { public static final String PROP_ENABLE = "enable"; public static final String PROP_PREDICATE = "predicate"; public static final String PROP_IMPLNAME = "implName"; @@ -47,15 +45,15 @@ public interface IPolicyRule /** * Initializes the policy rule. * <P> - * + * * @param config The config store reference */ - void init(ISubsystem owner, IConfigStore config) - throws EBaseException; + void init(ISubsystem owner, IConfigStore config) throws EBaseException; /** * Gets the description for this policy rule. * <P> + * * @return The Description for this rule. */ String getDescription(); @@ -63,7 +61,7 @@ public interface IPolicyRule /** * Returns the name of the policy rule class. * <P> - * + * * @return The name of the policy class. */ String getName(); @@ -71,52 +69,52 @@ public interface IPolicyRule /** * Returns the name of the policy rule instance. * <P> - * - * @return The name of the policy rule instance. If none - * is set the name of the implementation will be returned. - * + * + * @return The name of the policy rule instance. If none is set the name of + * the implementation will be returned. + * */ String getInstanceName(); /** * Sets a predicate expression for rule matching. * <P> - * - * @param exp The predicate expression for the rule. + * + * @param exp The predicate expression for the rule. */ void setPredicate(IExpression exp); /** * Returns the predicate expression for the rule. * <P> - * + * * @return The predicate expression for the rule. */ IExpression getPredicate(); /** - * Applies the policy on the given Request. This may modify - * the request appropriately. + * Applies the policy on the given Request. This may modify the request + * appropriately. * <P> - * - * @param req The request on which to apply policy. + * + * @param req The request on which to apply policy. * @return The PolicyResult object. */ PolicyResult apply(IRequest req); /** * Return configured parameters for a policy rule instance. - * - * @return nvPairs A Vector of name/value pairs. Each name/value - * pair is constructed as a String in name=value format. + * + * @return nvPairs A Vector of name/value pairs. Each name/value pair is + * constructed as a String in name=value format. */ public Vector getInstanceParams(); /** * Return default parameters for a policy implementation. - * - * @return nvPairs A Vector of name/value pairs. Each name/value - * pair is constructed as a String in name=value. + * + * @return nvPairs A Vector of name/value pairs. Each name/value pair is + * constructed as a String in name=value. */ public Vector getDefaultParams(); @@ -126,4 +124,3 @@ public interface IPolicyRule public void setPolicyException(IRequest req, EBaseException ex); } - |