MongoClientOptions

java.lang.Object
- com.mongodb.MongoClientOptions

```
@Immutable
public class MongoClientOptions
extends Object
```
Various settings to control the behavior of a MongoClient.
Note: This class is a replacement for MongoOptions, to be used with MongoClient. The main difference in behavior is that the default write concern is WriteConcern.ACKNOWLEDGED.

Since:

2.10.0

See Also:
MongoClient

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MongoClientOptions.Builder` A builder for MongoClientOptions so that MongoClientOptions can be immutable, and to support easier construction through chaining.

Method Summary

Methods
Modifier and Type	Method and Description
`static MongoClientOptions.Builder`	`builder()` Create a new Builder instance.
`boolean`	`equals(Object o)`
`int`	`getAcceptableLatencyDifference()` Gets the acceptable latency difference.
`int`	`getConnectionsPerHost()` The maximum number of connections allowed per host for this MongoClient instance.
`int`	`getConnectTimeout()` The connection timeout in milliseconds.
`DBDecoderFactory`	`getDbDecoderFactory()` Override the decoder factory.
`DBEncoderFactory`	`getDbEncoderFactory()` Override the encoder factory.
`String`	`getDescription()` Gets the description for this MongoClient, which is used in various places like logging and JMX.
`int`	`getHeartbeatConnectRetryFrequency()` Gets the heartbeat connect retry frequency.
`int`	`getHeartbeatConnectTimeout()` Gets the heartbeat connect timeout.
`int`	`getHeartbeatFrequency()` Gets the heartbeat frequency.
`int`	`getHeartbeatSocketTimeout()` Gets the heartbeat socket timeout.
`int`	`getHeartbeatThreadCount()` Gets the heartbeat thread count.
`long`	`getMaxAutoConnectRetryTime()` Deprecated. There is no replacement for this method. Use the connectTimeout property to control connection timeout.
`int`	`getMaxConnectionIdleTime()` The maximum idle time of a pooled connection.
`int`	`getMaxConnectionLifeTime()` The maximum life time of a pooled connection.
`int`	`getMaxWaitTime()` The maximum wait time in milliseconds that a thread may wait for a connection to become available.
`int`	`getMinConnectionsPerHost()` The minimum number of connections per host for this MongoClient instance.
`ReadPreference`	`getReadPreference()` The read preference to use for queries, map-reduce, aggregation, and count.
`String`	`getRequiredReplicaSetName()` Gets the required replica set name.
`SocketFactory`	`getSocketFactory()` The socket factory for creating sockets to the mongo server.
`int`	`getSocketTimeout()` The socket timeout in milliseconds.
`int`	`getThreadsAllowedToBlockForConnectionMultiplier()` this multiplier, multiplied with the connectionsPerHost setting, gives the maximum number of threads that may be waiting for a connection to become available from the pool.
`WriteConcern`	`getWriteConcern()` The write concern to use.
`int`	`hashCode()`
`boolean`	`isAlwaysUseMBeans()` Gets whether JMX beans registered by the driver should always be MBeans, regardless of whether the VM is Java 6 or greater.
`boolean`	`isAutoConnectRetry()` Deprecated. There is no replacement for this method. Use the connectTimeout property to control connection timeout.
`boolean`	`isCursorFinalizerEnabled()` Gets whether there is a a finalize method created that cleans up instances of DBCursor that the client does not close.
`boolean`	`isSocketKeepAlive()` This flag controls the socket keep alive feature that keeps a connection alive through firewalls `Socket.setKeepAlive(boolean)` * Default is false.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - builder
```
public static MongoClientOptions.Builder builder()
```
    Create a new Builder instance. This is a convenience method, equivalent to new MongoClientOptions.Builder().
    
    Returns:
    a new instance of a Builder
  - getDescription
```
public String getDescription()
```
    Gets the description for this MongoClient, which is used in various places like logging and JMX.
    Default is null.
    
    Returns:
    the description
  - getMinConnectionsPerHost
```
public int getMinConnectionsPerHost()
```
    The minimum number of connections per host for this MongoClient instance. Those connections will be kept in a pool when idle, and the pool will ensure over time that it contains at least this minimum number.
    Default is 0.
    
    Returns:
    the minimum size of the connection pool per host
    Since:
    
    2.12
  - getConnectionsPerHost
```
public int getConnectionsPerHost()
```
    The maximum number of connections allowed per host for this MongoClient instance. Those connections will be kept in a pool when idle. Once the pool is exhausted, any operation requiring a connection will block waiting for an available connection.
    Default is 100.
    
    Returns:
    the maximum size of the connection pool per host
    See Also:
    getThreadsAllowedToBlockForConnectionMultiplier()
  - getThreadsAllowedToBlockForConnectionMultiplier
```
public int getThreadsAllowedToBlockForConnectionMultiplier()
```
    this multiplier, multiplied with the connectionsPerHost setting, gives 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 right away. For example if connectionsPerHost is 10 and threadsAllowedToBlockForConnectionMultiplier is 5, then up to 50 threads can wait for a connection.
    Default is 5.
    
    Returns:
    the multiplier
  - getMaxWaitTime
```
public int getMaxWaitTime()
```
    The maximum wait time in milliseconds that a thread may wait for a connection to become available.
    Default is 120,000. A value of 0 means that it will not wait. A negative value means to wait indefinitely.
    
    Returns:
    the maximum wait time.
  - getMaxConnectionIdleTime
```
public int getMaxConnectionIdleTime()
```
    The maximum idle time of a pooled connection. A zero value indicates no limit to the idle time. A pooled connection that has exceeded its idle time will be closed and replaced when necessary by a new connection.
    
    Returns:
    the maximum idle time, in milliseconds
    Since:
    
    2.12
  - getMaxConnectionLifeTime
```
public int getMaxConnectionLifeTime()
```
    The maximum life time of a pooled connection. A zero value indicates no limit to the life time. A pooled connection that has exceeded its life time will be closed and replaced when necessary by a new connection.
    
    Returns:
    the maximum life time, in milliseconds
    Since:
    
    2.12
  - getConnectTimeout
```
public int getConnectTimeout()
```
    The connection timeout in milliseconds. A value of 0 means no timeout. It is used solely when establishing a new connection Socket.connect(java.net.SocketAddress, int)
    Default is 10,000.
    
    Returns:
    the socket connect timeout
  - getSocketTimeout
```
public int getSocketTimeout()
```
    The socket timeout in milliseconds. It is used for I/O socket read and write operations Socket.setSoTimeout(int)
    Default is 0 and means no timeout.
    
    Returns:
    the socket timeout
  - isSocketKeepAlive
```
public boolean isSocketKeepAlive()
```
    This flag controls the socket keep alive feature that keeps a connection alive through firewalls Socket.setKeepAlive(boolean)
    * Default is false.
    
    Returns:
    whether keep-alive is enabled on each socket
  - isAutoConnectRetry
```
@Deprecated
public boolean isAutoConnectRetry()
```
    Deprecated. There is no replacement for this method. Use the connectTimeout property to control connection timeout.
    
    If true, the driver will keep trying to connect to the server in case that the socket cannot be established within the {code connectTimeout} period. There is maximum amount of time to keep retrying, which is 15s by default. Note that use of this flag does not prevent exceptions from being thrown from read/write operations, and they must be handled by the application. The default value is false.
    
    Returns:
    whether socket connect is retried
  - getMaxAutoConnectRetryTime
```
@Deprecated
public long getMaxAutoConnectRetryTime()
```
    Deprecated. There is no replacement for this method. Use the connectTimeout property to control connection timeout.
    
    The maximum amount of time in MS to spend trying to open connection to the same server. The default is 0, which means to use the default 15s if autoConnectRetry is on.
    
    Returns:
    the maximum socket connect retry time.
  - getReadPreference
```
public ReadPreference getReadPreference()
```
    The read preference to use for queries, map-reduce, aggregation, and count.
    Default is ReadPreference.primary().
    
    Returns:
    the read preference
    See Also:
    ReadPreference.primary()
  - getDbDecoderFactory
```
public DBDecoderFactory getDbDecoderFactory()
```
    Override the decoder factory. Default is for the standard Mongo Java driver configuration.
    
    Returns:
    the decoder factory
  - getDbEncoderFactory
```
public DBEncoderFactory getDbEncoderFactory()
```
    Override the encoder factory. Default is for the standard Mongo Java driver configuration.
    
    Returns:
    the encoder factory
  - getWriteConcern
```
public WriteConcern getWriteConcern()
```
    The write concern to use.
    Default is WriteConcern.ACKNOWLEDGED.
    
    Returns:
    the write concern
    See Also:
    WriteConcern.ACKNOWLEDGED
  - getSocketFactory
```
public SocketFactory getSocketFactory()
```
    The socket factory for creating sockets to the mongo server.
    Default is SocketFactory.getDefault()
    
    Returns:
    the socket factory
  - isCursorFinalizerEnabled
```
public boolean isCursorFinalizerEnabled()
```
    Gets whether there is a a finalize method created that cleans up instances of DBCursor that the client does not close. If you are careful to always call the close method of DBCursor, then this can safely be set to false.
    Default is true.
    
    Returns:
    whether finalizers are enabled on cursors
    See Also:
    DBCursor, DBCursor.close()
  - isAlwaysUseMBeans
```
public boolean isAlwaysUseMBeans()
```
    Gets 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.
    Default is false.
  - getHeartbeatFrequency
```
public int getHeartbeatFrequency()
```
    Gets the heartbeat frequency. This is the frequency that a background thread will attempt to connect to each MongoDB server that the MongoClient is connected to.
    The default value is 5,000 milliseconds.
    
    Returns:
    the heartbeat frequency, in milliseconds
    Since:
    
    2.12.0
  - getHeartbeatConnectRetryFrequency
```
public int getHeartbeatConnectRetryFrequency()
```
    Gets the heartbeat connect retry frequency. This is the frequency that a background thread will attempt to connect to each MongoDB server that the MongoClient is connected to, when that server is currently unreachable.
    The default value is 10 milliseconds.
    
    Returns:
    the heartbeat connect retry frequency, in milliseconds
    Since:
    
    2.12.0
  - getHeartbeatConnectTimeout
```
public int getHeartbeatConnectTimeout()
```
    Gets the heartbeat connect timeout. This is the socket connect timeout for sockets used by the background thread that is monitoring each MongoDB server that the MongoClient is connected to.
    The default value is 20,000 milliseconds.
    
    Returns:
    the heartbeat connect timeout, in milliseconds
    Since:
    
    2.12.0
  - getHeartbeatSocketTimeout
```
public int getHeartbeatSocketTimeout()
```
    Gets the heartbeat socket timeout. This is the socket timeout for sockets used by the background thread that is monitoring each MongoDB server that the MongoClient is connected to.
    The default value is 20,000 milliseconds.
    
    Returns:
    the heartbeat socket timeout, in milliseconds
    Since:
    
    2.12.0
  - getHeartbeatThreadCount
```
public int getHeartbeatThreadCount()
```
    Gets the heartbeat thread count. This is the number of threads that will be used to monitor the MongoDB servers that the MongoClient is connected to.
    The default value is the number of servers in the seed list.
    
    Returns:
    the heartbeat thread count
    Since:
    
    2.12.0
  - getAcceptableLatencyDifference
```
public int getAcceptableLatencyDifference()
```
    Gets the acceptable latency difference. When choosing among multiple MongoDB servers to send a request, the MongoClient will only send that request to a server whose ping time is less than or equal to the server with the fastest ping time plus the acceptable latency difference.
    For example, let's say that the client is choosing a server to send a query when the read preference is ReadPreference.secondary(), and that there are three secondaries, server1, server2, and server3, whose ping times are 10, 15, and 16 milliseconds, respectively. With an acceptable latency difference of 5 milliseconds, the client will send the query to either server1 or server2 (randomly selecting between the two).
    
    The default value is 15 milliseconds.
    
    Returns:
    the acceptable latency difference, in milliseconds
    Since:
    
    2.12.0
  - getRequiredReplicaSetName
```
public String getRequiredReplicaSetName()
```
    Gets the required replica set name. With this option set, the MongoClient instance will
    1. Connect in replica set mode, and discover all members of the set based on the given servers
    
    2. Make sure that the set name reported by all members matches the required set name.
    
    3. Refuse to service any requests if any member of the seed list is not part of a replica set with the required name.
    
    Returns:
    the required replica set name
    Since:
    
    2.12
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MongoClientOptions

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

getDescription

getMinConnectionsPerHost

getConnectionsPerHost

getThreadsAllowedToBlockForConnectionMultiplier

getMaxWaitTime

getMaxConnectionIdleTime

getMaxConnectionLifeTime

getConnectTimeout

getSocketTimeout

isSocketKeepAlive

isAutoConnectRetry

getMaxAutoConnectRetryTime

getReadPreference

getDbDecoderFactory

getDbEncoderFactory

getWriteConcern

getSocketFactory

isCursorFinalizerEnabled

isAlwaysUseMBeans

getHeartbeatFrequency

getHeartbeatConnectRetryFrequency

getHeartbeatConnectTimeout

getHeartbeatSocketTimeout

getHeartbeatThreadCount

getAcceptableLatencyDifference

getRequiredReplicaSetName

equals

hashCode

toString