Package org.dogtagpki.legacy.policy
Interface IPolicyRule
- All Superinterfaces:
IPolicy
- All Known Subinterfaces:
IEnrollmentPolicy
,IKeyArchivalPolicy
,IKeyRecoveryPolicy
,IRenewalPolicy
,IRevocationPolicy
- All Known Implementing Classes:
APolicyRule
,ManualAuthentication
Interface for a policy rule.
NOTE: The Policy Framework has been replaced by the Profile Framework.
- Version:
- $Revision$, $Date$
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionApplies the policy on the given Request.Return default parameters for a policy implementation.Gets the description for this policy rule.Returns the name of the policy rule instance.Return configured parameters for a policy rule instance.getName()
Returns the name of the policy rule class.Returns the predicate expression for the rule.void
init
(IPolicyProcessor owner, ConfigStore config) Initializes the policy rule.void
void
setInstanceName
(String instanceName) void
setPolicyException
(Request req, EBaseException ex) void
setPredicate
(IExpression exp) Sets a predicate expression for rule matching.
-
Field Details
-
PROP_ENABLE
- See Also:
-
PROP_PREDICATE
- See Also:
-
PROP_IMPLNAME
- See Also:
-
-
Method Details
-
init
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
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
Applies the policy on the given Request. This may modify the request appropriately. -
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
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
-
setInstanceName
-
setPolicyException
-