Class LdapCertificatePairPublisher

java.lang.Object
com.netscape.cms.publish.publishers.LdapCertificatePairPublisher
All Implemented Interfaces:
IExtendedPluginInfo, ILdapPlugin, ILdapPublisher
public class LdapCertificatePairPublisher extends Object implements ILdapPublisher, IExtendedPluginInfo
module for publishing a cross certificate pair to ldap crossCertificatePair attribute
Version:
$Revision$, $Date$

  • Field Details

  • Constructor Details

    • LdapCertificatePairPublisher

      public LdapCertificatePairPublisher()
      constructor constructs default values.

    • LdapCertificatePairPublisher

      public LdapCertificatePairPublisher(String crossCertPairAttr, String caObjectclass)

  • 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

    • getImplName

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

    • getDescription

      public String getDescription()
      Description copied from interface: ILdapPublisher
      Returns the description of the publisher.
      Specified by:
      getDescription in interface ILdapPublisher

    • getInstanceParams

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

    • getInstanceParamsWithExtras

      public Vector<String> getInstanceParamsWithExtras()

    • getDefaultParams

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

    • 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:
      EBaseException - initialization failed.

    • getCAObjectclass

      public String getCAObjectclass()
      Gets the Certificate Authority object class to convert to.

    • getXCertAttrName

      public String getXCertAttrName()
      returns the cross cert pair attribute where it'll be published.

    • publish

      public void publish(netscape.ldap.LDAPConnection conn, String dn, Object pair) throws ELdapException
      publish a certificatePair -should not be called from listeners.
      Specified by:
      publish in interface ILdapPublisher
      Parameters:
      conn - the LDAP connection
      dn - dn of the entry to publish the XcertificatePair
      pair - the Xcertificate bytes object.
      Throws:
      ELdapException - publish failed.

    • publish

      public void publish(netscape.ldap.LDAPConnection conn, String dn, byte[] pair) throws ELdapException
      publish a certificatePair -should not be called from listeners.
      Parameters:
      conn - the LDAP connection
      dn - dn of the entry to publish the XcertificatePair
      pair - the cross cert bytes
      Throws:
      ELdapException

    • unpublish

      public void unpublish(netscape.ldap.LDAPConnection conn, String dn, Object certObj) throws ELdapException
      unsupported
      Specified by:
      unpublish in interface ILdapPublisher
      Parameters:
      conn - the Ldap connection (null for non-LDAP publishing)
      dn - dn of the ldap entry to unpublish cert (null for non-LDAP publishing)
      certObj - object to unpublish (java.security.cert.X509Certificate)
      Throws:
      ELdapException - unpublish failed.