com.netscape.certsrv.policy
Interface IPolicyRule

All Superinterfaces:

IPolicy

All Known Subinterfaces:

IEnrollmentPolicy, IKeyArchivalPolicy, IKeyRecoveryPolicy, IRenewalPolicy, IRevocationPolicy

All Known Implementing Classes:

AgentPolicy, APolicyRule, AttributePresentConstraints, AuthInfoAccessExt, AuthorityKeyIdentifierExt, BasicConstraintsExt, CertificatePoliciesExt, CertificateRenewalWindowExt, CertificateScopeOfUseExt, CRLDistributionPointsExt, DefaultRevocation, DSAKeyConstraints, ExtendedKeyUsageExt, GenericASN1Ext, IssuerAltNameExt, IssuerConstraints, KeyAlgorithmConstraints, KeyUsageExt, ManualAuthentication, NameConstraintsExt, NSCCommentExt, NSCertTypeExt, OCSPNoCheckExt, PolicyConstraintsExt, PolicyMappingsExt, PresenceExt, PrivateKeyUsagePeriodExt, RemoveBasicConstraintsExt, RenewalConstraints, RenewalValidityConstraints, RevocationConstraints, RSAKeyConstraints, SigningAlgorithmConstraints, SubCANameConstraints, SubjAltNameExt, SubjectAltNameExt, SubjectDirectoryAttributesExt, SubjectKeyIdentifierExt, UniqueSubjectName, UniqueSubjectNameConstraints, ValidityConstraints

public interface IPolicyRule
extends IPolicy

Interface for a policy rule.

Version:

$Revision: 14561 $, $Date: 2007-05-01 10:28:56 -0700 (Tue, 01 May 2007) $

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

PROP_ENABLE

static final java.lang.String PROP_ENABLE

See Also:

Constant Field Values

PROP_PREDICATE

static final java.lang.String PROP_PREDICATE

See Also:

Constant Field Values

PROP_IMPLNAME

static final java.lang.String PROP_IMPLNAME

See Also:

Constant Field Values

Method Detail

init

void init(ISubsystem owner,
          IConfigStore config)
          throws EBaseException

Initializes the policy rule.

Parameters:

config - The config store reference

Throws:

EBaseException

getDescription

java.lang.String getDescription()

Gets the description for this policy rule.

Returns:

The Description for this rule.

getName

java.lang.String getName()

Returns the name of the policy rule class.

Returns:

The name of the policy class.

getInstanceName

java.lang.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(IRequest 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

java.util.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

java.util.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.

setError

void setError(IRequest req,
              java.lang.String format,
              java.lang.Object[] params)

setInstanceName

void setInstanceName(java.lang.String instanceName)

setPolicyException

void setPolicyException(IRequest req,
                        EBaseException ex)