com.mongodb

Class MongoClientOptions.Builder

java.lang.Object

com.mongodb.MongoClientOptions.Builder

Enclosing class:

MongoClientOptions

public static class MongoClientOptions.Builder
extends Object

A builder for MongoClientOptions so that MongoClientOptions can be immutable, and to support easier construction through chaining.

Since:

2.10.0

Constructor Summary

Constructors

Constructor and Description
MongoClientOptions.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
MongoClientOptions.Builder	acceptableLatencyDifference(int acceptableLatencyDifference) Deprecated. Use localThreshold(int)
MongoClientOptions.Builder	alwaysUseMBeans(boolean alwaysUseMBeans) Sets whether JMX beans registered by the driver should always be MBeans, regardless of whether the VM is Java 6 or greater.
MongoClientOptions.Builder	autoConnectRetry(boolean autoConnectRetry) Deprecated. There is no replacement for this method. Use the connectTimeout property to control connection timeout.
MongoClientOptions	build() Build an instance of MongoClientOptions.
MongoClientOptions.Builder	connectionsPerHost(int connectionsPerHost) Sets the maximum number of connections per host.
MongoClientOptions.Builder	connectTimeout(int connectTimeout) Sets the connection timeout.
MongoClientOptions.Builder	cursorFinalizerEnabled(boolean cursorFinalizerEnabled) Sets whether cursor finalizers are enabled.
MongoClientOptions.Builder	dbDecoderFactory(DBDecoderFactory dbDecoderFactory) Sets the decoder factory.
MongoClientOptions.Builder	dbEncoderFactory(DBEncoderFactory dbEncoderFactory) Sets the encoder factory.
MongoClientOptions.Builder	description(String description) Sets the description.
MongoClientOptions.Builder	heartbeatConnectRetryFrequency(int minHeartbeatFrequency) Deprecated. replaced by minHeartbeatFrequency
MongoClientOptions.Builder	heartbeatConnectTimeout(int heartbeatConnectTimeout) Sets the heartbeat connect timeout.
MongoClientOptions.Builder	heartbeatFrequency(int heartbeatFrequency) Sets the heartbeat frequency.
MongoClientOptions.Builder	heartbeatSocketTimeout(int heartbeatSocketTimeout) Sets the heartbeat connect socket timeout.
MongoClientOptions.Builder	heartbeatThreadCount(int heartbeatThreadCount) Deprecated. this is no longer a configurable property
MongoClientOptions.Builder	legacyDefaults() Sets defaults to be what they are in MongoOptions.
MongoClientOptions.Builder	localThreshold(int localThreshold) Sets the local threshold.
MongoClientOptions.Builder	maxAutoConnectRetryTime(long maxAutoConnectRetryTime) Deprecated. There is no replacement for this method. Use the connectTimeout property to control connection timeout.
MongoClientOptions.Builder	maxConnectionIdleTime(int maxConnectionIdleTime) Sets the maximum idle time for a pooled connection.
MongoClientOptions.Builder	maxConnectionLifeTime(int maxConnectionLifeTime) Sets the maximum life time for a pooled connection.
MongoClientOptions.Builder	maxWaitTime(int maxWaitTime) Sets the maximum time that a thread will block waiting for a connection.
MongoClientOptions.Builder	minConnectionsPerHost(int minConnectionsPerHost) Sets the minimum number of connections per host.
MongoClientOptions.Builder	minHeartbeatFrequency(int minHeartbeatFrequency) Sets the minimum heartbeat frequency.
MongoClientOptions.Builder	readPreference(ReadPreference readPreference) Sets the read preference.
MongoClientOptions.Builder	requiredReplicaSetName(String requiredReplicaSetName) Sets the required replica set name for the cluster.
MongoClientOptions.Builder	socketFactory(SocketFactory socketFactory) Sets the socket factory.
MongoClientOptions.Builder	socketKeepAlive(boolean socketKeepAlive) Sets whether socket keep alive is enabled.
MongoClientOptions.Builder	socketTimeout(int socketTimeout) Sets the socket timeout.
MongoClientOptions.Builder	threadsAllowedToBlockForConnectionMultiplier(int threadsAllowedToBlockForConnectionMultiplier) Sets the multiplier for number of threads allowed to block waiting for a connection.
MongoClientOptions.Builder	writeConcern(WriteConcern writeConcern) Sets the write concern.

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoClientOptions.Builder

