com.netscape.cms.publish.mappers
Class LdapCertExactMap

java.lang.Object
  com.netscape.cms.publish.mappers.LdapCertExactMap

All Implemented Interfaces:

IExtendedPluginInfo, ILdapMapper, ILdapPlugin

public class LdapCertExactMap
extends java.lang.Object
implements ILdapMapper, IExtendedPluginInfo

Maps a X509 certificate to a LDAP entry by using the subject name of the certificate as the LDAP entry DN.

Version:

$Revision: 1211 $, $Date: 2010-08-18 10:15:37 -0700 (Wed, 18 Aug 2010) $

Field Summary

protected IConfigStore

mConfig

Fields inherited from interface com.netscape.certsrv.base.IExtendedPluginInfo

HELP_TEXT, HELP_TOKEN

Constructor Summary

LdapCertExactMap()
constructs a certificate subject name mapper with search base.

Method Summary

IConfigStore	getConfigStore() Return config store.
java.util.Vector	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	getInstanceParams() Returns the current instance parameters.
void	init(IConfigStore config) Initialize from config store.
java.lang.String	map(netscape.ldap.LDAPConnection conn, IRequest req, java.lang.Object obj) maps a certificate to a LDAP entry.
java.lang.String	map(netscape.ldap.LDAPConnection conn, java.lang.Object obj) Finds the entry for the certificate by looking for the cert subject name in the subject name attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mConfig

protected IConfigStore mConfig

Constructor Detail

LdapCertExactMap

public LdapCertExactMap()

constructs a certificate subject name mapper with search base.

Method Detail

getConfigStore

public IConfigStore getConfigStore()

Description copied from interface: ILdapPlugin

Return config store.

Specified by:

getConfigStore in interface ILdapPlugin

init

public void init(IConfigStore config)
          throws EBaseException

Description copied from interface: ILdapPlugin

Initialize from config store.

Specified by:

init in interface ILdapPlugin

Parameters:

config - the configuration store to initialize from.

Throws:

ELdapException - initialization failed due to Ldap error.

EBaseException - initialization failed.

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

getImplName

public java.lang.String getImplName()

Description copied from interface: ILdapMapper

Returns implementation name.

Specified by:

getImplName in interface ILdapMapper

getDescription

public java.lang.String getDescription()

Description copied from interface: ILdapMapper

Returns the description of this mapper.

Specified by:

getDescription in interface ILdapMapper

getDefaultParams

public java.util.Vector getDefaultParams()

Description copied from interface: ILdapMapper

Returns the initial default parameters.

Specified by:

getDefaultParams in interface ILdapMapper

getInstanceParams

public java.util.Vector getInstanceParams()

Description copied from interface: ILdapMapper

Returns the current instance parameters.

Specified by:

getInstanceParams in interface ILdapMapper

map

public java.lang.String map(netscape.ldap.LDAPConnection conn,
                            java.lang.Object obj)
                     throws ELdapException

Finds the entry for the certificate by looking for the cert subject name in the subject name attribute.

Specified by:

map in interface ILdapMapper

Parameters:

conn - - the LDAP connection.

obj - - the X509Certificate.

Returns:

dn indicates whether a mapping was successful

Throws:

ELdapException - Map operation failed.

map

public java.lang.String map(netscape.ldap.LDAPConnection conn,
                            IRequest req,
                            java.lang.Object obj)
                     throws ELdapException

Description copied from interface: ILdapMapper

maps a certificate to a LDAP entry. returns dn of the mapped LDAP entry.

Specified by:

map in interface ILdapMapper

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 - Map operation failed.