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

Class ServiceDiscoveryMechanismCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<ServiceDiscoveryMechanismCfgClient,ServiceDiscoveryMechanismCfg>

org.forgerock.opendj.server.config.meta.ServiceDiscoveryMechanismCfgDefn

public final class ServiceDiscoveryMechanismCfgDefn
extends ManagedObjectDefinition<ServiceDiscoveryMechanismCfgClient,ServiceDiscoveryMechanismCfg>

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

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

Method Summary

Modifier and Type	Method	Description
ServiceDiscoveryMechanismCfgClient	createClientConfiguration(ManagedObject<? extends ServiceDiscoveryMechanismCfgClient> impl)	Creates a client configuration view of the provided managed object.
ServiceDiscoveryMechanismCfg	createServerConfiguration(ServerManagedObject<? extends ServiceDiscoveryMechanismCfg> impl)	Creates a server configuration view of the provided server managed object.
static ServiceDiscoveryMechanismCfgDefn	getInstance()	Get the 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.
Class<ServiceDiscoveryMechanismCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
StringPropertyDefinition	getSSLCertNicknamePropertyDefinition()	Get the "ssl-cert-nickname" property definition.
AggregationPropertyDefinition<TrustManagerProviderCfgClient,TrustManagerProviderCfg>	getTrustManagerProviderPropertyDefinition()	Get the "trust-manager-provider" 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, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, 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 ServiceDiscoveryMechanismCfgDefn getInstance()

Get the Service Discovery Mechanism configuration definition singleton.

Returns:

Returns the Service Discovery Mechanism configuration definition singleton.

createClientConfiguration

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

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<ServiceDiscoveryMechanismCfgClient,ServiceDiscoveryMechanismCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<ServiceDiscoveryMechanismCfgClient,ServiceDiscoveryMechanismCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<ServiceDiscoveryMechanismCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<ServiceDiscoveryMechanismCfgClient,ServiceDiscoveryMechanismCfg>

Returns:

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

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

Specifies the fully-qualified name of the Java class that provides the 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 Service Discovery Mechanism.

Returns:

Returns the "key-manager-provider" 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 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 the "ssl-cert-nickname" 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 Service Discovery Mechanism.

Returns:

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

getUseSSLPropertyDefinition

public BooleanPropertyDefinition getUseSSLPropertyDefinition()

Get the "use-ssl" property definition.

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 "use-ssl" property definition.

getUseStartTLSPropertyDefinition

public BooleanPropertyDefinition getUseStartTLSPropertyDefinition()

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

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 "use-start-tls" property definition.