Package com.netscape.cmscore.ldap
Class LdapRule
java.lang.Object
com.netscape.cmscore.ldap.LdapRule
- All Implemented Interfaces:
IExtendedPluginInfo
The publishing rule which associates a Publisher with a Mapper.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic org.slf4j.Logger
protected ILdapExpression
static final String
static final String
static final String
static final String
Fields inherited from interface com.netscape.certsrv.base.IExtendedPluginInfo
HELP_TEXT, HELP_TOKEN
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
enabled()
Returns true if the rule is enabled, false if it's disabled.Returns the initial default parameters.Returns the description of the LDAP publisher.String[]
This method returns an array of strings.Returns the implementation name.Returns the instance name.Returns the current instance parameters.Returns the predicate expression for the rule.getType()
void
init
(ConfigStore config) The init method in ILdapPlugin It can not set set mapper,publisher choice for console dynamicly Should not use this method to init.void
init
(PublisherProcessor processor, ConfigStore config) Initialize the plugin.void
setInstanceName
(String insName) Sets the instance name.void
Sets a predicate expression for rule matching.
-
Field Details
-
logger
public static org.slf4j.Logger logger -
PROP_PREDICATE
- See Also:
-
PROP_ENABLE
- See Also:
-
PROP_IMPLNAME
- See Also:
-
NOMAPPER
- See Also:
-
mFilterExp
-
-
Constructor Details
-
LdapRule
public LdapRule()
-
-
Method Details
-
getConfigStore
-
getExtendedPluginInfo
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 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
-
init
Initialize the plugin.- Throws:
EBaseException
- Initialization failed.
-
init
The init method in ILdapPlugin It can not set set mapper,publisher choice for console dynamicly Should not use this method to init.- Throws:
EBaseException
-
getImplName
Returns the implementation name. -
getDescription
Returns the description of the LDAP publisher. -
setInstanceName
Sets the instance name. -
getInstanceName
Returns the instance name. -
getInstanceParams
Returns the current instance parameters. -
setPredicate
Sets a predicate expression for rule matching.- Parameters:
exp
- The predicate expression for the rule.
-
getPredicate
Returns the predicate expression for the rule.- Returns:
- The predicate expression for the rule.
-
getMapper
-
getPublisher
-
getType
-
enabled
public boolean enabled()Returns true if the rule is enabled, false if it's disabled. -
getDefaultParams
Returns the initial default parameters.
-