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

Class StaticServiceDiscoveryMechanismCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<StaticServiceDiscoveryMechanismCfgClient,StaticServiceDiscoveryMechanismCfg>

org.forgerock.opendj.server.config.meta.StaticServiceDiscoveryMechanismCfgDefn

public final class StaticServiceDiscoveryMechanismCfgDefn
extends ManagedObjectDefinition<StaticServiceDiscoveryMechanismCfgClient,StaticServiceDiscoveryMechanismCfg>

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

A Static Service Discovery Mechanism returns a fixed list of LDAP directory servers.

Method Summary

Modifier and Type	Method	Description
StaticServiceDiscoveryMechanismCfgClient	createClientConfiguration(ManagedObject<? extends StaticServiceDiscoveryMechanismCfgClient> impl)	Creates a client configuration view of the provided managed object.
StaticServiceDiscoveryMechanismCfg	createServerConfiguration(ServerManagedObject<? extends StaticServiceDiscoveryMechanismCfg> impl)	Creates a server configuration view of the provided server managed object.
DurationPropertyDefinition	getDiscoveryIntervalPropertyDefinition()	Get the "discovery-interval" property definition.
static StaticServiceDiscoveryMechanismCfgDefn	getInstance()	Get the Static 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.
HostPortPropertyDefinition	getPrimaryServerPropertyDefinition()	Get the "primary-server" property definition.
HostPortPropertyDefinition	getSecondaryServerPropertyDefinition()	Get the "secondary-server" property definition.
Class<StaticServiceDiscoveryMechanismCfg>	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, 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 StaticServiceDiscoveryMechanismCfgDefn getInstance()

Get the Static Service Discovery Mechanism configuration definition singleton.

Returns:

Returns the Static Service Discovery Mechanism configuration definition singleton.

createClientConfiguration

public StaticServiceDiscoveryMechanismCfgClient createClientConfiguration(ManagedObject<? extends StaticServiceDiscoveryMechanismCfgClient> 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<StaticServiceDiscoveryMechanismCfgClient,StaticServiceDiscoveryMechanismCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<StaticServiceDiscoveryMechanismCfgClient,StaticServiceDiscoveryMechanismCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<StaticServiceDiscoveryMechanismCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<StaticServiceDiscoveryMechanismCfgClient,StaticServiceDiscoveryMechanismCfg>

Returns:

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

getDiscoveryIntervalPropertyDefinition

public DurationPropertyDefinition getDiscoveryIntervalPropertyDefinition()

Get the "discovery-interval" property definition.

Interval between two server configuration discovery executions.

Specifies how frequently to read the configuration of the servers in order to discover their new information.

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 Static 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 Static Service Discovery Mechanism.

Returns:

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

getPrimaryServerPropertyDefinition

public HostPortPropertyDefinition getPrimaryServerPropertyDefinition()

Get the "primary-server" property definition.

Specifies a list of servers that will be used in preference to secondary servers when available.

When using an IPv6 address as the hostname, put brackets around the address as in "[IPv6Address]:port".

Returns:

Returns the "primary-server" property definition.

getSecondaryServerPropertyDefinition

public HostPortPropertyDefinition getSecondaryServerPropertyDefinition()

Get the "secondary-server" property definition.

Specifies a list of servers that will be used in place of primary servers when all primary servers are unavailable.

When using an IPv6 address as the hostname, put brackets around the address as in "[IPv6Address]:port".

Returns:

Returns the "secondary-server" 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 Static 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 Static 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 Static 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 Static Service Discovery Mechanism should use certificate based authentication when communicating with backend servers.

If enabled, the Static 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 Static Service Discovery Mechanism should use SSL.

If enabled, the Static 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 Static Service Discovery Mechanism should use Start TLS.

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

Returns:

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