public MongoClientOptions.Builder()

Method Detail

heartbeatFrequency

public MongoClientOptions.Builder heartbeatFrequency(int heartbeatFrequency)

Sets the heartbeat frequency.

Parameters:

heartbeatFrequency - the heartbeat frequency, in milliseconds

Returns:

this

Throws:

IllegalArgumentException - if heartbeatFrequency < 1, which must be > 0

Since:

2.12.0

See Also:

MongoClientOptions.getHeartbeatFrequency()

minHeartbeatFrequency

public MongoClientOptions.Builder minHeartbeatFrequency(int minHeartbeatFrequency)

Sets the minimum heartbeat frequency. In the event that the driver has to frequently re-check a server's availability, it will wait at least this long since the previous check to avoid wasted effort. The default value is 10ms.

Parameters:

minHeartbeatFrequency - the minimum heartbeat frequency, in milliseconds, which must be > 0

Returns:

this

Since:

2.13

See Also:

MongoClientOptions.getMinHeartbeatFrequency()

heartbeatConnectRetryFrequency

@Deprecated
public MongoClientOptions.Builder heartbeatConnectRetryFrequency(int minHeartbeatFrequency)

Deprecated. replaced by minHeartbeatFrequency

Sets the minimum heartbeat frequency. In the event that the driver has to frequently re-check a server's availability, it will wait at least this long since the previous check to avoid pointless effort. The default value is 10ms.

Parameters:

minHeartbeatFrequency - the minimum heartbeat frequency, in milliseconds, which must be > 0

Returns:

this

Since:

2.12

See Also:

()

heartbeatConnectTimeout

public MongoClientOptions.Builder heartbeatConnectTimeout(int heartbeatConnectTimeout)

Sets the heartbeat connect timeout.

Parameters:

heartbeatConnectTimeout - the heartbeat connect timeout, in milliseconds

Returns:

this

Throws:

IllegalArgumentException - if heartbeatConnectTimeout < 0

Since:

2.12.0

See Also:

MongoClientOptions.getHeartbeatConnectTimeout()

heartbeatSocketTimeout

public MongoClientOptions.Builder heartbeatSocketTimeout(int heartbeatSocketTimeout)

Sets the heartbeat connect socket timeout.

Parameters:

heartbeatSocketTimeout - the heartbeat socket timeout, in milliseconds

Returns:

this

Throws:

IllegalArgumentException - if heartbeatSocketTimeout < 0

Since:

2.12.0

See Also:

MongoClientOptions.getHeartbeatSocketTimeout()

heartbeatThreadCount

@Deprecated
public MongoClientOptions.Builder heartbeatThreadCount(int heartbeatThreadCount)

Deprecated. this is no longer a configurable property

Sets the heartbeat thread count.

Parameters:

heartbeatThreadCount - the heartbeat thread count

Returns:

this

Throws:

IllegalArgumentException - if heartbeatThreadCount < 1

Since:

2.12.0

See Also:

MongoClientOptions.getHeartbeatThreadCount()

localThreshold

public MongoClientOptions.Builder localThreshold(int localThreshold)

Sets the local threshold.

Parameters:

localThreshold - the threshold in milliseconds

Returns:

this

Throws:

IllegalArgumentException - if localThreshold < 0

Since:

2.13.0

See Also:

MongoClientOptions.getLocalThreshold()

acceptableLatencyDifference

