Interface LdapKeyManagerProviderCfg

All Superinterfaces:
Configuration, KeyManagerProviderCfg

public interface LdapKeyManagerProviderCfg extends KeyManagerProviderCfg
A server-side interface for querying LDAP Key Manager Provider settings.

The LDAP key manager provider uses an LDAP key store managed by the server to obtain server certificates.

  • Method Details

    • configurationClass

      Class<? extends LdapKeyManagerProviderCfg> configurationClass()
      Gets the configuration class associated with this LDAP Key Manager Provider.
      Specified by:
      configurationClass in interface Configuration
      Specified by:
      configurationClass in interface KeyManagerProviderCfg
      Returns:
      Returns the configuration class associated with this LDAP Key Manager Provider.
    • addLdapChangeListener

      void addLdapChangeListener(ConfigurationChangeListener<LdapKeyManagerProviderCfg> listener)
      Register to be notified when this LDAP Key Manager Provider is changed.
      Parameters:
      listener - The LDAP Key Manager Provider configuration change listener.
    • removeLdapChangeListener

      void removeLdapChangeListener(ConfigurationChangeListener<LdapKeyManagerProviderCfg> listener)
      Deregister an existing LDAP Key Manager Provider configuration change listener.
      Parameters:
      listener - The LDAP Key Manager Provider configuration change listener.
    • getBaseDn

      Dn getBaseDn()
      Gets the "base-dn" property.

      The base DN beneath which LDAP key store entries are located.

      Returns:
      Returns the value of the "base-dn" property.
    • getJavaClass

      String getJavaClass()
      Gets the "java-class" property.

      The fully-qualified name of the Java class that provides the LDAP Key Manager Provider implementation.

      Default value: org.opends.server.extensions.LDAPKeyManagerProvider

      Specified by:
      getJavaClass in interface KeyManagerProviderCfg
      Returns:
      Returns the value of the "java-class" property.
    • getKeyStorePin

      String getKeyStorePin()
      Gets the "key-store-pin" property.

      Specifies the clear-text PIN needed to access the LDAP Key Manager Provider .

      Default value is undefined

      Returns:
      Returns the value of the "key-store-pin" property.