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

Class ReplicationServiceDiscoveryMechanismCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<ReplicationServiceDiscoveryMechanismCfgClient,ReplicationServiceDiscoveryMechanismCfg>

org.forgerock.opendj.server.config.meta.ReplicationServiceDiscoveryMechanismCfgDefn

public final class ReplicationServiceDiscoveryMechanismCfgDefn
extends ManagedObjectDefinition<ReplicationServiceDiscoveryMechanismCfgClient,ReplicationServiceDiscoveryMechanismCfg>

An interface for querying the Replication Service Discovery Mechanism managed object definition meta information.

A Replication Service Discovery Mechanism returns the set of directory servers participating in a replication topology.

Method Summary

Modifier and Type	Method	Description
ReplicationServiceDiscoveryMechanismCfgClient	createClientConfiguration(ManagedObject<? extends ReplicationServiceDiscoveryMechanismCfgClient> impl)	Creates a client configuration view of the provided managed object.
ReplicationServiceDiscoveryMechanismCfg	createServerConfiguration(ServerManagedObject<? extends ReplicationServiceDiscoveryMechanismCfg> impl)	Creates a server configuration view of the provided server managed object.
DnPropertyDefinition	getBindDnPropertyDefinition()	Get the "bind-dn" property definition.
StringPropertyDefinition	getBindPasswordPropertyDefinition()	Get the "bind-password" property definition.
HostPortPropertyDefinition	getBootstrapReplicationServerPropertyDefinition()	Get the "bootstrap-replication-server" property definition.
DurationPropertyDefinition	getDiscoveryIntervalPropertyDefinition()	Get the "discovery-interval" property definition.
static ReplicationServiceDiscoveryMechanismCfgDefn	getInstance()	Get the Replication Service Discovery Mechanism configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
AggregationPropertyDefinition<KeyManagerProviderCfgClient,KeyManagerProviderCfg>	getKeyManagerProviderPropertyDefinition()	Get the "key-manager-provider" property definition.
StringPropertyDefinition	getPrimaryGroupIdPropertyDefinition()	Get the "primary-group-id" property definition.
Class<ReplicationServiceDiscoveryMechanismCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
StringPropertyDefinition	getSslCertNicknamePropertyDefinition()	Get the "ssl-cert-nickname" property definition.
StringPropertyDefinition	getSslCipherSuitePropertyDefinition()	Get the "ssl-cipher-suite" property definition.
StringPropertyDefinition	getSslProtocolPropertyDefinition()	Get the "ssl-protocol" property definition.
AggregationPropertyDefinition<TrustManagerProviderCfgClient,TrustManagerProviderCfg>	getTrustManagerProviderPropertyDefinition()	Get the "trust-manager-provider" property definition.
BooleanPropertyDefinition	getUseSaslExternalPropertyDefinition()	Get the "use-sasl-external" property definition.
BooleanPropertyDefinition	getUseSslPropertyDefinition()	Get the "use-ssl" property definition.
BooleanPropertyDefinition	getUseStartTlsPropertyDefinition()	Get the "use-start-tls" property definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static ReplicationServiceDiscoveryMechanismCfgDefn getInstance()

Get the Replication Service Discovery Mechanism configuration definition singleton.

Returns:

Returns the Replication Service Discovery Mechanism configuration definition singleton.

createClientConfiguration

public ReplicationServiceDiscoveryMechanismCfgClient createClientConfiguration(ManagedObject<? extends ReplicationServiceDiscoveryMechanismCfgClient> impl)

Description copied from class: ManagedObjectDefinition

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<ReplicationServiceDiscoveryMechanismCfgClient,ReplicationServiceDiscoveryMechanismCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public ReplicationServiceDiscoveryMechanismCfg createServerConfiguration(ServerManagedObject<? extends ReplicationServiceDiscoveryMechanismCfg> impl)

Description copied from class: ManagedObjectDefinition

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<ReplicationServiceDiscoveryMechanismCfgClient,ReplicationServiceDiscoveryMechanismCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<ReplicationServiceDiscoveryMechanismCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<ReplicationServiceDiscoveryMechanismCfgClient,ReplicationServiceDiscoveryMechanismCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getBindDnPropertyDefinition

public DnPropertyDefinition getBindDnPropertyDefinition()

Get the "bind-dn" property definition.

The bind DN for periodically reading replication server configurations

The bind DN must be present on all replication servers and directory servers, it must be able to read the server configuration.

Returns:

