Class NSCCommentExt
- java.lang.Object
-
- org.dogtagpki.legacy.server.policy.APolicyRule
-
- org.dogtagpki.legacy.server.policy.extensions.NSCCommentExt
-
- All Implemented Interfaces:
IExtendedPluginInfo
,IPolicy
,IEnrollmentPolicy
,IPolicyRule
public class NSCCommentExt extends APolicyRule implements IEnrollmentPolicy, IExtendedPluginInfo
Netscape comment Adds Netscape comment policyNOTE: The Policy Framework has been replaced by the Profile Framework.
- Version:
- $Revision$, $Date$
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
certApplied
protected static java.lang.String
FILE
protected java.lang.String
mCommentFile
protected boolean
mCritical
protected java.lang.String
mInputType
protected java.lang.String
mUserNoticeDisplayText
protected static java.lang.String
PROP_COMMENT_FILE
protected static java.lang.String
PROP_CRITICAL
protected static java.lang.String
PROP_INPUT_TYPE
protected static java.lang.String
PROP_USER_NOTICE_DISPLAY_TEXT
protected java.lang.String
tempCommentFile
protected static java.lang.String
TEXT
-
Fields inherited from class org.dogtagpki.legacy.server.policy.APolicyRule
DESC, logger, mFilterExp, mInstanceName, NAME
-
Fields inherited from interface com.netscape.certsrv.base.IExtendedPluginInfo
HELP_TEXT, HELP_TOKEN
-
Fields inherited from interface org.dogtagpki.legacy.policy.IPolicyRule
PROP_ENABLE, PROP_IMPLNAME, PROP_PREDICATE
-
-
Constructor Summary
Constructors Constructor Description NSCCommentExt()
Adds the Netscape comment in the end-entity certificates or CA certificates.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PolicyResult
apply(IRequest req)
Applies the policy on the given Request.PolicyResult
applyCert(IRequest req, org.mozilla.jss.netscape.security.x509.X509CertInfo certInfo)
java.util.Vector<java.lang.String>
getDefaultParams()
Return default parameters for a policy implementation.java.lang.String[]
getExtendedPluginInfo(java.util.Locale locale)
This method returns an array of strings.java.util.Vector<java.lang.String>
getInstanceParams()
Return configured parameters for a policy rule instance.void
init(IPolicyProcessor owner, IConfigStore config)
Initializes this policy rule.-
Methods inherited from class org.dogtagpki.legacy.server.policy.APolicyRule
agentApproved, createKeyIdentifier, deferred, formSHA1KeyId, formSpkiSHA1KeyId, getDescription, getInstanceName, getName, getPredicate, 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
-
Methods inherited from interface org.dogtagpki.legacy.policy.IPolicyRule
getDescription, getInstanceName, getName, getPredicate, setError, setInstanceName, setPolicyException, setPredicate
-
-
-
-
Field Detail
-
PROP_USER_NOTICE_DISPLAY_TEXT
protected static final java.lang.String PROP_USER_NOTICE_DISPLAY_TEXT
- See Also:
- Constant Field Values
-
PROP_COMMENT_FILE
protected static final java.lang.String PROP_COMMENT_FILE
- See Also:
- Constant Field Values
-
PROP_CRITICAL
protected static final java.lang.String PROP_CRITICAL
- See Also:
- Constant Field Values
-
PROP_INPUT_TYPE
protected static final java.lang.String PROP_INPUT_TYPE
- See Also:
- Constant Field Values
-
TEXT
protected static final java.lang.String TEXT
- See Also:
- Constant Field Values
-
FILE
protected static final java.lang.String FILE
- See Also:
- Constant Field Values
-
mUserNoticeDisplayText
protected java.lang.String mUserNoticeDisplayText
-
mCommentFile
protected java.lang.String mCommentFile
-
mInputType
protected java.lang.String mInputType
-
mCritical
protected boolean mCritical
-
tempCommentFile
protected java.lang.String tempCommentFile
-
certApplied
protected boolean certApplied
-
-
Method Detail
-
init
public void init(IPolicyProcessor owner, IConfigStore config) throws EBaseException
Initializes this policy rule.The entries may be of the form: ca.Policy.rule.
.implName=NSCCommentExtImpl ca.Policy.rule. .displayText= ca.Policy.rule. .commentFile= ca.Policy.rule. .enable=false - Specified by:
init
in interfaceIPolicyRule
- Specified by:
init
in classAPolicyRule
- Parameters:
config
- The config store reference- Throws:
EBaseException
-
apply
public PolicyResult apply(IRequest req)
Applies the policy on the given Request.- Specified by:
apply
in interfaceIPolicy
- Specified by:
apply
in interfaceIPolicyRule
- Specified by:
apply
in classAPolicyRule
- Parameters:
req
- The request on which to apply policy.- Returns:
- The policy result object.
-
applyCert
public PolicyResult applyCert(IRequest req, org.mozilla.jss.netscape.security.x509.X509CertInfo certInfo)
-
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 interfaceIExtendedPluginInfo
-
getInstanceParams
public java.util.Vector<java.lang.String> getInstanceParams()
Return configured parameters for a policy rule instance.- Specified by:
getInstanceParams
in interfaceIPolicyRule
- Specified by:
getInstanceParams
in classAPolicyRule
- Returns:
- nvPairs A Vector of name/value pairs.
-
getDefaultParams
public java.util.Vector<java.lang.String> getDefaultParams()
Return default parameters for a policy implementation.- Specified by:
getDefaultParams
in interfaceIPolicyRule
- Specified by:
getDefaultParams
in classAPolicyRule
- Returns:
- nvPairs A Vector of name/value pairs.
-
-