Package com.netscape.cms.publish.mappers
Class LdapCaSimpleMap
- java.lang.Object
-
- com.netscape.cms.publish.mappers.LdapCaSimpleMap
-
- All Implemented Interfaces:
IExtendedPluginInfo
,ILdapMapper
,ILdapPlugin
public class LdapCaSimpleMap extends java.lang.Object implements ILdapMapper, IExtendedPluginInfo
Maps a request to an entry in the LDAP server. Takes a dnPattern to form the baseDN from the request attributes and certificate subject name.Do a base search for the entry in the directory to publish the cert or crl. The restriction of this mapper is that the ldap dn components must be part of certificate subject name or request attributes or constant.- Version:
- $Revision$, $Date$
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DEFAULT_DNPATTERN
static org.slf4j.Logger
logger
protected java.lang.String[]
mCertAttrs
protected IConfigStore
mConfig
protected boolean
mCreateCAEntry
protected java.lang.String
mDnPattern
protected MapDNPattern
mPattern
protected java.lang.String[]
mReqAttrs
protected static java.lang.String
PROP_CREATECA
protected static java.lang.String
PROP_DNPATTERN
-
Fields inherited from interface com.netscape.certsrv.base.IExtendedPluginInfo
HELP_TEXT, HELP_TOKEN
-
-
Constructor Summary
Constructors Constructor Description LdapCaSimpleMap()
constructor if initializing from config store.LdapCaSimpleMap(java.lang.String dnPattern)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IConfigStore
getConfigStore()
Return config store.java.util.Vector<java.lang.String>
getDefaultParams()
Returns the initial default parameters.java.lang.String
getDescription()
Returns the description of this mapper.java.lang.String[]
getExtendedPluginInfo(java.util.Locale locale)
This method returns an array of strings.java.lang.String
getImplName()
Returns implementation name.java.util.Vector<java.lang.String>
getInstanceParams()
Returns the current instance parameters.void
init(IConfigStore config)
for initializing from config store.protected void
init(java.lang.String dnPattern)
common initialization routine.java.lang.String
map(netscape.ldap.LDAPConnection conn, IRequest req, java.lang.Object obj)
Maps a X500 subject name to LDAP entry.java.lang.String
map(netscape.ldap.LDAPConnection conn, java.lang.Object obj)
Maps a X500 subject name to LDAP entry.
-
-
-
Field Detail
-
logger
public static org.slf4j.Logger logger
-
PROP_DNPATTERN
protected static final java.lang.String PROP_DNPATTERN
- See Also:
- Constant Field Values
-
PROP_CREATECA
protected static final java.lang.String PROP_CREATECA
- See Also:
- Constant Field Values
-
mDnPattern
protected java.lang.String mDnPattern
-
mCreateCAEntry
protected boolean mCreateCAEntry
-
mConfig
protected IConfigStore mConfig
-
mPattern
protected MapDNPattern mPattern
-
mReqAttrs
protected java.lang.String[] mReqAttrs
-
mCertAttrs
protected java.lang.String[] mCertAttrs
-
DEFAULT_DNPATTERN
public static final java.lang.String DEFAULT_DNPATTERN
- See Also:
- Constant Field Values
-
-
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 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
-
getConfigStore
public IConfigStore getConfigStore()
Description copied from interface:ILdapPlugin
Return config store.- Specified by:
getConfigStore
in interfaceILdapPlugin
-
init
public void init(IConfigStore config) throws EBaseException
for initializing from config store.- Specified by:
init
in interfaceILdapPlugin
- Parameters:
config
- the configuration store to initialize from.- Throws:
ELdapException
- initialization failed due to Ldap error.EBaseException
- initialization failed.
-
init
protected void init(java.lang.String dnPattern) throws EBaseException
common initialization routine.- Throws:
EBaseException
-
map
public java.lang.String map(netscape.ldap.LDAPConnection conn, java.lang.Object obj) throws ELdapException
Maps a X500 subject name to LDAP entry. Uses DN pattern to form a DN for a LDAP base search.- Specified by:
map
in interfaceILdapMapper
- Parameters:
conn
- the LDAP connection.obj
- the object to map.- Returns:
- dn indicates whether a mapping was successful
- Throws:
ELdapException
- if any LDAP exceptions occured.
-
map
public java.lang.String map(netscape.ldap.LDAPConnection conn, IRequest req, java.lang.Object obj) throws ELdapException
Maps a X500 subject name to LDAP entry. Uses DN pattern to form a DN for a LDAP base search.- Specified by:
map
in interfaceILdapMapper
- Parameters:
conn
- the LDAP connection.req
- the request to map.obj
- the object to map.- Returns:
- dn indicates whether a mapping was successful
- Throws:
ELdapException
- if any LDAP exceptions occured.
-
getImplName
public java.lang.String getImplName()
Description copied from interface:ILdapMapper
Returns implementation name.- Specified by:
getImplName
in interfaceILdapMapper
-
getDescription
public java.lang.String getDescription()
Description copied from interface:ILdapMapper
Returns the description of this mapper.- Specified by:
getDescription
in interfaceILdapMapper
-
getDefaultParams
public java.util.Vector<java.lang.String> getDefaultParams()
Description copied from interface:ILdapMapper
Returns the initial default parameters.- Specified by:
getDefaultParams
in interfaceILdapMapper
-
getInstanceParams
public java.util.Vector<java.lang.String> getInstanceParams()
Description copied from interface:ILdapMapper
Returns the current instance parameters.- Specified by:
getInstanceParams
in interfaceILdapMapper
-
-