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

Interface LDAPTrustManagerProviderCfg

All Superinterfaces:

Configuration, TrustManagerProviderCfg

public interface LDAPTrustManagerProviderCfg
extends TrustManagerProviderCfg

A server-side interface for querying LDAP Trust Manager Provider settings.

The LDAP trust manager provider determines whether to trust a presented certificate based on whether that certificate exists in an LDAP key store managed by the server.

Method Summary

Modifier and Type	Method	Description
void	addLDAPChangeListener(ConfigurationChangeListener<LDAPTrustManagerProviderCfg> listener)	Register to be notified when this LDAP Trust Manager Provider is changed.
Class<? extends LDAPTrustManagerProviderCfg>	configurationClass()	Gets the configuration class associated with this LDAP Trust Manager Provider.
org.forgerock.opendj.ldap.DN	getBaseDN()	Gets the "base-dn" property.
String	getJavaClass()	Gets the "java-class" property.
String	getTrustStorePin()	Gets the "trust-store-pin" property.
String	getTrustStorePinEnvironmentVariable()	Gets the "trust-store-pin-environment-variable" property.
String	getTrustStorePinFile()	Gets the "trust-store-pin-file" property.
String	getTrustStorePinProperty()	Gets the "trust-store-pin-property" property.
void	removeLDAPChangeListener(ConfigurationChangeListener<LDAPTrustManagerProviderCfg> listener)	Deregister an existing LDAP Trust 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.TrustManagerProviderCfg

addChangeListener, isEnabled, removeChangeListener

Method Detail

configurationClass

Class<? extends LDAPTrustManagerProviderCfg> configurationClass()

Gets the configuration class associated with this LDAP Trust Manager Provider.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface TrustManagerProviderCfg

Returns:

Returns the configuration class associated with this LDAP Trust Manager Provider.

addLDAPChangeListener

void addLDAPChangeListener(ConfigurationChangeListener<LDAPTrustManagerProviderCfg> listener)

Register to be notified when this LDAP Trust Manager Provider is changed.

Parameters:

listener - The LDAP Trust Manager Provider configuration change listener.

removeLDAPChangeListener

void removeLDAPChangeListener(ConfigurationChangeListener<LDAPTrustManagerProviderCfg> listener)

Deregister an existing LDAP Trust Manager Provider configuration change listener.

Parameters:

listener - The LDAP Trust 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 Trust Manager Provider implementation.

Specified by:

getJavaClass in interface TrustManagerProviderCfg

Returns:

Returns the value of the "java-class" property.

getTrustStorePin

String getTrustStorePin()

Gets the "trust-store-pin" property.

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

Returns:

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

getTrustStorePinEnvironmentVariable

String getTrustStorePinEnvironmentVariable()

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

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

Returns:

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

getTrustStorePinFile

String getTrustStorePinFile()

Gets the "trust-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 Trust Manager Provider .

Returns:

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

getTrustStorePinProperty

String getTrustStorePinProperty()

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

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

Returns:

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