Class LdapSimpleMap

java.lang.Object
com.netscape.cms.publish.mappers.LdapSimpleMap
All Implemented Interfaces:
IExtendedPluginInfo, ILdapMapper, ILdapPlugin
public class LdapSimpleMap extends 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 Details

  • Constructor Details

    • LdapSimpleMap

      public LdapSimpleMap(String dnPattern)
      Constructor.
      Parameters:
      dnPattern - The base DN.

    • LdapSimpleMap

      public LdapSimpleMap()
      constructor if initializing from config store.

  • Method Details

    • getExtendedPluginInfo

      public String[] getExtendedPluginInfo(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 interface IExtendedPluginInfo

    • 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
      for initializing from config store.
      Specified by:
      init in interface ILdapPlugin
      Parameters:
      config - the configuration store to initialize from.
      Throws:
      EBaseException - initialization failed.

    • init

      protected void init(String dnPattern) throws EBaseException
      common initialization routine.
      Throws:
      EBaseException

    • map

      public String map(netscape.ldap.LDAPConnection conn, 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 interface ILdapMapper
      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 String map(netscape.ldap.LDAPConnection conn, IRequest req, 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 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 - if any LDAP exceptions occured.

    • getImplName

      public String getImplName()
      Description copied from interface: ILdapMapper
      Returns implementation name.
      Specified by:
      getImplName in interface ILdapMapper

    • getDescription

      public String getDescription()
      Description copied from interface: ILdapMapper
      Returns the description of this mapper.
      Specified by:
      getDescription in interface ILdapMapper

    • getDefaultParams

      public Vector<String> getDefaultParams()
      Description copied from interface: ILdapMapper
      Returns the initial default parameters.
      Specified by:
      getDefaultParams in interface ILdapMapper

    • getInstanceParams

      public Vector<String> getInstanceParams()
      Description copied from interface: ILdapMapper
      Returns the current instance parameters.
      Specified by:
      getInstanceParams in interface ILdapMapper