Interface IPolicyRule

All Superinterfaces:
IPolicy
All Known Subinterfaces:
IEnrollmentPolicy, IRenewalPolicy, IRevocationPolicy
All Known Implementing Classes:
APolicyRule, ManualAuthentication

public interface IPolicyRule extends IPolicy
Interface for a policy rule.

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

Version:
$Revision$, $Date$
  • Field Details

  • Method Details

    • init

      void init(PolicyProcessor owner, ConfigStore config) throws EBaseException
      Initializes the policy rule.

      Parameters:
      config - The config store reference
      Throws:
      EBaseException
    • getDescription

      String getDescription()
      Gets the description for this policy rule.

      Returns:
      The Description for this rule.
    • getName

      String getName()
      Returns the name of the policy rule class.

      Returns:
      The name of the policy class.
    • getInstanceName

      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

      void setPredicate(IExpression exp)
      Sets a predicate expression for rule matching.

      Parameters:
      exp - The predicate expression for the rule.
    • getPredicate

      IExpression getPredicate()
      Returns the predicate expression for the rule.

      Returns:
      The predicate expression for the rule.
    • apply

      PolicyResult apply(Request req)
      Applies the policy on the given Request. This may modify the request appropriately.

      Specified by:
      apply in interface IPolicy
      Parameters:
      req - The request on which to apply policy.
      Returns:
      The PolicyResult object.
    • getInstanceParams

      Vector<String> 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

      Vector<String> 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.
    • setError

      void setError(Request req, String format, Object[] params)
    • setInstanceName

      void setInstanceName(String instanceName)
    • setPolicyException

      void setPolicyException(Request req, EBaseException ex)