Returns the "bind-dn" property definition.

getBindPasswordPropertyDefinition

public StringPropertyDefinition getBindPasswordPropertyDefinition()

Get the "bind-password" property definition.

The clear-text bind password for periodically reading replication server configurations.

The bind password must be the same on all replication and directory servers.

Returns:

Returns the "bind-password" property definition.

getBootstrapReplicationServerPropertyDefinition

public HostPortPropertyDefinition getBootstrapReplicationServerPropertyDefinition()

Get the "bootstrap-replication-server" property definition.

The addresses of one or more replication servers within the topology which this server should connect to in order to discover the rest of the topology.

Addresses must be specified using the administration port of the remote replication servers using the syntax "hostname:admin-port". When using an IPv6 address as the hostname, put brackets around the address as in "[IPv6Address]:admin-port".

Returns:

Returns the "bootstrap-replication-server" property definition.

getDiscoveryIntervalPropertyDefinition

public DurationPropertyDefinition getDiscoveryIntervalPropertyDefinition()

Get the "discovery-interval" property definition.

Interval between two replication server configuration discovery queries.

Specifies how frequently to query a replication server configuration in order to discover information about available directory server replicas.

Returns:

Returns the "discovery-interval" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.

getKeyManagerProviderPropertyDefinition

public AggregationPropertyDefinition<KeyManagerProviderCfgClient,KeyManagerProviderCfg> getKeyManagerProviderPropertyDefinition()

Get the "key-manager-provider" property definition.

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

Returns:

Returns the "key-manager-provider" property definition.

getPrimaryGroupIdPropertyDefinition

public StringPropertyDefinition getPrimaryGroupIdPropertyDefinition()

Get the "primary-group-id" property definition.

Replication domain group ID of preferred directory server replicas.

Directory server replicas with this replication domain group ID will be preferred over other directory server replicas. Secondary server replicas will only be used when all primary server replicas become unavailable.

Returns:

Returns the "primary-group-id" property definition.

getSslCertNicknamePropertyDefinition

public StringPropertyDefinition getSslCertNicknamePropertyDefinition()

Get the "ssl-cert-nickname" property definition.

Specifies the nicknames (also called the aliases) of the keys or key pairs that the Replication 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 Replication Service Discovery Mechanism is configured to use SSL.

Returns:

Returns the "ssl-cert-nickname" property definition.

getSslCipherSuitePropertyDefinition

public StringPropertyDefinition getSslCipherSuitePropertyDefinition()

Get the "ssl-cipher-suite" property definition.

Specifies the names of the SSL cipher suites that are allowed for use in SSL or TLS communication.

Returns:

Returns the "ssl-cipher-suite" property definition.

getSslProtocolPropertyDefinition

public StringPropertyDefinition getSslProtocolPropertyDefinition()

Get the "ssl-protocol" property definition.

Specifies the names of the SSL protocols that are allowed for use in SSL or TLS communication.

Returns:

Returns the "ssl-protocol" property definition.

getTrustManagerProviderPropertyDefinition

public AggregationPropertyDefinition<TrustManagerProviderCfgClient,TrustManagerProviderCfg> getTrustManagerProviderPropertyDefinition()

Get the "trust-manager-provider" property definition.

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

Returns:

Returns the "trust-manager-provider" property definition.

getUseSaslExternalPropertyDefinition

public BooleanPropertyDefinition getUseSaslExternalPropertyDefinition()

Get the "use-sasl-external" property definition.

Indicates whether the Replication Service Discovery Mechanism should use certificate based authentication when communicating with backend servers.

If enabled, the Replication Service Discovery Mechanism will use mutual TLS when connecting to backend servers. Once the TLS handshake has completed, a SASL/External LDAP bind request will be sent in order to associate the TLS client certificate with an LDAP account on the remote backend server. A key manager provider containing the client certificate must be configured in order to use this feature.

Returns:

Returns the "use-sasl-external" property definition.

getUseSslPropertyDefinition

public BooleanPropertyDefinition getUseSslPropertyDefinition()

Get the "use-ssl" property definition.

Indicates whether the Replication Service Discovery Mechanism should use SSL.

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

Returns:

Returns the "use-ssl" property definition.

getUseStartTlsPropertyDefinition

public BooleanPropertyDefinition getUseStartTlsPropertyDefinition()

Get the "use-start-tls" property definition.

Indicates whether the Replication Service Discovery Mechanism should use Start TLS.

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

Returns:

Returns the "use-start-tls" property definition.