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

Class SubjectDirectoryAttributesExt

java.lang.Object

org.dogtagpki.legacy.server.policy.APolicyRule

org.dogtagpki.legacy.server.policy.extensions.SubjectDirectoryAttributesExt

All Implemented Interfaces:

IExtendedPluginInfo, IPolicy, IEnrollmentPolicy, IPolicyRule

public class SubjectDirectoryAttributesExt
extends APolicyRule
implements IEnrollmentPolicy, IExtendedPluginInfo

Policy to add the subject directory attributes extension.

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

Version:

$Revision$, $Date$

Field Summary

Fields

Modifier and Type	Field	Description
protected static boolean	DEF_CRITICAL
protected static int	DEF_NUM_ATTRIBUTES
static org.slf4j.Logger	logger
protected org.dogtagpki.legacy.server.policy.extensions.AttributeConfig[]	mAttributes
protected static int	MAX_NUM_ATTRIBUTES
protected IConfigStore	mConfig
protected boolean	mCritical
protected static java.util.Vector<java.lang.String>	mDefParams
protected org.mozilla.jss.netscape.security.x509.SubjectDirAttributesExtension	mExt
protected int	mNumAttributes
protected java.util.Vector<java.lang.String>	mParams
protected static java.lang.String	PROP_ATTRIBUTE
protected static java.lang.String	PROP_CRITICAL
protected static java.lang.String	PROP_NUM_ATTRIBUTES

Fields inherited from class org.dogtagpki.legacy.server.policy.APolicyRule

DESC, 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
SubjectDirectoryAttributesExt()

Method Summary

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

logger

public static org.slf4j.Logger logger

PROP_CRITICAL

protected static final java.lang.String PROP_CRITICAL

See Also:

Constant Field Values

PROP_ATTRIBUTE

protected static final java.lang.String PROP_ATTRIBUTE

See Also:

Constant Field Values

PROP_NUM_ATTRIBUTES

protected static final java.lang.String PROP_NUM_ATTRIBUTES

See Also:

Constant Field Values

DEF_CRITICAL

protected static final boolean DEF_CRITICAL

See Also:

Constant Field Values

DEF_NUM_ATTRIBUTES

protected static final int DEF_NUM_ATTRIBUTES

See Also:

Constant Field Values

MAX_NUM_ATTRIBUTES

protected static final int MAX_NUM_ATTRIBUTES

See Also:

Constant Field Values

mCritical

protected boolean mCritical

mNumAttributes

protected int mNumAttributes

mAttributes

protected org.dogtagpki.legacy.server.policy.extensions.AttributeConfig[] mAttributes

mConfig

protected IConfigStore mConfig

mExt

protected org.mozilla.jss.netscape.security.x509.SubjectDirAttributesExtension mExt

mParams

protected java.util.Vector<java.lang.String> mParams

mDefParams

protected static java.util.Vector<java.lang.String> mDefParams

Constructor Detail

SubjectDirectoryAttributesExt

public SubjectDirectoryAttributesExt()

Method Detail

init

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

Description copied from class: APolicyRule

Initializes the policy rule.

Specified by:

init in interface IPolicyRule

Specified by:

init in class APolicyRule

config - The config store reference

Throws:

EBaseException

apply

public PolicyResult apply(IRequest req)

Description copied from class: APolicyRule

Applies the policy on the given Request.

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.

applyCert

public PolicyResult applyCert(IRequest req,
                              org.mozilla.jss.netscape.security.x509.X509CertInfo certInfo)

getInstanceParams

public java.util.Vector<java.lang.String> getInstanceParams()

Description copied from class: APolicyRule

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

Description copied from class: APolicyRule

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)

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