MongoOptions

java.lang.Object
- com.mongodb.MongoOptions

Deprecated.
Replaced by MongoClientOptions.
```
@Deprecated
public class MongoOptions
extends Object
```
Various settings for a Mongo instance. Not thread safe, and superseded by MongoClientOptions. This class may be deprecated in a future release.

See Also:

MongoClientOptions, MongoClient

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`alwaysUseMBeans` Deprecated. Sets whether JMX beans registered by the driver should always be MBeans, regardless of whether the VM is Java 6 or greater.
`boolean`	`autoConnectRetry` Deprecated. There is no replacement for this method. Use the connectTimeout property to control connection timeout.
`int`	`connectionsPerHost` Deprecated. The maximum number of connections allowed per host for this Mongo instance.
`int`	`connectTimeout` Deprecated. The connection timeout in milliseconds.
`boolean`	`cursorFinalizerEnabled` Deprecated. Sets whether there is a a finalize method created that cleans up instances of DBCursor that the client does not close.
`DBDecoderFactory`	`dbDecoderFactory` Deprecated. Override the DBCallback factory.
`DBEncoderFactory`	`dbEncoderFactory` Deprecated. Override the encoding factory.
`String`	`description` Deprecated. The description for `Mongo` instances created with these options.
`boolean`	`fsync` Deprecated. The "fsync" value of the global WriteConcern.
`boolean`	`j` Deprecated. The "j" value of the global WriteConcern.
`long`	`maxAutoConnectRetryTime` Deprecated. There is no replacement for this method. Use the connectTimeout property to control connection timeout.
`int`	`maxWaitTime` Deprecated. The maximum wait time in milliseconds that a thread may wait for a connection to become available.
`ReadPreference`	`readPreference` Deprecated. Specifies the read preference.
`boolean`	`safe` Deprecated. If true the driver will use a WriteConcern of WriteConcern.SAFE for all operations.
`boolean`	`slaveOk` Deprecated. Replaced with `ReadPreference.secondaryPreferred()`
`SocketFactory`	`socketFactory` Deprecated. sets the socket factory for creating sockets to mongod Default is SocketFactory.getDefault()
`boolean`	`socketKeepAlive` Deprecated. This flag controls the socket keep alive feature that keeps a connection alive through firewalls `Socket.setKeepAlive(boolean)` Default is false.
`int`	`socketTimeout` Deprecated. 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.
`int`	`threadsAllowedToBlockForConnectionMultiplier` Deprecated. 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.
`int`	`w` Deprecated. The "w" value, (number of writes), of the global WriteConcern.
`WriteConcern`	`writeConcern` Deprecated. Sets the write concern.
`int`	`wtimeout` Deprecated. The "wtimeout" value of the global WriteConcern.

Constructor Summary

Constructors
Constructor and Description

MongoOptions()
Deprecated.

MongoOptions(MongoClientOptions options)
Deprecated.
Replaced by MongoClientOptions

