NSCCommentExt (pki-javadoc)

java.lang.Object
- com.netscape.cms.policy.APolicyRule
- - com.netscape.cms.policy.extensions.NSCCommentExt

All Implemented Interfaces:: IExtendedPluginInfo, IEnrollmentPolicy, IPolicyRule, IPolicy

Deprecated.

public class NSCCommentExt
extends APolicyRule
implements IEnrollmentPolicy, IExtendedPluginInfo

Netscape comment Adds Netscape comment policy

 NOTE:  The Policy Framework has been replaced by the Profile Framework.

Version:: $Revision$, $Date$

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`certApplied` Deprecated.
`protected static java.lang.String`	`FILE` Deprecated.
`protected java.lang.String`	`mCommentFile` Deprecated.
`protected boolean`	`mCritical` Deprecated.
`protected java.lang.String`	`mInputType` Deprecated.
`protected java.lang.String`	`mUserNoticeDisplayText` Deprecated.
`protected static java.lang.String`	`PROP_COMMENT_FILE` Deprecated.
`protected static java.lang.String`	`PROP_CRITICAL` Deprecated.
`protected static java.lang.String`	`PROP_INPUT_TYPE` Deprecated.
`protected static java.lang.String`	`PROP_USER_NOTICE_DISPLAY_TEXT` Deprecated.
`protected java.lang.String`	`tempCommentFile` Deprecated.
`protected static java.lang.String`	`TEXT` Deprecated.

Fields inherited from class com.netscape.cms.policy.APolicyRule
DESC, mFilterExp, mInstanceName, mLogger, NAME

Fields inherited from interface com.netscape.certsrv.policy.IPolicyRule
PROP_ENABLE, PROP_IMPLNAME, PROP_PREDICATE

Fields inherited from interface com.netscape.certsrv.base.IExtendedPluginInfo
HELP_TEXT, HELP_TOKEN

Constructor Summary

Constructors
Constructor and Description

NSCCommentExt()
Deprecated.

Adds the Netscape comment in the end-entity certificates or CA certificates.

Constructors
Constructor and Description
`NSCCommentExt()` Deprecated. Adds the Netscape comment in the end-entity certificates or CA certificates.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`PolicyResult`	`apply(IRequest req)` Deprecated. Applies the policy on the given Request.
`PolicyResult`	`applyCert(IRequest req, netscape.security.x509.X509CertInfo certInfo)` Deprecated.
`java.util.Vector<java.lang.String>`	`getDefaultParams()` Deprecated. Return default parameters for a policy implementation.
`java.lang.String[]`	`getExtendedPluginInfo(java.util.Locale locale)` Deprecated. This method returns an array of strings.
`java.util.Vector<java.lang.String>`	`getInstanceParams()` Deprecated. Return configured parameters for a policy rule instance.
`void`	`init(ISubsystem owner, IConfigStore config)` Deprecated. Initializes this policy rule.

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

Methods inherited from interface com.netscape.certsrv.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
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - PROP_COMMENT_FILE
```
protected static final java.lang.String PROP_COMMENT_FILE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - PROP_CRITICAL
```
protected static final java.lang.String PROP_CRITICAL
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - PROP_INPUT_TYPE
```
protected static final java.lang.String PROP_INPUT_TYPE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - TEXT
```
protected static final java.lang.String TEXT
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - FILE
```
protected static final java.lang.String FILE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - mUserNoticeDisplayText
```
protected java.lang.String mUserNoticeDisplayText
```
    Deprecated.
  - mCommentFile
```
protected java.lang.String mCommentFile
```
    Deprecated.
  - mInputType
```
protected java.lang.String mInputType
```
    Deprecated.
  - mCritical
```
protected boolean mCritical
```
    Deprecated.
  - tempCommentFile
```
protected java.lang.String tempCommentFile
```
    Deprecated.
  - certApplied
```
protected boolean certApplied
```
    Deprecated.
- Constructor Detail
  - NSCCommentExt
```
public NSCCommentExt()
```
    Deprecated.
    
    Adds the Netscape comment in the end-entity certificates or CA certificates. The policy is set to be non-critical with the provided OID.
- Method Detail
  - init
```
public void init(ISubsystem owner,
                 IConfigStore config)
          throws EBaseException
```
    Deprecated.
    
    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 interface IPolicyRule
    
    Specified by:
    
    init in class APolicyRule
    
    Parameters:
    
    config - The config store reference
    
    Throws:
    
    EBaseException
  - apply
```
public PolicyResult apply(IRequest req)
```
    Deprecated.
    
    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.
  - applyCert
```
public PolicyResult applyCert(IRequest req,
                              netscape.security.x509.X509CertInfo certInfo)
```
    Deprecated.
  - getExtendedPluginInfo
```
public java.lang.String[] getExtendedPluginInfo(java.util.Locale locale)
```
    Deprecated.
    
    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
  - getInstanceParams
```
public java.util.Vector<java.lang.String> getInstanceParams()
```
    Deprecated.
    
    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<java.lang.String> getDefaultParams()
```
    Deprecated.
    
    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.

Class NSCCommentExt

Field Summary

Fields inherited from class com.netscape.cms.policy.APolicyRule

Fields inherited from interface com.netscape.certsrv.policy.IPolicyRule

Fields inherited from interface com.netscape.certsrv.base.IExtendedPluginInfo

Constructor Summary

Method Summary

Methods inherited from class com.netscape.cms.policy.APolicyRule

Methods inherited from class java.lang.Object

Methods inherited from interface com.netscape.certsrv.policy.IPolicyRule

Field Detail

PROP_USER_NOTICE_DISPLAY_TEXT

PROP_COMMENT_FILE

PROP_CRITICAL

PROP_INPUT_TYPE

TEXT

FILE

mUserNoticeDisplayText

mCommentFile

mInputType

mCritical

tempCommentFile

certApplied

Constructor Detail

NSCCommentExt

Method Detail

init

apply

applyCert

getExtendedPluginInfo

getInstanceParams

getDefaultParams