com.netscape.cms.policy.constraints

Class UniqueSubjectNameConstraints

java.lang.Object

com.netscape.cms.policy.APolicyRule

com.netscape.cms.policy.constraints.UniqueSubjectNameConstraints

All Implemented Interfaces:

IExtendedPluginInfo, IEnrollmentPolicy, IPolicyRule, IPolicy

Direct Known Subclasses:

UniqueSubjectName

Deprecated.

public class UniqueSubjectNameConstraints
extends APolicyRule
implements IEnrollmentPolicy, IExtendedPluginInfo

Checks the uniqueness of the subject name. This policy can only be used (installed) in Certificate Authority subsystem. This policy can perform pre-agent-approval checking or post-agent-approval checking based on configuration setting. In some situations, user may want to have 2 certificates with the same subject name. For example, one key for encryption, and one for signing. This policy does not deal with this case directly. But it can be easily extended to do that.

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

Version:

$Revision$, $Date$

Field Summary

Fields

Modifier and Type	Field and Description
ICertificateAuthority	mCA Deprecated.
boolean	mKeyUsageExtensionChecking Deprecated.
boolean	mPreAgentApprovalChecking Deprecated.
protected static java.lang.String	PROP_KEY_USAGE_EXTENSION_CHECKING Deprecated.
protected static java.lang.String	PROP_PRE_AGENT_APPROVAL_CHECKING 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
UniqueSubjectNameConstraints() Deprecated.

Method Summary

Modifier and Type	Method and Description
PolicyResult	apply(IRequest req) Deprecated. Applies the policy on the given Request.
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_PRE_AGENT_APPROVAL_CHECKING

protected static final java.lang.String PROP_PRE_AGENT_APPROVAL_CHECKING

Deprecated.

See Also:

Constant Field Values

PROP_KEY_USAGE_EXTENSION_CHECKING

protected static final java.lang.String PROP_KEY_USAGE_EXTENSION_CHECKING

Deprecated.

See Also:

Constant Field Values

mCA

public ICertificateAuthority mCA

Deprecated.

mPreAgentApprovalChecking

public boolean mPreAgentApprovalChecking

Deprecated.

mKeyUsageExtensionChecking

public boolean mKeyUsageExtensionChecking

Deprecated.

Constructor Detail

UniqueSubjectNameConstraints

public UniqueSubjectNameConstraints()

Deprecated.

Method Detail

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

init

public void init(ISubsystem owner,
                 IConfigStore config)
          throws EBaseException

Deprecated.

Initializes this policy rule.

The entries probably are of the form: ca.Policy.rule..implName=UniqueSubjectName ca.Policy.rule..enable=true ca.Policy.rule..enable=true ca.Policy.rule..enablePreAgentApprovalChecking=true ca.Policy.rule..enableKeyUsageExtensionChecking=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.

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