Constructors
Constructor and Description
`MongoOptions()` Deprecated.
`MongoOptions(MongoClientOptions options)` Deprecated. Replaced by `MongoClientOptions`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`MongoOptions`	`copy()` Deprecated.
`boolean`	`equals(Object o)` Deprecated.
`int`	`getConnectionsPerHost()` Deprecated. Gets the maximum number of connections allowed per host for this Mongo instance.
`int`	`getConnectTimeout()` Deprecated.
`DBDecoderFactory`	`getDbDecoderFactory()` Deprecated.
`DBEncoderFactory`	`getDbEncoderFactory()` Deprecated.
`String`	`getDescription()` Deprecated.
`long`	`getMaxAutoConnectRetryTime()` Deprecated. There is no replacement for this method. Use the connectTimeout property to control connection timeout.
`int`	`getMaxWaitTime()` Deprecated.
`ReadPreference`	`getReadPreference()` Deprecated.
`String`	`getRequiredReplicaSetName()` Deprecated. Gets the required replica set name that this client should be connecting to.
`SocketFactory`	`getSocketFactory()` Deprecated.
`int`	`getSocketTimeout()` Deprecated.
`int`	`getThreadsAllowedToBlockForConnectionMultiplier()` Deprecated. Gets the multiplier which, when multiplied with the connectionsPerHost setting, gives the maximum number of threads that may be waiting for a connection to become available from the pool.
`int`	`getW()` Deprecated.
`WriteConcern`	`getWriteConcern()` Deprecated. Helper method to return the appropriate WriteConcern instance based on the current related options settings.
`int`	`getWtimeout()` Deprecated.
`int`	`hashCode()` Deprecated.
`boolean`	`isAlwaysUseMBeans()` Deprecated.
`boolean`	`isAutoConnectRetry()` Deprecated. There is no replacement for this method. Use the connectTimeout property to control connection timeout.
`boolean`	`isCursorFinalizerEnabled()` Deprecated.
`boolean`	`isFsync()` Deprecated.
`boolean`	`isJ()` Deprecated.
`boolean`	`isSafe()` Deprecated.
`boolean`	`isSocketKeepAlive()` Deprecated.
`void`	`reset()` Deprecated.
`void`	`setAlwaysUseMBeans(boolean alwaysUseMBeans)` Deprecated.
`void`	`setAutoConnectRetry(boolean retry)` Deprecated. There is no replacement for this method. Use the connectTimeout property to control connection timeout.
`void`	`setConnectionsPerHost(int connections)` Deprecated. Sets the maximum number of connections allowed per host for this Mongo instance.
`void`	`setConnectTimeout(int timeoutMS)` Deprecated.
`void`	`setCursorFinalizerEnabled(boolean cursorFinalizerEnabled)` Deprecated.
`void`	`setDbDecoderFactory(DBDecoderFactory factory)` Deprecated.
`void`	`setDbEncoderFactory(DBEncoderFactory factory)` Deprecated.
`void`	`setDescription(String desc)` Deprecated.
`void`	`setFsync(boolean sync)` Deprecated.
`void`	`setJ(boolean safe)` Deprecated.
`void`	`setMaxAutoConnectRetryTime(long retryTimeMS)` Deprecated. There is no replacement for this method. Use the connectTimeout property to control connection timeout.
`void`	`setMaxWaitTime(int timeMS)` Deprecated.
`void`	`setReadPreference(ReadPreference readPreference)` Deprecated.
`void`	`setSafe(boolean isSafe)` Deprecated.
`void`	`setSocketFactory(SocketFactory factory)` Deprecated.
`void`	`setSocketKeepAlive(boolean keepAlive)` Deprecated.
`void`	`setSocketTimeout(int timeoutMS)` Deprecated.
`void`	`setThreadsAllowedToBlockForConnectionMultiplier(int threads)` Deprecated. Sets the multiplier which, when multiplied with the connectionsPerHost setting, gives the maximum number of threads that may be waiting for a connection to become available from the pool.
`void`	`setW(int val)` Deprecated.
`void`	`setWriteConcern(WriteConcern writeConcern)` Deprecated.
`void`	`setWtimeout(int timeoutMS)` Deprecated.
`String`	`toString()` Deprecated.

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

- Field Detail
  - description
```
public String description
```
    Deprecated.
    
    The description for Mongo instances created with these options. This is used in various places like logging.
  - connectionsPerHost
```
public int connectionsPerHost
```
    Deprecated.
    
    The maximum number of connections allowed per host for this Mongo 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 10.
    
    See Also:
    
    threadsAllowedToBlockForConnectionMultiplier
  - threadsAllowedToBlockForConnectionMultiplier
```
public int threadsAllowedToBlockForConnectionMultiplier
```
    Deprecated.
    
    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.
  - maxWaitTime
```
public int maxWaitTime
```
    Deprecated.
    
    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.
  - connectTimeout
```
public int connectTimeout
```
    Deprecated.
    
    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.
  - socketTimeout
```
public int socketTimeout
```
    Deprecated.
    
    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.
  - socketKeepAlive
```
public boolean socketKeepAlive
```
    Deprecated.
    
    This flag controls the socket keep alive feature that keeps a connection alive through firewalls Socket.setKeepAlive(boolean) Default is false.
  - autoConnectRetry
```
@Deprecated
public boolean autoConnectRetry
```
    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 same server in case that the socket cannot be established. There is maximum amount of time to keep retrying, which is 15s by default. This can be useful to avoid some exceptions being thrown when a server is down temporarily by blocking the operations. It also can be useful to smooth the transition to a new master (so that a new master is elected within the retry time). Note that when using this flag: - for a replica set, the driver will trying to connect to the old master for that time, instead of failing over to the new one right away - this does not prevent exception from being thrown in read/write operations on the socket, which must be handled by application Even if this flag is false, the driver already has mechanisms to automatically recreate broken connections and retry the read operations. Default is false.
  - maxAutoConnectRetryTime
