org.forgerock.opendj.server.config.client

Interface StaticServiceDiscoveryMechanismCfgClient

All Superinterfaces:

ConfigurationClient, ServiceDiscoveryMechanismCfgClient

public interface StaticServiceDiscoveryMechanismCfgClient
extends ServiceDiscoveryMechanismCfgClient

A client-side interface for reading and modifying Static Service Discovery Mechanism settings.

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

Method Summary

Modifier and Type	Method and Description
ManagedObjectDefinition<? extends StaticServiceDiscoveryMechanismCfgClient,? extends StaticServiceDiscoveryMechanismCfg>	definition() Get the configuration definition associated with this Static Service Discovery Mechanism.
long	getDiscoveryInterval() Gets the "discovery-interval" property.
String	getJavaClass() Gets the "java-class" property.
SortedSet<String>	getPrimaryServer() Gets the "primary-server" property.
SortedSet<String>	getSecondaryServer() Gets the "secondary-server" property.
void	setDiscoveryInterval(Long value) Sets the "discovery-interval" property.
void	setJavaClass(String value) Sets the "java-class" property.
void	setPrimaryServer(Collection<String> values) Sets the "primary-server" property.
void	setSecondaryServer(Collection<String> values) Sets the "secondary-server" property.

Methods inherited from interface org.forgerock.opendj.server.config.client.ServiceDiscoveryMechanismCfgClient

getKeyManagerProvider, getSSLCertNickname, getTrustManagerProvider, isUseSSL, isUseStartTLS, setKeyManagerProvider, setSSLCertNickname, setTrustManagerProvider, setUseSSL, setUseStartTLS

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

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends StaticServiceDiscoveryMechanismCfgClient,? extends StaticServiceDiscoveryMechanismCfg> definition()

Get the configuration definition associated with this Static Service Discovery Mechanism.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface ServiceDiscoveryMechanismCfgClient

Returns:

Returns the configuration definition associated with this Static Service Discovery Mechanism.

getDiscoveryInterval

long getDiscoveryInterval()

Gets the "discovery-interval" property.

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 value of the "discovery-interval" property.

setDiscoveryInterval

void setDiscoveryInterval(Long value)
                   throws PropertyException

Sets the "discovery-interval" property.

Interval between two server configuration discovery executions.

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

Parameters:

value - The value of the "discovery-interval" property.

Throws:

PropertyException - If the new value is invalid.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

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

Specified by:

getJavaClass in interface ServiceDiscoveryMechanismCfgClient

Returns:

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

setJavaClass

void setJavaClass(String value)
           throws PropertyException

Sets the "java-class" property.

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

Specified by:

setJavaClass in interface ServiceDiscoveryMechanismCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getPrimaryServer

SortedSet<String> getPrimaryServer()

Gets the "primary-server" property.

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

Returns:

Returns the values of the "primary-server" property.

setPrimaryServer

void setPrimaryServer(Collection<String> values)
               throws PropertyException

Sets the "primary-server" property.

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

Parameters:

values - The values of the "primary-server" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getSecondaryServer

SortedSet<String> getSecondaryServer()

Gets the "secondary-server" property.

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

Returns:

Returns the values of the "secondary-server" property.

setSecondaryServer

void setSecondaryServer(Collection<String> values)
                 throws PropertyException

Sets the "secondary-server" property.

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

Parameters:

values - The values of the "secondary-server" property.

Throws:

PropertyException - If one or more of the new values are invalid.