Package com.mongodb.connection

Class ClusterSettings

java.lang.Object

com.mongodb.connection.ClusterSettings

@Immutable
public final class ClusterSettings
extends java.lang.Object

Settings for the cluster.

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusterSettings.Builder A builder for the cluster settings.

Method Summary

Modifier and Type	Method and Description
static ClusterSettings.Builder	builder() Get a builder for this class.
static ClusterSettings.Builder	builder(ClusterSettings clusterSettings) Creates a builder instance.
boolean	equals(java.lang.Object o)
java.util.List<ClusterListener>	getClusterListeners() Gets the cluster listeners.
java.lang.String	getDescription() Gets the user defined description of the MongoClient.
java.util.List<ServerAddress>	getHosts() Gets the seed list of hosts for the cluster.
int	getMaxWaitQueueSize() This is the maximum number of threads that may be waiting for a connection to become available from the pool.
ClusterConnectionMode	getMode() Gets the mode.
ClusterType	getRequiredClusterType() Get
java.lang.String	getRequiredReplicaSetName() Gets the required replica set name.
long	getServerSelectionTimeout(java.util.concurrent.TimeUnit timeUnit) Gets the timeout to apply when selecting a server.
ServerSelector	getServerSelector() Gets the ServerSelector that will be uses as the final server selector that is applied in calls to Cluster.selectServer.
java.lang.String	getShortDescription() Returns a short, pretty description for these ClusterSettings.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static ClusterSettings.Builder builder()

Get a builder for this class.

Returns:

a new Builder for creating ClusterSettings.

builder

public static ClusterSettings.Builder builder(ClusterSettings clusterSettings)

Creates a builder instance.

Parameters:

clusterSettings - existing ClusterSettings to default the builder settings on.

Returns:

a builder

Since:

3.5

getDescription

public java.lang.String getDescription()

Gets the user defined description of the MongoClient.

Returns:

the user defined description of the MongoClient

getHosts

public java.util.List<ServerAddress> getHosts()

Gets the seed list of hosts for the cluster.

Returns:

the seed list of hosts

getMode

public ClusterConnectionMode getMode()

Gets the mode.

Returns:

the mode

getRequiredClusterType

public ClusterType getRequiredClusterType()

Get

Returns:

the cluster type

getRequiredReplicaSetName

public java.lang.String getRequiredReplicaSetName()

Gets the required replica set name.

Returns:

the required replica set name

getServerSelector

public ServerSelector getServerSelector()

Gets the ServerSelector that will be uses as the final server selector that is applied in calls to Cluster.selectServer.

Returns:

the server selector, which may be null

See Also:

Cluster.selectServer(com.mongodb.selector.ServerSelector)

getServerSelectionTimeout

public long getServerSelectionTimeout(java.util.concurrent.TimeUnit timeUnit)

Gets the timeout to apply when selecting a server. If the timeout expires before a server is found to handle a request, a MongoTimeoutException will be thrown. The default value is 30 seconds.

A value of 0 means that it will timeout immediately if no server is available. A negative value means to wait indefinitely.

Parameters:

timeUnit - the time unit

Returns:

the timeout in the given time unit

getMaxWaitQueueSize

public int getMaxWaitQueueSize()

This is the maximum number of threads that may be waiting for a connection to become available from the pool. All further threads will get an exception immediately.

Default is 500.

Returns:

the number of threads that are allowed to be waiting for a connection.

getClusterListeners

public java.util.List<ClusterListener> getClusterListeners()

Gets the cluster listeners. The default value is an empty list.

Returns:

the cluster listeners

Since:

3.3

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getShortDescription

public java.lang.String getShortDescription()

Returns a short, pretty description for these ClusterSettings.

Returns:

a String description of the relevant settings.