com.netscape.cms.policy.constraints
Class AttributePresentConstraints

java.lang.Object
  extended by com.netscape.cms.policy.APolicyRule
      extended by com.netscape.cms.policy.constraints.AttributePresentConstraints
All Implemented Interfaces:
IExtendedPluginInfo, IEnrollmentPolicy, IPolicyRule, IPolicy

public class AttributePresentConstraints
extends APolicyRule
implements IEnrollmentPolicy, IExtendedPluginInfo

This checks if attribute present.

Version:
$Revision: 14561 $, $Date: 2007-05-01 10:28:56 -0700 (Tue, 01 May 2007) $

Field Summary
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
           
protected  java.lang.String mImplName
           
protected  java.lang.String mName
           
protected static java.util.Hashtable mParamDefault
           
protected static java.util.Vector mParamNames
           
protected  java.util.Hashtable 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 com.netscape.cms.policy.APolicyRule
DESC, mFilterExp, mInstanceName, 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
AttributePresentConstraints()
           
 
Method Summary
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 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 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(ISubsystem owner, IConfigStore config)
          Initializes the policy rule.
protected  void log(int level, java.lang.String msg)
          log a message for this policy rule.
 void shutdown()
           
 
Methods inherited from class com.netscape.cms.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 com.netscape.certsrv.policy.IPolicyRule
getDescription, getInstanceName, getPredicate, setError, setInstanceName, setPolicyException, setPredicate
 

Field Detail

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 mParamNames

mParamDefault

protected static java.util.Hashtable mParamDefault

mParamValue

protected java.util.Hashtable mParamValue
Constructor Detail

AttributePresentConstraints

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

getName

public java.lang.String getName()
Description copied from class: APolicyRule
Returns the name of the policy rule.

Specified by:
getName in interface IPolicyRule
Overrides:
getName in class APolicyRule
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(ISubsystem 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 r)
Description copied from class: APolicyRule
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:
r - The request on which to apply policy.
Returns:
The policy result object.

getInstanceParams

public java.util.Vector 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 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.

log

protected void log(int level,
                   java.lang.String msg)
Description copied from class: APolicyRule
log a message for this policy rule.

Overrides:
log in class APolicyRule