All Packages Class Hierarchy This Package Previous Next Index
Interface com.netscape.certsrv.policy.IPolicyRule
- public interface IPolicyRule
Interface for a policy rule.
-
PROP_ENABLE
-
-
PROP_IMPLNAME
-
-
PROP_PREDICATE
-
-
apply(IRequest)
- Applies the policy on the given Request.
-
getDefaultParams()
- Return default parameters for a policy implementation.
-
getDescription()
- Gets the description for this policy rule.
-
getInstanceName()
- Returns the name of the policy rule instance.
-
getInstanceParams()
- Return configured parameters for a policy rule instance.
-
getName()
- Returns the name of the policy rule class.
-
getPredicate()
- Returns the predicate expression for the rule.
-
init(ISubsystem, IConfigStore)
- Initializes the policy rule.
-
setPredicate(IExpression)
- Sets a predicate expression for rule matching.
PROP_ENABLE
public static final String PROP_ENABLE
PROP_PREDICATE
public static final String PROP_PREDICATE
PROP_IMPLNAME
public static final String PROP_IMPLNAME
init
public abstract void init(ISubsystem owner,
IConfigStore config) throws EBaseException
- Initializes the policy rule.
- Parameters:
- config - The config store reference
getDescription
public abstract String getDescription()
- Gets the description for this policy rule.
- Returns:
- The Description for this rule.
getName
public abstract String getName()
- Returns the name of the policy rule class.
- Returns:
- The name of the policy class.
getInstanceName
public abstract String getInstanceName()
- Returns the name of the policy rule instance.
- Returns:
- The name of the policy rule instance. If none
is set the name of the implementation will be returned.
setPredicate
public abstract void setPredicate(IExpression exp)
- Sets a predicate expression for rule matching.
- Parameters:
- exp - The predicate expression for the rule.
getPredicate
public abstract IExpression getPredicate()
- Returns the predicate expression for the rule.
- Returns:
- The predicate expression for the rule.
apply
public abstract PolicyResult apply(IRequest req)
- Applies the policy on the given Request. This may modify
the request appropriately.
- Parameters:
- req - The request on which to apply policy.
- Returns:
- The PolicyResult object.
getInstanceParams
public abstract Vector getInstanceParams()
- Return configured parameters for a policy rule instance.
- Returns:
- nvPairs A Vector of name/value pairs. Each name/value
pair is constructed as a String in name=value format.
getDefaultParams
public abstract Vector getDefaultParams()
- Return default parameters for a policy implementation.
- Returns:
- nvPairs A Vector of name/value pairs. Each name/value
pair is constructed as a String in name=value.
All Packages Class Hierarchy This Package Previous Next Index