Class AttributePresentConstraints
- java.lang.Object
-
- org.dogtagpki.legacy.server.policy.APolicyRule
-
- org.dogtagpki.legacy.server.policy.constraints.AttributePresentConstraints
-
- All Implemented Interfaces:
IExtendedPluginInfo
,IPolicy
,IEnrollmentPolicy
,IPolicyRule
public class AttributePresentConstraints extends APolicyRule implements IEnrollmentPolicy, IExtendedPluginInfo
This checks if attribute present.NOTE: The Policy Framework has been replaced by the Profile Framework.
- Version:
- $Revision$, $Date$
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.String
DEF_ATTR
protected static java.lang.String
DEF_LDAP_AUTH
protected static java.lang.String
DEF_LDAP_BASE
protected static java.lang.String
DEF_LDAP_BIND
protected static java.lang.String
DEF_LDAP_CERT
protected static java.lang.String
DEF_LDAP_HOST
protected static java.lang.Integer
DEF_LDAP_MAXC
protected static java.lang.Integer
DEF_LDAP_MINC
protected static java.lang.Integer
DEF_LDAP_PORT
protected static java.lang.String
DEF_LDAP_PW
protected static java.lang.Boolean
DEF_LDAP_SSL
protected static java.lang.Integer
DEF_LDAP_VER
protected static java.lang.String
DEF_VALUE
static org.slf4j.Logger
logger
protected java.lang.String
mImplName
protected java.lang.String
mName
protected static java.util.Hashtable<java.lang.String,java.lang.Object>
mParamDefault
protected static java.util.Vector<java.lang.String>
mParamNames
protected java.util.Hashtable<java.lang.String,java.lang.Object>
mParamValue
protected static java.lang.String
PROP_ATTR
protected static java.lang.String
PROP_ENABLED
protected static java.lang.String
PROP_LDAP
protected static java.lang.String
PROP_LDAP_AUTH
protected static java.lang.String
PROP_LDAP_BASE
protected static java.lang.String
PROP_LDAP_BIND
protected static java.lang.String
PROP_LDAP_CERT
protected static java.lang.String
PROP_LDAP_HOST
protected static java.lang.String
PROP_LDAP_MAXC
protected static java.lang.String
PROP_LDAP_MINC
protected static java.lang.String
PROP_LDAP_PORT
protected static java.lang.String
PROP_LDAP_PW
protected static java.lang.String
PROP_LDAP_SSL
protected static java.lang.String
PROP_LDAP_VER
protected static java.lang.String
PROP_VALUE
-
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 AttributePresentConstraints()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected static void
addParam(java.lang.String name, java.lang.Object value)
PolicyResult
apply(IRequest r)
Applies the policy on the given Request.protected void
getBooleanConfigParam(IConfigStore config, java.lang.String paramName)
IConfigStore
getConfigStore()
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.lang.String
getImplName()
java.util.Vector<java.lang.String>
getInstanceParams()
Return configured parameters for a policy rule instance.protected void
getIntConfigParam(IConfigStore config, java.lang.String paramName)
java.lang.String
getName()
Returns the name of the policy rule.protected void
getStringConfigParam(IConfigStore config, java.lang.String paramName)
void
init(IPolicyProcessor owner, IConfigStore config)
Initializes the policy rule.void
shutdown()
-
Methods inherited from class org.dogtagpki.legacy.server.policy.APolicyRule
agentApproved, createKeyIdentifier, deferred, formSHA1KeyId, formSpkiSHA1KeyId, getDescription, getInstanceName, 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, getPredicate, setError, setInstanceName, setPolicyException, setPredicate
-
-
-
-
Field Detail
-
logger
public static org.slf4j.Logger logger
-
PROP_ENABLED
protected static final java.lang.String PROP_ENABLED
- See Also:
- Constant Field Values
-
PROP_LDAP
protected static final java.lang.String PROP_LDAP
- See Also:
- Constant Field Values
-
mName
protected java.lang.String mName
-
mImplName
protected java.lang.String mImplName
-
PROP_LDAP_HOST
protected static final java.lang.String PROP_LDAP_HOST
- See Also:
- Constant Field Values
-
DEF_LDAP_HOST
protected static final java.lang.String DEF_LDAP_HOST
- See Also:
- Constant Field Values
-
PROP_LDAP_PORT
protected static final java.lang.String PROP_LDAP_PORT
- See Also:
- Constant Field Values
-
DEF_LDAP_PORT
protected static final java.lang.Integer DEF_LDAP_PORT
-
PROP_LDAP_SSL
protected static final java.lang.String PROP_LDAP_SSL
- See Also:
- Constant Field Values
-
DEF_LDAP_SSL
protected static final java.lang.Boolean DEF_LDAP_SSL
-
PROP_LDAP_VER
protected static final java.lang.String PROP_LDAP_VER
- See Also:
- Constant Field Values
-
DEF_LDAP_VER
protected static final java.lang.Integer DEF_LDAP_VER
-
PROP_LDAP_BIND
protected static final java.lang.String PROP_LDAP_BIND
- See Also:
- Constant Field Values
-
DEF_LDAP_BIND
protected static final java.lang.String DEF_LDAP_BIND
- See Also:
- Constant Field Values
-
PROP_LDAP_PW
protected static final java.lang.String PROP_LDAP_PW
- See Also:
- Constant Field Values
-
DEF_LDAP_PW
protected static final java.lang.String DEF_LDAP_PW
- See Also:
- Constant Field Values
-
PROP_LDAP_CERT
protected static final java.lang.String PROP_LDAP_CERT
- See Also:
- Constant Field Values
-
DEF_LDAP_CERT
protected static final java.lang.String DEF_LDAP_CERT
- See Also:
- Constant Field Values
-
PROP_LDAP_AUTH
protected static final java.lang.String PROP_LDAP_AUTH
- See Also:
- Constant Field Values
-
DEF_LDAP_AUTH
protected static final java.lang.String DEF_LDAP_AUTH
- See Also:
- Constant Field Values
-
PROP_LDAP_BASE
protected static final java.lang.String PROP_LDAP_BASE
- See Also:
- Constant Field Values
-
DEF_LDAP_BASE
protected static final java.lang.String DEF_LDAP_BASE
- See Also:
- Constant Field Values
-
PROP_LDAP_MINC
protected static final java.lang.String PROP_LDAP_MINC
- See Also:
- Constant Field Values
-
DEF_LDAP_MINC
protected static final java.lang.Integer DEF_LDAP_MINC
-
PROP_LDAP_MAXC
protected static final java.lang.String PROP_LDAP_MAXC
- See Also:
- Constant Field Values
-
DEF_LDAP_MAXC
protected static final java.lang.Integer DEF_LDAP_MAXC
-
PROP_ATTR
protected static final java.lang.String PROP_ATTR
- See Also:
- Constant Field Values
-
DEF_ATTR
protected static final java.lang.String DEF_ATTR
- See Also:
- Constant Field Values
-
PROP_VALUE
protected static final java.lang.String PROP_VALUE
- See Also:
- Constant Field Values
-
DEF_VALUE
protected static final java.lang.String DEF_VALUE
- See Also:
- Constant Field Values
-
mParamNames
protected static java.util.Vector<java.lang.String> mParamNames
-
mParamDefault
protected static java.util.Hashtable<java.lang.String,java.lang.Object> mParamDefault
-
mParamValue
protected java.util.Hashtable<java.lang.String,java.lang.Object> mParamValue
-
-
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 interfaceIExtendedPluginInfo
-
getName
public java.lang.String getName()
Description copied from class:APolicyRule
Returns the name of the policy rule.- Specified by:
getName
in interfaceIPolicyRule
- Overrides:
getName
in classAPolicyRule
- Returns:
- The name of the policy class.
-
getImplName
public java.lang.String getImplName()
-
getConfigStore
public IConfigStore getConfigStore()
-
shutdown
public void shutdown()
-
addParam
protected static void addParam(java.lang.String name, java.lang.Object value)
-
getStringConfigParam
protected void getStringConfigParam(IConfigStore config, java.lang.String paramName)
-
getIntConfigParam
protected void getIntConfigParam(IConfigStore config, java.lang.String paramName)
-
getBooleanConfigParam
protected void getBooleanConfigParam(IConfigStore config, java.lang.String paramName)
-
init
public void init(IPolicyProcessor owner, IConfigStore config) throws EBaseException
Description copied from class:APolicyRule
Initializes the policy rule.- Specified by:
init
in interfaceIPolicyRule
- Specified by:
init
in classAPolicyRule
config
- The config store reference- Throws:
EBaseException
-
apply
public PolicyResult apply(IRequest r)
Description copied from class:APolicyRule
Applies the policy on the given Request.- Specified by:
apply
in interfaceIPolicy
- Specified by:
apply
in interfaceIPolicyRule
- Specified by:
apply
in classAPolicyRule
- Parameters:
r
- The request on which to apply policy.- Returns:
- The policy result object.
-
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 interfaceIPolicyRule
- Specified by:
getInstanceParams
in classAPolicyRule
- 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 interfaceIPolicyRule
- Specified by:
getDefaultParams
in classAPolicyRule
- Returns:
- nvPairs A Vector of name/value pairs.
-
-