|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPolicyRule
Interface for a policy rule.
Field Summary | |
---|---|
static java.lang.String |
PROP_ENABLE
|
static java.lang.String |
PROP_IMPLNAME
|
static java.lang.String |
PROP_PREDICATE
|
Method Summary | |
---|---|
PolicyResult |
apply(IRequest req)
Applies the policy on the given Request. |
java.util.Vector |
getDefaultParams()
Return default parameters for a policy implementation. |
java.lang.String |
getDescription()
Gets the description for this policy rule. |
java.lang.String |
getInstanceName()
Returns the name of the policy rule instance. |
java.util.Vector |
getInstanceParams()
Return configured parameters for a policy rule instance. |
java.lang.String |
getName()
Returns the name of the policy rule class. |
IExpression |
getPredicate()
Returns the predicate expression for the rule. |
void |
init(ISubsystem owner,
IConfigStore config)
Initializes the policy rule. |
void |
setError(IRequest req,
java.lang.String format,
java.lang.Object[] params)
|
void |
setInstanceName(java.lang.String instanceName)
|
void |
setPolicyException(IRequest req,
EBaseException ex)
|
void |
setPredicate(IExpression exp)
Sets a predicate expression for rule matching. |
Field Detail |
---|
static final java.lang.String PROP_ENABLE
static final java.lang.String PROP_PREDICATE
static final java.lang.String PROP_IMPLNAME
Method Detail |
---|
void init(ISubsystem owner, IConfigStore config) throws EBaseException
config
- The config store reference
EBaseException
java.lang.String getDescription()
java.lang.String getName()
java.lang.String getInstanceName()
void setPredicate(IExpression exp)
exp
- The predicate expression for the rule.IExpression getPredicate()
PolicyResult apply(IRequest req)
apply
in interface IPolicy
req
- The request on which to apply policy.
java.util.Vector getInstanceParams()
java.util.Vector getDefaultParams()
void setError(IRequest req, java.lang.String format, java.lang.Object[] params)
void setInstanceName(java.lang.String instanceName)
void setPolicyException(IRequest req, EBaseException ex)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |