BasicConstraintsExt (pki-javadoc)

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

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

Deprecated.

public class BasicConstraintsExt
extends APolicyRule
implements IEnrollmentPolicy, IExtendedPluginInfo

Basic Constraints policy. Adds the Basic constraints extension.

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

Version:: $Revision$, $Date$

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`ARG_PATHLEN` Deprecated.
`static boolean`	`DEFAULT_CRITICALITY` Deprecated.
`protected int`	`mCAPathLen` Deprecated.
`protected boolean`	`mCritical` Deprecated.
`protected int`	`mDefaultMaxPathLen` Deprecated.
`protected boolean`	`mIsCA` Deprecated.
`protected int`	`mMaxPathLen` Deprecated.
`protected java.lang.String`	`mOrigMaxPathLen` Deprecated.
`protected boolean`	`mRemoveExt` Deprecated.
`protected static java.lang.String`	`PROP_IS_CA` Deprecated.
`protected static java.lang.String`	`PROP_IS_CRITICAL` Deprecated.
`protected static java.lang.String`	`PROP_MAXPATHLEN` 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

BasicConstraintsExt()
Deprecated.

Adds the basic constraints extension as a critical extension in CA certificates i.e.

Constructors
Constructor and Description
`BasicConstraintsExt()` Deprecated. Adds the basic constraints extension as a critical extension in CA certificates i.e.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`PolicyResult`	`apply(IRequest req)` Deprecated. Checks if the basic contraints extension in certInfo is valid and add the basic constraints extension for CA certs if none exists.
`PolicyResult`	`applyCert(IRequest req, boolean isCA, 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_MAXPATHLEN
```
protected static final java.lang.String PROP_MAXPATHLEN
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - PROP_IS_CA
```
protected static final java.lang.String PROP_IS_CA
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - PROP_IS_CRITICAL
```
protected static final java.lang.String PROP_IS_CRITICAL
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - ARG_PATHLEN
```
protected static final java.lang.String ARG_PATHLEN
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - mMaxPathLen
```
protected int mMaxPathLen
```
    Deprecated.
  - mOrigMaxPathLen
```
protected java.lang.String mOrigMaxPathLen
```
    Deprecated.
  - mCritical
```
protected boolean mCritical
```
    Deprecated.
  - mDefaultMaxPathLen
```
protected int mDefaultMaxPathLen
```
    Deprecated.
  - mCAPathLen
```
protected int mCAPathLen
```
    Deprecated.
  - mRemoveExt
```
protected boolean mRemoveExt
```
    Deprecated.
  - mIsCA
```
protected boolean mIsCA
```
    Deprecated.
  - DEFAULT_CRITICALITY
```
public static final boolean DEFAULT_CRITICALITY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BasicConstraintsExt
```
public BasicConstraintsExt()
```
    Deprecated.
    
    Adds the basic constraints extension as a critical extension in CA certificates i.e. certype is ca, with either a requested or configured path len. The requested or configured path length cannot be greater than or equal to the CA's basic constraints path length. If the CA path length is 0, all requests for CA certs are rejected.
- 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=BasicConstraintsExtImpl ca.Policy.rule..pathLen=, -1 for undefined. ca.Policy.rule..enable=true
    
    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.
    
    Checks if the basic contraints extension in certInfo is valid and add the basic constraints extension for CA certs if none exists. Non-CA certs do not get a basic constraints extension.
    
    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,
                              boolean isCA,
                              netscape.security.x509.X509CertInfo certInfo)
```
    Deprecated.
  - 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.
  - 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

Class BasicConstraintsExt

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_MAXPATHLEN

PROP_IS_CA

PROP_IS_CRITICAL

ARG_PATHLEN

mMaxPathLen

mOrigMaxPathLen

mCritical

mDefaultMaxPathLen

mCAPathLen

mRemoveExt

mIsCA

DEFAULT_CRITICALITY

Constructor Detail

BasicConstraintsExt

Method Detail

init

apply

applyCert

getInstanceParams

getDefaultParams

getExtendedPluginInfo