com.netscape.cms.policy.constraints
Class RenewalValidityConstraints
java.lang.Object
com.netscape.cms.policy.APolicyRule
com.netscape.cms.policy.constraints.RenewalValidityConstraints
- All Implemented Interfaces:
- IExtendedPluginInfo, IPolicyRule, IRenewalPolicy, IPolicy
public class RenewalValidityConstraints
- extends APolicyRule
- implements IRenewalPolicy, IExtendedPluginInfo
RenewalValidityConstraints is a default rule for Certificate
Renewal. This policy enforces the no of days before which a
currently active certificate can be renewed and sets new validity
period for the renewed certificate starting from the the ending
period in the old certificate.
The main parameters are:
The renewal leadtime in days: - i.e how many days before the
expiry of the current certificate can one request the renewal.
min and max validity duration.
- Version:
- $Revision: 14561 $, $Date: 2007-05-01 10:28:56 -0700 (Tue, 01 May 2007) $
Methods inherited from class com.netscape.cms.policy.APolicyRule |
agentApproved, createKeyIdentifier, deferred, formSHA1KeyId, formSpkiSHA1KeyId, getDescription, getInstanceName, getName, getPredicate, log, setError, setError, setError, setInstanceName, setPolicyException, setPolicyException, setPredicate |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DEF_MIN_VALIDITY
public static final int DEF_MIN_VALIDITY
- See Also:
- Constant Field Values
DEF_MAX_VALIDITY
public static final int DEF_MAX_VALIDITY
- See Also:
- Constant Field Values
DEF_RENEWAL_INTERVAL
public static final long DEF_RENEWAL_INTERVAL
- See Also:
- Constant Field Values
DAYS_TO_MS_FACTOR
public static final long DAYS_TO_MS_FACTOR
- See Also:
- Constant Field Values
CERT_HEADER
public static final java.lang.String CERT_HEADER
- See Also:
- Constant Field Values
CERT_TRAILER
public static final java.lang.String CERT_TRAILER
- See Also:
- Constant Field Values
RenewalValidityConstraints
public RenewalValidityConstraints()
getExtendedPluginInfo
public java.lang.String[] getExtendedPluginInfo(java.util.Locale locale)
- Description copied from interface:
IExtendedPluginInfo
- This method returns an array of strings. Each element of the
array represents a configurable parameter, or some other
meta-info (such as help-token)
there is an entry indexed on that parameter name
;[,required];;...
Where:
type_info is either 'string', 'number', 'boolean', 'password' or
'choice(ch1,ch2,ch3,...)'
If the marker 'required' is included after the type_info,
the parameter will has some visually distinctive marking in
the UI.
'description' is a short sentence describing the parameter
'choice' is rendered as a drop-down list. The first parameter in the
list will be activated by default
'boolean' is rendered as a checkbox. The resulting parameter will be
either 'true' or 'false'
'string' allows any characters
'number' allows only numbers
'password' is rendered as a password field (the characters are replaced
with *'s when being types. This parameter is not passed through to
the plugin. It is instead inserted directly into the password cache
keyed on the instance name. The value of the parameter
'bindPWPrompt' (see example below) is set to the key.
In addition to the configurable parameters, the following magic parameters
may be defined:
HELP_TOKEN;helptoken - a pointer to the online manual section for this plugin
HELP_TEXT;helptext - a general help string describing the plugin
For example:
"username;string;The username you wish to login as"
"bindPWPrompt;password;Enter password to bind as above user with"
"algorithm;choice(RSA,DSA);Which algorithm do you want to use"
"enable;boolean;Do you want to run this plugin"
"port;number;Which port number do you want to use"
- Specified by:
getExtendedPluginInfo
in interface IExtendedPluginInfo
init
public void init(ISubsystem owner,
IConfigStore config)
throws EPolicyException
- Initializes this policy rule.
The entries probably are of the form:
ra.Policy.rule..implName=ValidityConstraints
ra.Policy.rule..enable=true
ra.Policy.rule..minValidity=30
ra.Policy.rule..maxValidity=180
ra.Policy.rule..renewalInterval=15
ra.Policy.rule..predicate=ou==Sales
- Specified by:
init
in interface IPolicyRule
- Specified by:
init
in class APolicyRule
- Parameters:
config
- The config store reference
- Throws:
EPolicyException
apply
public PolicyResult apply(IRequest req)
- Applies the policy on the given Request.
- Specified by:
apply
in interface IPolicyRule
- Specified by:
apply
in interface IPolicy
- Specified by:
apply
in class APolicyRule
- Parameters:
req
- The request on which to apply policy.
- Returns:
- The policy result object.
getInstanceParams
public java.util.Vector getInstanceParams()
- Return configured parameters for a policy rule instance.
- Specified by:
getInstanceParams
in interface IPolicyRule
- Specified by:
getInstanceParams
in class APolicyRule
- Returns:
- nvPairs A Vector of name/value pairs.
getDefaultParams
public java.util.Vector getDefaultParams()
- Return default parameters for a policy implementation.
- Specified by:
getDefaultParams
in interface IPolicyRule
- Specified by:
getDefaultParams
in class APolicyRule
- Returns:
- nvPairs A Vector of name/value pairs.