Package org.forgerock.opendj.server.config.server

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 Summary

Modifier and Type	Method	Description
void	addLDAPChangeListener(ConfigurationChangeListener<LDAPKeyManagerProviderCfg> listener)	Register to be notified when this LDAP Key Manager Provider is changed.
Class<? extends LDAPKeyManagerProviderCfg>	configurationClass()	Gets the configuration class associated with this LDAP Key Manager Provider.
org.forgerock.opendj.ldap.DN	getBaseDN()	Gets the "base-dn" property.
String	getJavaClass()	Gets the "java-class" property.
String	getKeyStorePin()	Gets the "key-store-pin" property.
String	getKeyStorePinEnvironmentVariable()	Gets the "key-store-pin-environment-variable" property.
String	getKeyStorePinFile()	Gets the "key-store-pin-file" property.
String	getKeyStorePinProperty()	Gets the "key-store-pin-property" property.
void	removeLDAPChangeListener(ConfigurationChangeListener<LDAPKeyManagerProviderCfg> listener)	Deregister an existing LDAP Key Manager Provider configuration change listener.

Methods inherited from interface org.forgerock.opendj.config.Configuration

dn, name

Methods inherited from interface org.forgerock.opendj.server.config.server.KeyManagerProviderCfg

addChangeListener, isEnabled, removeChangeListener

Method Detail

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

org.forgerock.opendj.ldap.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.

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 .

Returns:

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

getKeyStorePinEnvironmentVariable

String getKeyStorePinEnvironmentVariable()

Gets the "key-store-pin-environment-variable" property.

Specifies the name of the environment variable that contains the clear-text PIN needed to access the LDAP Key Manager Provider .

Returns:

Returns the value of the "key-store-pin-environment-variable" property.

getKeyStorePinFile

String getKeyStorePinFile()

Gets the "key-store-pin-file" property.

Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the LDAP Key Manager Provider .

Returns:

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

getKeyStorePinProperty

String getKeyStorePinProperty()

Gets the "key-store-pin-property" property.

Specifies the name of the Java property that contains the clear-text PIN needed to access the LDAP Key Manager Provider .

Returns:

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