```
@Deprecated
public long maxAutoConnectRetryTime
```
    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 retrying to open connection to the same server. Default is 0, which means to use the default 15s if autoConnectRetry is on.
  - slaveOk
```
@Deprecated
public boolean slaveOk
```
    Deprecated. Replaced with ReadPreference.secondaryPreferred()
    
    This flag specifies if the driver is allowed to read from secondary (slave) servers. Specifically in the current implementation, the driver will avoid reading from the primary server and round robin requests to secondaries. Driver also factors in the latency to secondaries when choosing a server. Note that reading from secondaries can increase performance and reliability, but it may result in temporary inconsistent results. Default is false.
    
    See Also:
    
    ReadPreference.secondaryPreferred()
  - readPreference
```
public ReadPreference readPreference
```
    Deprecated.
    
    Specifies the read preference.
  - dbDecoderFactory
```
public DBDecoderFactory dbDecoderFactory
```
    Deprecated.
    
    Override the DBCallback factory. Default is for the standard Mongo Java driver configuration.
  - dbEncoderFactory
```
public DBEncoderFactory dbEncoderFactory
```
    Deprecated.
    
    Override the encoding factory. Default is for the standard Mongo Java driver configuration.
  - safe
```
public boolean safe
```
    Deprecated.
    
    If true the driver will use a WriteConcern of WriteConcern.SAFE for all operations. If w, wtimeout, fsync or j are specified, this setting is ignored. Default is false.
  - w
```
public int w
```
    Deprecated.
    
    The "w" value, (number of writes), of the global WriteConcern. Default is 0.
  - wtimeout
```
public int wtimeout
```
    Deprecated.
    
    The "wtimeout" value of the global WriteConcern. Default is 0.
  - fsync
```
public boolean fsync
```
    Deprecated.
    
    The "fsync" value of the global WriteConcern. true indicates writes should wait for data to be written to server data file Default is false.
  - j
```
public boolean j
```
    Deprecated.
    
    The "j" value of the global WriteConcern. true indicates writes should wait for a journaling group commit Default is false.
  - socketFactory
```
public SocketFactory socketFactory
```
    Deprecated.
    
    sets the socket factory for creating sockets to mongod Default is SocketFactory.getDefault()
  - cursorFinalizerEnabled
```
public boolean cursorFinalizerEnabled
```
    Deprecated.
    
    Sets 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.
    
    See Also:
    
    Default is true.
  - writeConcern
```
public WriteConcern writeConcern
```
    Deprecated.
    
    Sets the write concern. If this is not set, the write concern defaults to the combination of settings of the other write concern-related fields. If set, this will override all of the other write concern-related fields.
    
    See Also:
    
    w, safe, wtimeout, fsync, j
  - alwaysUseMBeans
```
public boolean alwaysUseMBeans
```
    Deprecated.
    
    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.
    Default is false.
- Constructor Detail
  - MongoOptions
```
@Deprecated
public MongoOptions()
```
    Deprecated.
  - MongoOptions
```
@Deprecated
public MongoOptions(MongoClientOptions options)
```
    Deprecated. Replaced by MongoClientOptions
- Method Detail
  - reset
```
public void reset()
```
    Deprecated.
  - copy
```
public MongoOptions copy()
```
    Deprecated.
  - getWriteConcern
```
public WriteConcern getWriteConcern()
```
    Deprecated.
    
    Helper method to return the appropriate WriteConcern instance based on the current related options settings.
  - equals
```
public boolean equals(Object o)
```
    Deprecated.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Deprecated.
    
    Overrides:
    
    hashCode in class Object
  - getDescription
```
public String getDescription()
```
    Deprecated.
    
    Returns:
    
    The description for MongoClient instances created with these options
  - setDescription
```
public void setDescription(String desc)
```
    Deprecated.
    
    Parameters:
    
    desc - The description for Mongo instances created with these options
  - getConnectionsPerHost
```
public int getConnectionsPerHost()
```
    Deprecated.
    
    Gets the maximum number of connections allowed per host for this Mongo instance.
    
    Returns:
    
    the maximum number of connections allowed per host for this Mongo instance
  - setConnectionsPerHost
```
public void setConnectionsPerHost(int connections)
```
    Deprecated.
    
    Sets the maximum number of connections allowed per host for this Mongo 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 10.
    
    Parameters:
    
    connections - sets the maximum number of connections allowed per host for this Mongo instance
  - getThreadsAllowedToBlockForConnectionMultiplier