@Deprecated
public MongoClientOptions.Builder acceptableLatencyDifference(int acceptableLatencyDifference)

Deprecated. Use localThreshold(int)

Sets the acceptable latency difference.

Parameters:

acceptableLatencyDifference - the acceptable latency difference, in milliseconds

Returns:

this

Throws:

IllegalArgumentException - if acceptableLatencyDifference < 0

Since:

2.12.0

See Also:

MongoClientOptions.getAcceptableLatencyDifference()

description

public MongoClientOptions.Builder description(String description)

Sets the description.

Parameters:

description - the description of this MongoClient

Returns:

this

See Also:

MongoClientOptions.getDescription()

minConnectionsPerHost

public MongoClientOptions.Builder minConnectionsPerHost(int minConnectionsPerHost)

Sets the minimum number of connections per host.

Parameters:

minConnectionsPerHost - minimum number of connections

Returns:

this

Throws:

IllegalArgumentException - if minConnectionsPerHost < 0

Since:

2.12

See Also:

MongoClientOptions.getMinConnectionsPerHost()

connectionsPerHost

public MongoClientOptions.Builder connectionsPerHost(int connectionsPerHost)

Sets the maximum number of connections per host.

Parameters:

connectionsPerHost - maximum number of connections

Returns:

this

Throws:

IllegalArgumentException - if connnectionsPerHost < 1

See Also:

MongoClientOptions.getConnectionsPerHost()

threadsAllowedToBlockForConnectionMultiplier

public MongoClientOptions.Builder threadsAllowedToBlockForConnectionMultiplier(int threadsAllowedToBlockForConnectionMultiplier)

Sets the multiplier for number of threads allowed to block waiting for a connection.

Parameters:

threadsAllowedToBlockForConnectionMultiplier - the multiplier

Returns:

this

Throws:

IllegalArgumentException - if threadsAllowedToBlockForConnectionMultiplier < 1

See Also:

MongoClientOptions.getThreadsAllowedToBlockForConnectionMultiplier()

maxWaitTime

public MongoClientOptions.Builder maxWaitTime(int maxWaitTime)

Sets the maximum time that a thread will block waiting for a connection.

Parameters:

maxWaitTime - the maximum wait time (in milliseconds)

Returns:

this

Throws:

IllegalArgumentException - if maxWaitTime < 0

See Also:

MongoClientOptions.getMaxWaitTime()

maxConnectionIdleTime

public MongoClientOptions.Builder maxConnectionIdleTime(int maxConnectionIdleTime)

Sets the maximum idle time for a pooled connection.

Parameters:

maxConnectionIdleTime - the maximum idle time

Returns:

this

Throws:

IllegalArgumentException - if maxConnectionIdleTime < 0

Since:

2.12

See Also:

MongoClientOptions.getMaxConnectionIdleTime()

maxConnectionLifeTime

public MongoClientOptions.Builder maxConnectionLifeTime(int maxConnectionLifeTime)

Sets the maximum life time for a pooled connection.

Parameters:

maxConnectionLifeTime - the maximum life time

Returns:

this

Throws:

IllegalArgumentException - if maxConnectionIdleTime < 0

Since:

2.12

See Also:

MongoClientOptions.getMaxConnectionIdleTime()

connectTimeout

public MongoClientOptions.Builder connectTimeout(int connectTimeout)

Sets the connection timeout.

Parameters:

connectTimeout - the connection timeout (in milliseconds)

Returns:

this

See Also:

MongoClientOptions.getConnectTimeout()

socketTimeout

public MongoClientOptions.Builder socketTimeout(int socketTimeout)

Sets the socket timeout.

Parameters:

socketTimeout - the socket timeout (in milliseconds)

Returns:

this

See Also:

MongoClientOptions.getSocketTimeout()

socketKeepAlive

public MongoClientOptions.Builder socketKeepAlive(boolean socketKeepAlive)

