org.forgerock.opendj.server.config.server

Interface ServiceDiscoveryMechanismCfg

All Superinterfaces:

Configuration

All Known Subinterfaces:

ReplicationServiceDiscoveryMechanismCfg, StaticServiceDiscoveryMechanismCfg

public interface ServiceDiscoveryMechanismCfg
extends Configuration

A server-side interface for querying Service Discovery Mechanism settings.

A Service Discovery Mechanism identifies a set of LDAP servers for load balancing

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ConfigurationChangeListener<ServiceDiscoveryMechanismCfg> listener) Register to be notified when this Service Discovery Mechanism is changed.
Class<? extends ServiceDiscoveryMechanismCfg>	configurationClass() Gets the configuration class associated with this Service Discovery Mechanism.
String	getJavaClass() Gets the "java-class" property.
String	getKeyManagerProvider() Gets the "key-manager-provider" property.
org.forgerock.opendj.ldap.DN	getKeyManagerProviderDN() Gets the "key-manager-provider" property as a DN.
SortedSet<String>	getSSLCertNickname() Gets the "ssl-cert-nickname" property.
String	getTrustManagerProvider() Gets the "trust-manager-provider" property.
org.forgerock.opendj.ldap.DN	getTrustManagerProviderDN() Gets the "trust-manager-provider" property as a DN.
boolean	isUseSSL() Gets the "use-ssl" property.
boolean	isUseStartTLS() Gets the "use-start-tls" property.
void	removeChangeListener(ConfigurationChangeListener<ServiceDiscoveryMechanismCfg> listener) Deregister an existing Service Discovery Mechanism configuration change listener.

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

dn, name

Method Detail

configurationClass

Class<? extends ServiceDiscoveryMechanismCfg> configurationClass()

Gets the configuration class associated with this Service Discovery Mechanism.

Specified by:

configurationClass in interface Configuration

Returns:

Returns the configuration class associated with this Service Discovery Mechanism.

addChangeListener

void addChangeListener(ConfigurationChangeListener<ServiceDiscoveryMechanismCfg> listener)

Register to be notified when this Service Discovery Mechanism is changed.

Parameters:

listener - The Service Discovery Mechanism configuration change listener.

removeChangeListener

void removeChangeListener(ConfigurationChangeListener<ServiceDiscoveryMechanismCfg> listener)

Deregister an existing Service Discovery Mechanism configuration change listener.

Parameters:

listener - The Service Discovery Mechanism configuration change listener.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Service Discovery Mechanism implementation.

Returns:

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

getKeyManagerProvider

String getKeyManagerProvider()

Gets the "key-manager-provider" property.

Specifies the name of the key manager that should be used with this Service Discovery Mechanism.

Returns:

Returns the value of the "key-manager-provider" property.

getKeyManagerProviderDN

org.forgerock.opendj.ldap.DN getKeyManagerProviderDN()

Gets the "key-manager-provider" property as a DN.

Specifies the name of the key manager that should be used with this Service Discovery Mechanism.

Returns:

Returns the DN value of the "key-manager-provider" property.

getSSLCertNickname

SortedSet<String> getSSLCertNickname()

Gets the "ssl-cert-nickname" property.

Specifies the nicknames (also called the aliases) of the keys or key pairs that the Service Discovery Mechanism should use when performing SSL communication. The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key.

This is only applicable when the Service Discovery Mechanism is configured to use SSL.

Returns:

Returns an unmodifiable set containing the values of the "ssl-cert-nickname" property.

getTrustManagerProvider

String getTrustManagerProvider()

Gets the "trust-manager-provider" property.

Specifies the name of the trust manager that should be used with the Service Discovery Mechanism.

Returns:

Returns the value of the "trust-manager-provider" property.

getTrustManagerProviderDN

org.forgerock.opendj.ldap.DN getTrustManagerProviderDN()

Gets the "trust-manager-provider" property as a DN.

Specifies the name of the trust manager that should be used with the Service Discovery Mechanism.

Returns:

Returns the DN value of the "trust-manager-provider" property.

isUseSSL

boolean isUseSSL()

Gets the "use-ssl" property.

Indicates whether the Service Discovery Mechanism should use SSL.

If enabled, the Service Discovery Mechanism will use SSL to encrypt communication with the clients.

Returns:

Returns the value of the "use-ssl" property.

isUseStartTLS

boolean isUseStartTLS()

Gets the "use-start-tls" property.

Indicates whether the Service Discovery Mechanism should use Start TLS.

If enabled, the Service Discovery Mechanism will use Start TLS to encrypt communication with remote servers.

Returns:

Returns the value of the "use-start-tls" property.