```
public int getThreadsAllowedToBlockForConnectionMultiplier()
```
    Deprecated.
    
    Gets the multiplier which, when multiplied with the connectionsPerHost setting, gives the maximum number of threads that may be waiting for a connection to become available from the pool.
    
    Returns:
    
    the maximum number of threads that may be waiting for a connection
  - setThreadsAllowedToBlockForConnectionMultiplier
```
public void setThreadsAllowedToBlockForConnectionMultiplier(int threads)
```
    Deprecated.
    
    Sets the multiplier which, when 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.
    
    Parameters:
    
    threads - multiplied with connectionsPerHost, sets the maximum number of threads that may be waiting for a connection
  - getMaxWaitTime
```
public int getMaxWaitTime()
```
    Deprecated.
    
    Returns:
    
    The maximum time in milliseconds that threads wait for a connection
  - setMaxWaitTime
```
public void setMaxWaitTime(int timeMS)
```
    Deprecated.
    
    Parameters:
    
    timeMS - set the maximum time in milliseconds that threads wait for a connection
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Deprecated.
    
    Returns:
    
    the connection timeout in milliseconds.
  - setConnectTimeout
```
public void setConnectTimeout(int timeoutMS)
```
    Deprecated.
    
    Parameters:
    
    timeoutMS - set the connection timeout in milliseconds.
  - getSocketTimeout
```
public int getSocketTimeout()
```
    Deprecated.
    
    Returns:
    
    The socket timeout in milliseconds
  - setSocketTimeout
```
public void setSocketTimeout(int timeoutMS)
```
    Deprecated.
    
    Parameters:
    
    timeoutMS - set the socket timeout in milliseconds
  - isSocketKeepAlive
```
public boolean isSocketKeepAlive()
```
    Deprecated.
    
    Returns:
    
    connection keep-alive flag
  - setSocketKeepAlive
```
public void setSocketKeepAlive(boolean keepAlive)
```
    Deprecated.
    
    Parameters:
    
    keepAlive - set connection keep-alive flag
  - isAutoConnectRetry
```
@Deprecated
public boolean isAutoConnectRetry()
```
    Deprecated. There is no replacement for this method. Use the connectTimeout property to control connection timeout.
    
    Returns:
    
    keep trying connection flag
  - setAutoConnectRetry
```
@Deprecated
public void setAutoConnectRetry(boolean retry)
```
    Deprecated. There is no replacement for this method. Use the connectTimeout property to control connection timeout.
    
    Parameters:
    
    retry - sets keep trying connection flag
  - getMaxAutoConnectRetryTime
```
@Deprecated
public long getMaxAutoConnectRetryTime()
```
    Deprecated. There is no replacement for this method. Use the connectTimeout property to control connection timeout.
    
    Returns:
    
    max time in MS to retrying open connection
  - setMaxAutoConnectRetryTime
```
@Deprecated
public void setMaxAutoConnectRetryTime(long retryTimeMS)
```
    Deprecated. There is no replacement for this method. Use the connectTimeout property to control connection timeout.
    
    Parameters:
    
    retryTimeMS - set max time in MS to retrying open connection
  - getDbDecoderFactory
```
public DBDecoderFactory getDbDecoderFactory()
```
    Deprecated.
    
    Returns:
    
    the DBCallback decoding factory
  - setDbDecoderFactory
```
public void setDbDecoderFactory(DBDecoderFactory factory)
```
    Deprecated.
    
    Parameters:
    
    factory - sets the DBCallback decoding factory
  - getDbEncoderFactory
```
public DBEncoderFactory getDbEncoderFactory()
```
    Deprecated.
    
    Returns:
    
    the encoding factory
  - setDbEncoderFactory
```
public void setDbEncoderFactory(DBEncoderFactory factory)
```
    Deprecated.
    
    Parameters:
    
    factory - sets the encoding factory
  - isSafe
```
public boolean isSafe()
```
    Deprecated.
    
    Returns:
    
    true if driver uses WriteConcern.SAFE for all operations.
  - setSafe
```
public void setSafe(boolean isSafe)
```
    Deprecated.
    
    Parameters:
    
    isSafe - true if driver uses WriteConcern.SAFE for all operations.
  - getW
```
public int getW()
```
    Deprecated.
    
    Returns:
    
    value returns the number of writes of the global WriteConcern.
  - setW
```
public void setW(int val)
```
    Deprecated.
    
    Parameters:
    
    val - set the number of writes of the global WriteConcern.
  - getWtimeout
