Package org.dogtagpki.legacy.server.policy.extensions

Class CertificateScopeOfUseExt

java.lang.Object

org.dogtagpki.legacy.server.policy.APolicyRule

org.dogtagpki.legacy.server.policy.extensions.CertificateScopeOfUseExt

All Implemented Interfaces:

IExtendedPluginInfo, IPolicy, IEnrollmentPolicy, IPolicyRule

public class CertificateScopeOfUseExt
extends APolicyRule
implements IEnrollmentPolicy, IExtendedPluginInfo

Certificate Scope Of Use extension policy. This extension is defined in draft-thayes-cert-scope-00.txt

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

Version:

$Revision$, $Date$

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_ENTRY
IConfigStore	mConfig
protected static java.lang.String	PROP_CRITICAL
protected static java.lang.String	PROP_ENTRY
protected static java.lang.String	PROP_NAME
protected static java.lang.String	PROP_NAME_TYPE
protected static java.lang.String	PROP_PORT_NUMBER

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
CertificateScopeOfUseExt()

Method Summary

Modifier and Type	Method	Description
PolicyResult	apply(IRequest req)	If this policy is enabled, add the authority information access extension to the certificate.
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_CRITICAL

protected static final java.lang.String PROP_CRITICAL

See Also:

Constant Field Values

PROP_ENTRY

protected static final java.lang.String PROP_ENTRY

See Also:

Constant Field Values

PROP_NAME

protected static final java.lang.String PROP_NAME

See Also:

Constant Field Values

PROP_NAME_TYPE

protected static final java.lang.String PROP_NAME_TYPE

See Also:

Constant Field Values

PROP_PORT_NUMBER

protected static final java.lang.String PROP_PORT_NUMBER

See Also:

Constant Field Values

MAX_ENTRY

public static final int MAX_ENTRY

See Also:

Constant Field Values

mConfig

public IConfigStore mConfig

Constructor Detail

CertificateScopeOfUseExt

public CertificateScopeOfUseExt()

Method Detail

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(IPolicyProcessor owner,
                 IConfigStore config)
          throws EBaseException

Initializes this policy rule.

The entries may be of the form: ca.Policy.rule..implName=AuthInfoAccessExt ca.Policy.rule..enable=true ca.Policy.rule..predicate=

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)

If this policy is enabled, add the authority information access extension to the certificate.

Specified by:

apply in interface IPolicy

Specified by:

apply in interface IPolicyRule

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()

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()

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.