Sets whether socket keep alive is enabled.

Parameters:

socketKeepAlive - keep alive

Returns:

this

See Also:

MongoClientOptions.isSocketKeepAlive()

autoConnectRetry

@Deprecated
public MongoClientOptions.Builder autoConnectRetry(boolean autoConnectRetry)

Deprecated. There is no replacement for this method. Use the connectTimeout property to control connection timeout.

Sets whether auto connect retry is enabled.

Parameters:

autoConnectRetry - auto connect retry

Returns:

this

See Also:

MongoClientOptions.isAutoConnectRetry()

maxAutoConnectRetryTime

@Deprecated
public MongoClientOptions.Builder maxAutoConnectRetryTime(long maxAutoConnectRetryTime)

Deprecated. There is no replacement for this method. Use the connectTimeout property to control connection timeout.

Sets the maximum auto connect retry time.

Parameters:

maxAutoConnectRetryTime - the maximum auto connect retry time

Returns:

this

See Also:

MongoClientOptions.getMaxAutoConnectRetryTime()

readPreference

public MongoClientOptions.Builder readPreference(ReadPreference readPreference)

Sets the read preference.

Parameters:

readPreference - read preference

Returns:

this

See Also:

MongoClientOptions.getReadPreference()

dbDecoderFactory

public MongoClientOptions.Builder dbDecoderFactory(DBDecoderFactory dbDecoderFactory)

Sets the decoder factory.

Parameters:

dbDecoderFactory - the decoder factory

Returns:

this

See Also:

MongoClientOptions.getDbDecoderFactory()

dbEncoderFactory

public MongoClientOptions.Builder dbEncoderFactory(DBEncoderFactory dbEncoderFactory)

Sets the encoder factory.

Parameters:

dbEncoderFactory - the encoder factory

Returns:

this

See Also:

MongoClientOptions.getDbEncoderFactory()

writeConcern

public MongoClientOptions.Builder writeConcern(WriteConcern writeConcern)

Sets the write concern.

Parameters:

writeConcern - the write concern

Returns:

this

See Also:

MongoClientOptions.getWriteConcern()

socketFactory

public MongoClientOptions.Builder socketFactory(SocketFactory socketFactory)

Sets the socket factory.

Parameters:

socketFactory - the socket factory

Returns:

this

See Also:

MongoClientOptions.getSocketFactory()

cursorFinalizerEnabled

public MongoClientOptions.Builder cursorFinalizerEnabled(boolean cursorFinalizerEnabled)

Sets whether cursor finalizers are enabled.

Parameters:

cursorFinalizerEnabled - whether cursor finalizers are enabled.

Returns:

this

See Also:

MongoClientOptions.isCursorFinalizerEnabled()

alwaysUseMBeans

public MongoClientOptions.Builder alwaysUseMBeans(boolean alwaysUseMBeans)

Sets whether JMX beans registered by the driver should always be MBeans, regardless of whether the VM is Java 6 or greater. If false, the driver will use MXBeans if the VM is Java 6 or greater, and use MBeans if the VM is Java 5.

Parameters:

alwaysUseMBeans - true if driver should always use MBeans, regardless of VM version

Returns:

this

See Also:

MongoClientOptions.isAlwaysUseMBeans()

requiredReplicaSetName

public MongoClientOptions.Builder requiredReplicaSetName(String requiredReplicaSetName)

Sets the required replica set name for the cluster.

Parameters:

requiredReplicaSetName - the required replica set name for the replica set.

Returns:

this

Since:

2.12

See Also:

MongoClientOptions.getRequiredReplicaSetName()

legacyDefaults

public MongoClientOptions.Builder legacyDefaults()

Sets defaults to be what they are in MongoOptions.

Returns:

this

See Also:

MongoOptions

build

public MongoClientOptions build()

Build an instance of MongoClientOptions.

Returns:

the options from this builder