```
public int getWtimeout()
```
    Deprecated.
    
    Returns:
    
    timeout for write operation
  - setWtimeout
```
public void setWtimeout(int timeoutMS)
```
    Deprecated.
    
    Parameters:
    
    timeoutMS - sets timeout for write operation
  - isFsync
```
public boolean isFsync()
```
    Deprecated.
    
    Returns:
    
    true if global write concern is set to fsync
  - setFsync
```
public void setFsync(boolean sync)
```
    Deprecated.
    
    Parameters:
    
    sync - sets global write concern's fsync safe value
  - isJ
```
public boolean isJ()
```
    Deprecated.
    
    Returns:
    
    true if global write concern is set to journal safe
  - setJ
```
public void setJ(boolean safe)
```
    Deprecated.
    
    Parameters:
    
    safe - sets global write concern's journal safe value
  - setWriteConcern
```
public void setWriteConcern(WriteConcern writeConcern)
```
    Deprecated.
    
    Parameters:
    
    writeConcern - sets the write concern
  - getSocketFactory
```
public SocketFactory getSocketFactory()
```
    Deprecated.
    
    Returns:
    
    the socket factory for creating sockets to mongod
  - setSocketFactory
```
public void setSocketFactory(SocketFactory factory)
```
    Deprecated.
    
    Parameters:
    
    factory - sets the socket factory for creating sockets to mongod
  - getReadPreference
```
public ReadPreference getReadPreference()
```
    Deprecated.
    
    Returns:
    
    the read preference
  - setReadPreference
```
public void setReadPreference(ReadPreference readPreference)
```
    Deprecated.
    
    Parameters:
    
    readPreference - the read preference
  - isCursorFinalizerEnabled
```
public boolean isCursorFinalizerEnabled()
```
    Deprecated.
    
    Returns:
    
    whether DBCursor finalizer is enabled
  - setCursorFinalizerEnabled
```
public void setCursorFinalizerEnabled(boolean cursorFinalizerEnabled)
```
    Deprecated.
    
    Parameters:
    
    cursorFinalizerEnabled - whether cursor finalizer is enabled
  - isAlwaysUseMBeans
```
public boolean isAlwaysUseMBeans()
```
    Deprecated.
    
    Returns:
    
    true if the driver should always use MBeans, regardless of VM
  - setAlwaysUseMBeans
```
public void setAlwaysUseMBeans(boolean alwaysUseMBeans)
```
    Deprecated.
    
    Parameters:
    
    alwaysUseMBeans - sets whether the driver should always use MBeans, regardless of VM
  - getRequiredReplicaSetName
```
public String getRequiredReplicaSetName()
```
    Deprecated.
    
    Gets the required replica set name that this client should be connecting to.
    
    Returns:
    
    the required replica set name, or null if none is required
    
    Since:
    
    2.12
  - toString
```
public String toString()
```
    Deprecated.
    
    Overrides:
    
    toString in class Object

Class MongoOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

description

connectionsPerHost

threadsAllowedToBlockForConnectionMultiplier

maxWaitTime

connectTimeout

socketTimeout

socketKeepAlive

autoConnectRetry

maxAutoConnectRetryTime

slaveOk

readPreference

dbDecoderFactory

dbEncoderFactory

safe

w

wtimeout

fsync

j

socketFactory

cursorFinalizerEnabled

writeConcern

alwaysUseMBeans

Constructor Detail

MongoOptions

MongoOptions

Method Detail

reset

copy

getWriteConcern

equals

hashCode

getDescription

setDescription

getConnectionsPerHost

setConnectionsPerHost

getThreadsAllowedToBlockForConnectionMultiplier

setThreadsAllowedToBlockForConnectionMultiplier

getMaxWaitTime

setMaxWaitTime

getConnectTimeout

setConnectTimeout

getSocketTimeout

setSocketTimeout

isSocketKeepAlive

setSocketKeepAlive

isAutoConnectRetry

setAutoConnectRetry

getMaxAutoConnectRetryTime

setMaxAutoConnectRetryTime

getDbDecoderFactory

setDbDecoderFactory

getDbEncoderFactory

setDbEncoderFactory

isSafe

setSafe

getW

setW

getWtimeout

setWtimeout

isFsync

setFsync

isJ

setJ

setWriteConcern

getSocketFactory

setSocketFactory

getReadPreference

setReadPreference

isCursorFinalizerEnabled

setCursorFinalizerEnabled

isAlwaysUseMBeans

setAlwaysUseMBeans

getRequiredReplicaSetName

toString