MongoClientConfiguration (mongodb-async-driver 2.0.1 API)

java.lang.Object
- com.allanbank.mongodb.MongoClientConfiguration

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

MongoDbConfiguration
```
public class MongoClientConfiguration
extends Object
implements Cloneable, Serializable
```
Contains the configuration for the connection(s) to the MongoDB servers.

See Also:
Serialized Form
API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2011-2014, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADMIN_DB_NAME` The name of the administration database.
`static String`	`DEFAULT_DB_NAME` The default database.
`protected static int`	`DEFAULT_MAX_STRING_CACHE_ENTRIES` The default maximum number of strings to keep in the string encoder and decoder cache.
`protected static int`	`DEFAULT_MAX_STRING_CACHE_LENGTH` The default maximum length byte array / string to cache.
`static Charset`	`UTF8` The ASCII character encoding.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`MongoClientConfiguration()` Creates a new MongoClientConfiguration.
	`MongoClientConfiguration(InetSocketAddress... servers)` Creates a new MongoClientConfiguration.
	`MongoClientConfiguration(MongoClientConfiguration other)` Creates a new MongoClientConfiguration.
	`MongoClientConfiguration(MongoDbUri mongoDbUri)` Creates a new `MongoClientConfiguration` instance using a MongoDB style URL to initialize its state.
`protected`	`MongoClientConfiguration(MongoDbUri mongoDbUri, Durability defaultDurability)` Creates a new `MongoClientConfiguration` instance using a MongoDB style URL to initialize its state.
	`MongoClientConfiguration(String mongoDbUri)` Creates a new `MongoClientConfiguration` instance using a MongoDB style URL to initialize its state.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCredential(Credential.Builder credentials)` Adds the specified credentials to the configuration.
`void`	`addCredential(Credential credentials)` Adds the specified credentials to the configuration.
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Add a `PropertyChangeListener` from the configuration.
`void`	`addPropertyChangeListener(String propertyName, PropertyChangeListener listener)` Add a `PropertyChangeListener` from the configuration.
`void`	`addServer(InetSocketAddress server)` Adds a server to initially attempt to connect to.
`void`	`addServer(String server)` Adds a server to initially attempt to connect to.
`void`	`authenticate(String userName, String password)` Deprecated. Replaced with the more general `Credential` capability. Will be removed after the 1.3.0 release.
`void`	`authenticateAsAdmin(String userName, String password)` Deprecated. Replaced with the more general `Credential` capability. Will be removed after the 1.3.0 release.
`MongoClientConfiguration`	`clone()` Creates a copy of this MongoClientConfiguration.
`ConnectionModel`	`getConnectionModel()` Returns the model the driver uses for managing connections.
`int`	`getConnectTimeout()` Returns how long to wait (in milliseconds) for a socket connection to complete.
`Collection<Credential>`	`getCredentials()` Returns the map of database names to credentials to use to access that database on the server.
`String`	`getDefaultDatabase()` Deprecated. Replaced with the more general `Credential` capability. Will be removed after the 1.3.0 release.
`Durability`	`getDefaultDurability()` Returns the default durability for write operations on the server.
`ReadPreference`	`getDefaultReadPreference()` Returns the default read preference for a query.
`Executor`	`getExecutor()` Returns the executor to use when processing responses from the server.
`LockType`	`getLockType()` Returns the type of hand off lock to use between threads in the core of the driver.
`int`	`getMaxCachedStringEntries()` Returns the maximum number of strings that may have their encoded form cached.
`int`	`getMaxCachedStringLength()` Returns the maximum length for a string that the stream is allowed to cache.This can be used to stop a single long string from pushing useful values out of the cache.
`int`	`getMaxConnectionCount()` Returns the maximum number of connections to use.
`int`	`getMaxIdleTickCount()` Returns the number of read timeouts (a tick) before closing the connection.
`int`	`getMaxPendingOperationsPerConnection()` Returns the maximum number of pending operations to allow per connection.
`long`	`getMaxSecondaryLag()` Returns the maximum number of milliseconds that a secondary can be behind the primary before they will be excluded from being used for queries on secondaries.
`int`	`getMinConnectionCount()` Returns the minimum number of connections to try and keep open.
`String`	`getPasswordHash()` Deprecated. Replaced with the more general `Credential` capability. Will be removed after the 1.3.0 release.
`int`	`getReadTimeout()` Returns how long to wait (in milliseconds) for a socket read to complete.
`int`	`getReconnectTimeout()` Returns how long to wait (in milliseconds) for a broken connection to be reconnected.
`List<InetSocketAddress>`	`getServerAddresses()` Returns the list of servers to initially attempt to connect to.
`List<String>`	`getServers()` Returns the list of servers to initially attempt to connect to.
`SocketFactory`	`getSocketFactory()` Returns the socket factory to use in making connections to the MongoDB server.
`ThreadFactory`	`getThreadFactory()` Returns the thread factory for managing connections.
`String`	`getUserName()` Deprecated. Replaced with the more general `Credential` capability. Will be removed after the 1.3.0 release.
`boolean`	`isAdminUser()` Deprecated. Replaced with the more general `Credential` capability. Will be removed after the 1.3.0 release.
`boolean`	`isAuthenticating()` Returns true if the connection is authenticating.
`boolean`	`isAutoDiscoverServers()` Returns if additional servers are auto discovered or if connections are limited to the ones manually configured.
`boolean`	`isUsingSoKeepalive()` Returns if the `SO_KEEPALIVE` socket option is set.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Removes a `PropertyChangeListener` from the configuration.
`void`	`removePropertyChangeListener(String propertyName, PropertyChangeListener listener)` Removes a `PropertyChangeListener` from the configuration.
`void`	`setAutoDiscoverServers(boolean autoDiscoverServers)` Sets if additional servers are auto discovered or if connections are limited to the ones manually configured.
`void`	`setConnectionModel(ConnectionModel connectionModel)` Sets the model the driver uses for managing connections.
`void`	`setConnectTimeout(int connectTimeout)` Sets how long to wait (in milliseconds) for a socket connection to complete.
`void`	`setCredentials(Collection<Credential> credentials)` Sets the credentials to use to access the server.
`void`	`setDefaultDatabase(String defaultDatabase)` Deprecated. Replaced with the more general `Credential` capability. Will be removed after the 1.3.0 release.
`void`	`setDefaultDurability(Durability defaultDurability)` Sets the default durability for write operations on the server to the new value.
`void`	`setDefaultReadPreference(ReadPreference defaultReadPreference)` Sets the value of the default read preference for a query.
`void`	`setExecutor(Executor executor)` Sets the value of executor for replies from the server.
`void`	`setLockType(LockType lockType)` Sets the type of hand off lock to use between threads in the core of the driver.
`void`	`setMaxCachedStringEntries(int maxCacheEntries)` Sets the value of maximum number of strings that may have their encoded form cached.
`void`	`setMaxCachedStringLength(int maxlength)` Sets the value of length for a string that may be cached.
`void`	`setMaxConnectionCount(int maxConnectionCount)` Sets the maximum number of connections to use.
`void`	`setMaxIdleTickCount(int idleTickCount)` Sets the value of the number of read timeouts (a tick) before closing the connection.
`void`	`setMaxPendingOperationsPerConnection(int maxPendingOperationsPerConnection)` Sets the maximum number of pending operations to allow per connection.
`void`	`setMaxSecondaryLag(long maxSecondaryLag)` Sets the maximum number of milliseconds that a secondary can be behind the primary before they will be excluded from being used for queries on secondaries.
`void`	`setMinConnectionCount(int minimumConnectionCount)` Sets the value of the minimum number of connections to try and keep open.
`void`	`setReadTimeout(int readTimeout)`
`void`	`setReconnectTimeout(int connectTimeout)` Sets how long to wait (in milliseconds) for a broken connection to reconnect.
`void`	`setServers(List<InetSocketAddress> servers)` Sets the servers to initially attempt to connect to.
`void`	`setSocketFactory(SocketFactory socketFactory)` Sets the socket factory to use in making connections to the MongoDB server.
`void`	`setThreadFactory(ThreadFactory factory)` Sets the thread factory for managing connections to the new value.
`void`	`setUsingSoKeepalive(boolean usingSoKeepalive)` Sets if the `SO_KEEPALIVE` socket option is set.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ADMIN_DB_NAME
```
public static final String ADMIN_DB_NAME
```
    The name of the administration database.
    
    See Also:
    Constant Field Values
  - DEFAULT_DB_NAME
```
public static final String DEFAULT_DB_NAME
```
    The default database.
    
    See Also:
    Constant Field Values
  - UTF8
```
public static final Charset UTF8
```
    The ASCII character encoding.
  - DEFAULT_MAX_STRING_CACHE_ENTRIES
```
protected static final int DEFAULT_MAX_STRING_CACHE_ENTRIES
```
    The default maximum number of strings to keep in the string encoder and decoder cache.
    
    See Also:
    Constant Field Values
  - DEFAULT_MAX_STRING_CACHE_LENGTH
```
protected static final int DEFAULT_MAX_STRING_CACHE_LENGTH
```
    The default maximum length byte array / string to cache.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - MongoClientConfiguration
```
public MongoClientConfiguration()
```
    Creates a new MongoClientConfiguration.
  - MongoClientConfiguration
```
public MongoClientConfiguration(InetSocketAddress... servers)
```
    Creates a new MongoClientConfiguration.
    
    Parameters:
    servers - The initial set of servers to connect to.
  - MongoClientConfiguration
```
public MongoClientConfiguration(MongoClientConfiguration other)
```
    Creates a new MongoClientConfiguration.
    
    Parameters:
    other - The configuration to copy.
  - MongoClientConfiguration
```
public MongoClientConfiguration(MongoDbUri mongoDbUri)
                         throws IllegalArgumentException
```
    Creates a new MongoClientConfiguration instance using a MongoDB style URL to initialize its state. Further configuration is possible once the MongoClientConfiguration has been instantiated.
    
    Parameters:
    mongoDbUri - The configuration for the connection to MongoDB expressed as a MongoDB URL.
    
    Throws:
    
    IllegalArgumentException - If the mongoDbUri is not a properly formated MongoDB style URL.
    See Also:
    MongoDB Connections
  - MongoClientConfiguration
```
public MongoClientConfiguration(String mongoDbUri)
                         throws IllegalArgumentException
```
    Creates a new MongoClientConfiguration instance using a MongoDB style URL to initialize its state. Further configuration is possible once the MongoClientConfiguration has been instantiated.
    
    Parameters:
    mongoDbUri - The configuration for the connection to MongoDB expressed as a MongoDB URL.
    
    Throws:
    
    IllegalArgumentException - If the mongoDbUri is not a properly formated MongoDB style URL.
    See Also:
    MongoDB Connections
  - MongoClientConfiguration
```
protected MongoClientConfiguration(MongoDbUri mongoDbUri,
                        Durability defaultDurability)
                            throws IllegalArgumentException
```
    Creates a new MongoClientConfiguration instance using a MongoDB style URL to initialize its state. Further configuration is possible once the MongoClientConfiguration has been instantiated.
    
    Parameters:
    mongoDbUri - The configuration for the connection to MongoDB expressed as a MongoDB URL.
    defaultDurability - The default durability.
    
    Throws:
    
    IllegalArgumentException - If the mongoDbUri is not a properly formated MongoDB style URL.
    See Also:
    MongoDB Connections
- Method Detail
  - addCredential
```
public void addCredential(Credential credentials)
                   throws IllegalArgumentException
```
    Adds the specified credentials to the configuration.
    
    Parameters:
    credentials - The credentials to use when accessing the MongoDB server.
    
    Throws:
    
    IllegalArgumentException - If the credentials refer to an unknown authentication type or the configuration already has a set of credentials for the credentials specified database.
  - addCredential
```
public void addCredential(Credential.Builder credentials)
                   throws IllegalArgumentException
```
    Adds the specified credentials to the configuration.
    
    Parameters:
    credentials - The credentials to use when accessing the MongoDB server.
    
    Throws:
    
    IllegalArgumentException - If the credentials refer to an unknown authentication type or the configuration already has a set of credentials for the credentials specified database.
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener listener)
```
    Add a PropertyChangeListener from the configuration. The listener will receive notification of all changes to the configuration.
    
    Parameters:
    listener - The PropertyChangeListener to be added
  - addPropertyChangeListener
```
public void addPropertyChangeListener(String propertyName,
                             PropertyChangeListener listener)
```
    Add a PropertyChangeListener from the configuration. The listener will receive notification of all changes to the configuration's specified property.
    
    Parameters:
    propertyName - The name of the property to listen on.
    listener - The PropertyChangeListener to be added
  - addServer
```
public void addServer(InetSocketAddress server)
```
    Adds a server to initially attempt to connect to.
    
    Parameters:
    server - The server to add.
  - addServer
```
public void addServer(String server)
```
    Adds a server to initially attempt to connect to.
    
    Parameters:
    server - The server to add.
  - authenticate
```
@Deprecated
public void authenticate(String userName,
                           String password)
                  throws MongoDbAuthenticationException
```
    Deprecated. Replaced with the more general Credential capability. Will be removed after the 1.3.0 release.
    
    Sets up the instance to authenticate with the MongoDB servers. This should be done before using this configuration to instantiate a Mongo instance.
    
    Parameters:
    userName - The user name.
    password - the password.
    
    Throws:
    
    MongoDbAuthenticationException - On a failure initializing the authentication information.
  - authenticateAsAdmin
```
@Deprecated
public void authenticateAsAdmin(String userName,
                                  String password)
                         throws MongoDbAuthenticationException
```
    Deprecated. Replaced with the more general Credential capability. Will be removed after the 1.3.0 release.
    
    Sets up the instance to authenticate with the MongoDB servers. This should be done before using this configuration to instantiate a Mongo instance.
    
    Parameters:
    userName - The user name.
    password - the password.
    
    Throws:
    
    MongoDbAuthenticationException - On a failure initializing the authentication information.
  - clone
```
public MongoClientConfiguration clone()
```
    Creates a copy of this MongoClientConfiguration.
    Note: This is not a traditional clone to ensure a deep copy of all information.
    
    Overrides:
    
    clone in class Object
  - getConnectionModel
```
public ConnectionModel getConnectionModel()
```
    Returns the model the driver uses for managing connections.
    Defaults to ConnectionModel.RECEIVER_THREAD.
    
    Returns:
    The model used for managing connections.
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Returns how long to wait (in milliseconds) for a socket connection to complete.
    Defaults to 0 or forever.
    
    Returns:
    The time to wait (in milliseconds) for a socket connection to complete.
  - getCredentials
```
public Collection<Credential> getCredentials()
```
    Returns the map of database names to credentials to use to access that database on the server.
    
    Returns:
    The map of database names to credentials to use to access that database on the server.
  - getDefaultDatabase
```
@Deprecated
public String getDefaultDatabase()
```
    Deprecated. Replaced with the more general Credential capability. Will be removed after the 1.3.0 release.
    
    Returns the default database for the connection.
    This is used as the database to authenticate against if the user is not an administrative user.
    
    Defaults to "local".
    
    Returns:
    The default database value.
  - getDefaultDurability
```
public Durability getDefaultDurability()
```
    Returns the default durability for write operations on the server.
    Defaults to Durability.ACK.
    
    Returns:
    The default durability for write operations on the server.
  - getDefaultReadPreference
```
public ReadPreference getDefaultReadPreference()
```
    Returns the default read preference for a query.
    Defaults to ReadPreference.PRIMARY.
    
    Returns:
    The default read preference for a query.
  - getExecutor
```
public Executor getExecutor()
```
    Returns the executor to use when processing responses from the server.
    By default the executor is null which will cause the reply handling to execute on the socket's receive thread.
    
    Care should be taken to ensure that the executor does not drop requests. This implies that the ThreadPoolExecutor.CallerRunsPolicy or similar should be used as the RejectedExecutionHandler.
    
    Returns:
    The executor value.
  - getLockType
```
public LockType getLockType()
```
    Returns the type of hand off lock to use between threads in the core of the driver.
    Defaults to LockType.MUTEX.
    
    Returns:
    The type of hand off lock used.
  - getMaxCachedStringEntries
```
public int getMaxCachedStringEntries()
```
    Returns the maximum number of strings that may have their encoded form cached.
    Defaults to 1024.
    
    Note: The caches are maintained per connection and there is a cache for the encoder and another for the decoder. The results is that caching 25 string with 10 connections can result in 500 cache entries (2 * 25 * 10).
    
    Returns:
    The maximum number of strings that may have their encoded form cached.
  - getMaxCachedStringLength
```
public int getMaxCachedStringLength()
```
    Returns the maximum length for a string that the stream is allowed to cache.This can be used to stop a single long string from pushing useful values out of the cache. Setting this value to zero turns off the caching.
    Defaults to 25.
    
    Note: The caches are maintained per connection and there is a cache for the encoder and another for the decoder. The results is that caching 25 string with 10 connections can result in 500 cache entries (2 * 25 * 10).
    
    Returns:
    The maximum length for a string that the stream is allowed to cache.
  - getMaxConnectionCount
```
public int getMaxConnectionCount()
```
    Returns the maximum number of connections to use.
    Defaults to 3.
    
    Note: In the case of connecting to a replica set this setting limits the number of connections to the primary server. The driver will create single connections to the secondary servers if queries are issued with a ReadPreference other than ReadPreference.PRIMARY.
    
    Returns:
    The maximum connections to use.
  - getMaxIdleTickCount
```
public int getMaxIdleTickCount()
```
    Returns the number of read timeouts (a tick) before closing the connection.
    Defaults to Integer.MAX_VALUE.
    
    Returns:
    The number of read timeouts (a tick) before closing the connection.
  - getMaxPendingOperationsPerConnection
```
public int getMaxPendingOperationsPerConnection()
```
    Returns the maximum number of pending operations to allow per connection. The higher the value the more "asynchronous" the driver can be but risks more operations being in an unknown state on a connection error. When the connection has this many pending connections additional requests will block.
    Defaults to 1024.
    
    Note: In the case of an connection error it is impossible to determine which pending operations completed and which did not. Setting this value to 1 results in synchronous operations that wait for responses.
    
    Returns:
    The maximum number of pending operations to allow per connection.
  - getMaxSecondaryLag
```
public long getMaxSecondaryLag()
```
    Returns the maximum number of milliseconds that a secondary can be behind the primary before they will be excluded from being used for queries on secondaries.
    Defaults to 5 minutes (300,000).
    
    Returns:
    The maximum number of milliseconds that a secondary can be behind the primary before they will be excluded from being used for queries on secondaries.
  - getMinConnectionCount
```
public int getMinConnectionCount()
```
    Returns the minimum number of connections to try and keep open.
    Defaults to 0.
    
    Returns:
    The minimum number of connections to try and keep open.
  - getPasswordHash
```
@Deprecated
public String getPasswordHash()
```
    Deprecated. Replaced with the more general Credential capability. Will be removed after the 1.3.0 release.
    
    Gets the password hash for authentication with the database.
    
    Returns:
    The password hash for authentication with the database.
  - getReadTimeout
```
public int getReadTimeout()
```
    Returns how long to wait (in milliseconds) for a socket read to complete.
    Defaults to 0 or never.
    
    Returns:
    The time to wait (in milliseconds) for a socket read to complete.
  - getReconnectTimeout
```
public int getReconnectTimeout()
```
    Returns how long to wait (in milliseconds) for a broken connection to be reconnected.
    Defaults to 0 or forever.
    
    Returns:
    The time to wait (in milliseconds) for a broken connection to be reconnected.
  - getServerAddresses
```
public List<InetSocketAddress> getServerAddresses()
```
    Returns the list of servers to initially attempt to connect to.
    
    Returns:
    The list of servers to initially attempt to connect to.
  - getServers
```
public List<String> getServers()
```
    Returns the list of servers to initially attempt to connect to.
    
    Returns:
    The list of servers to initially attempt to connect to.
  - getSocketFactory
```
public SocketFactory getSocketFactory()
```
    Returns the socket factory to use in making connections to the MongoDB server.
    Defaults to SocketFactory.getDefault() .
    
    Returns:
    The socketFactory value.
    See Also:
    setSocketFactory(...) or usage examples and suggestions.
  - getThreadFactory
```
public ThreadFactory getThreadFactory()
```
    Returns the thread factory for managing connections.
    
    Returns:
    The thread factory for managing connections.
  - getUserName
```
@Deprecated
public String getUserName()
```
    Deprecated. Replaced with the more general Credential capability. Will be removed after the 1.3.0 release.
    
    Gets the user name for authenticating with the database.
    
    Returns:
    The user name for authenticating with the database.
  - isAdminUser
```
@Deprecated
public boolean isAdminUser()
```
    Deprecated. Replaced with the more general Credential capability. Will be removed after the 1.3.0 release.
    
    Returns true if the user should authenticate as an administrative user.
    
    Returns:
    True if the user should authenticate as an administrative user.
  - isAuthenticating
```
public boolean isAuthenticating()
```
    Returns true if the connection is authenticating. If any credentials have been added to this configuration then all connections will use authentication.
    
    Returns:
    True if the connections should authenticate with the server.
  - isAutoDiscoverServers
```
public boolean isAutoDiscoverServers()
```
    Returns if additional servers are auto discovered or if connections are limited to the ones manually configured.
    Defaults to true, e.g., auto-discover.
    
    Returns:
    True if additional servers are auto discovered
  - isUsingSoKeepalive
```
public boolean isUsingSoKeepalive()
```
    Returns if the SO_KEEPALIVE socket option is set.
    Defaults to true, e.g., use SO_KEEPALIVE.
    
    Returns:
    True if the SO_KEEPALIVE socket option is set.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener listener)
```
    Removes a PropertyChangeListener from the configuration. The listener will no longer receive notification of all changes to the configuration.
    
    Parameters:
    listener - The PropertyChangeListener to be removed
  - removePropertyChangeListener
```
public void removePropertyChangeListener(String propertyName,
                                PropertyChangeListener listener)
```
    Removes a PropertyChangeListener from the configuration. The listener will no longer receive notification of all changes to the configuration's specified property.
    
    Parameters:
    propertyName - The name of the property that was listened on.
    listener - The PropertyChangeListener to be removed
  - setAutoDiscoverServers
```
public void setAutoDiscoverServers(boolean autoDiscoverServers)
```
    Sets if additional servers are auto discovered or if connections are limited to the ones manually configured.
    Defaults to true, e.g., auto-discover.
    
    Parameters:
    autoDiscoverServers - The new value for auto-discovering servers.
  - setConnectionModel
```
public void setConnectionModel(ConnectionModel connectionModel)
```
    Sets the model the driver uses for managing connections.
    Defaults to ConnectionModel.RECEIVER_THREAD.
    
    Parameters:
    connectionModel - The new value for the model the driver uses for managing connections.
  - setConnectTimeout
```
public void setConnectTimeout(int connectTimeout)
```
    Sets how long to wait (in milliseconds) for a socket connection to complete.
    
    Parameters:
    connectTimeout - The time to wait (in milliseconds) for a socket connection to complete.
  - setCredentials
```
public void setCredentials(Collection<Credential> credentials)
```
    Sets the credentials to use to access the server. This removes all existing credentials.
    
    Parameters:
    credentials - The credentials to use to access the server..
    
    Throws:
    
    IllegalArgumentException - If the credentials refer to an unknown authentication type or the configuration already has a set of credentials for the credentials specified database.
  - setDefaultDatabase
```
@Deprecated
public void setDefaultDatabase(String defaultDatabase)
```
    Deprecated. Replaced with the more general Credential capability. Will be removed after the 1.3.0 release.
    
    Sets the default database for the connection.
    This is used as the database to authenticate against if the user is not an administrative user.
    
    Defaults to "local".
    
    Parameters:
    defaultDatabase - The new default database value.
  - setDefaultDurability
```
public void setDefaultDurability(Durability defaultDurability)
```
    Sets the default durability for write operations on the server to the new value.
    
    Parameters:
    defaultDurability - The default durability for write operations on the server.
  - setDefaultReadPreference
```
public void setDefaultReadPreference(ReadPreference defaultReadPreference)
```
    Sets the value of the default read preference for a query.
    Defaults to ReadPreference.PRIMARY if null is set.
    
    Parameters:
    defaultReadPreference - The default read preference for a query.
  - setExecutor
```
public void setExecutor(Executor executor)
```
    Sets the value of executor for replies from the server.
    By default the executor is null which will cause the reply handling to execute on the socket's receive thread.
    
    Care should be taken to ensure that the executor does not drop requests. This implies that the ThreadPoolExecutor.CallerRunsPolicy or similar should be used as the RejectedExecutionHandler.
    
    Parameters:
    executor - The new value for the executor.
  - setLockType
```
public void setLockType(LockType lockType)
```
    Sets the type of hand off lock to use between threads in the core of the driver.
    Defaults to LockType.MUTEX.
    
    Parameters:
    lockType - The new value for the type of hand off lock used.
  - setMaxCachedStringEntries
```
public void setMaxCachedStringEntries(int maxCacheEntries)
```
    Sets the value of maximum number of strings that may have their encoded form cached.
    Defaults to 1024.
    
    Note: The caches are maintained per MongoClient instance.
    
    Parameters:
    maxCacheEntries - The new value for the maximum number of strings that may have their encoded form cached.
  - setMaxCachedStringLength
```
public void setMaxCachedStringLength(int maxlength)
```
    Sets the value of length for a string that may be cached. This can be used to stop a single long string from pushing useful values out of the cache. Setting this value to zero turns off the caching.
    Defaults to 25.
    
    Note: The caches are maintained per MongoClient instance.
    
    Parameters:
    maxlength - The new value for the length for a string that the encoder is allowed to cache.
  - setMaxConnectionCount
```
public void setMaxConnectionCount(int maxConnectionCount)
```
    Sets the maximum number of connections to use.
    Defaults to 3.
    
    Note: In the case of connecting to a replica set this setting limits the number of connections to the primary server. The driver will create single connections to the secondary servers if queries are issued with a ReadPreference other than ReadPreference.PRIMARY.
    
    Parameters:
    maxConnectionCount - New maximum number of connections to use.
  - setMaxIdleTickCount
```
public void setMaxIdleTickCount(int idleTickCount)
```
    Sets the value of the number of read timeouts (a tick) before closing the connection.
    
    Parameters:
    idleTickCount - The new value for the number of read timeouts (a tick) before closing the connection.
  - setMaxPendingOperationsPerConnection
```
public void setMaxPendingOperationsPerConnection(int maxPendingOperationsPerConnection)
```
    Sets the maximum number of pending operations to allow per connection. The higher the value the more "asynchronous" the driver can be but risks more operations being in an unknown state on a connection error. When the connection has this many pending connections additional requests will block.
    
    Parameters:
    maxPendingOperationsPerConnection - The new maximum number of pending operations to allow per connection.
  - setMaxSecondaryLag
```
public void setMaxSecondaryLag(long maxSecondaryLag)
```
    Sets the maximum number of milliseconds that a secondary can be behind the primary before they will be excluded from being used for queries on secondaries.
    Defaults to 5 minutes (300,000).
    
    Parameters:
    maxSecondaryLag - The new value for the maximum number of milliseconds that a secondary can be behind the primary before they will be excluded from being used for queries on secondaries.
  - setMinConnectionCount
```
public void setMinConnectionCount(int minimumConnectionCount)
```
    Sets the value of the minimum number of connections to try and keep open.
    
    Parameters:
    minimumConnectionCount - The new value for the minimum number of connections to try and keep open.
  - setReadTimeout
```
public void setReadTimeout(int readTimeout)
```
    Parameters:
    readTimeout - The time to wait (in milliseconds) for a socket read to complete.
  - setReconnectTimeout
```
public void setReconnectTimeout(int connectTimeout)
```
    Sets how long to wait (in milliseconds) for a broken connection to reconnect.
    
    Parameters:
    connectTimeout - The time to wait (in milliseconds) for a broken connection to reconnect.
  - setServers
```
public void setServers(List<InetSocketAddress> servers)
```
    Sets the servers to initially attempt to connect to.
    
    Parameters:
    servers - The servers to connect to.
  - setSocketFactory
```
public void setSocketFactory(SocketFactory socketFactory)
```
    Sets the socket factory to use in making connections to the MongoDB server. Setting the SocketFactory to null resets the factory to the default.
    Defaults to SocketFactory.getDefault().
    
    For SSL based connections this can be an appropriately configured SSLSocketFactory.
    
    Other Socket and InetSocketAddress implementations with an appropriate SocketFactory implementation can be used with the driver. The driver only ever calls the SocketFactory.createSocket() method and then connects the socket passing the server's InetSocketAddress.
    
    See the junixsocket Project for an example of a Socket and InetSocketAddress implementations for UNIX Domain Sockets that can be wrapped with SocketFactory similar to the following:
    public class AFUNIXSocketFactory extends SocketFactory { public Socket createSocket() throws java.io.IOException { return new org.newsclub.net.unix.AFUNIXSocket.newInstance(); } public Socket createSocket(String host, int port) throws SocketException { throw new SocketException("AFUNIX socket does not support connections to a host/port"); } public Socket createSocket(InetAddress host, int port) throws SocketException { throw new SocketException("AFUNIX socket does not support connections to a host/port"); } public Socket createSocket(String host, int port, InetAddress localHost, int localPort) throws SocketException { throw new SocketException("AFUNIX socket does not support connections to a host/port"); } public Socket createSocket(InetAddress address, int port, InetAddress localAddress, int localPort) throws SocketException { throw new SocketException("AFUNIX socket does not support connections to a host/port"); } }
    Parameters:
    socketFactory - The socketFactory value.
    See Also:
    junixsocket Project
  - setThreadFactory
```
public void setThreadFactory(ThreadFactory factory)
```
    Sets the thread factory for managing connections to the new value.
    
    Parameters:
    factory - The thread factory for managing connections.
  - setUsingSoKeepalive
```
public void setUsingSoKeepalive(boolean usingSoKeepalive)
```
    Sets if the SO_KEEPALIVE socket option is set.
    Defaults to true, e.g., use SO_KEEPALIVE.
    
    Parameters:
    usingSoKeepalive - The new value for using SO_KEEPALIVE.

Class MongoClientConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ADMIN_DB_NAME

DEFAULT_DB_NAME

UTF8

DEFAULT_MAX_STRING_CACHE_ENTRIES

DEFAULT_MAX_STRING_CACHE_LENGTH

Constructor Detail

MongoClientConfiguration

MongoClientConfiguration

MongoClientConfiguration

MongoClientConfiguration

MongoClientConfiguration

MongoClientConfiguration

Method Detail

addCredential

addCredential

addPropertyChangeListener

addPropertyChangeListener

addServer

addServer

authenticate

authenticateAsAdmin

clone

getConnectionModel

getConnectTimeout

getCredentials

getDefaultDatabase

getDefaultDurability

getDefaultReadPreference

getExecutor

getLockType

getMaxCachedStringEntries

getMaxCachedStringLength

getMaxConnectionCount

getMaxIdleTickCount

getMaxPendingOperationsPerConnection

getMaxSecondaryLag

getMinConnectionCount

getPasswordHash

getReadTimeout

getReconnectTimeout

getServerAddresses

getServers

getSocketFactory

getThreadFactory

getUserName

isAdminUser

isAuthenticating

isAutoDiscoverServers

isUsingSoKeepalive

removePropertyChangeListener

removePropertyChangeListener

setAutoDiscoverServers

setConnectionModel

setConnectTimeout

setCredentials

setDefaultDatabase

setDefaultDurability

setDefaultReadPreference

setExecutor

setLockType

setMaxCachedStringEntries

setMaxCachedStringLength

setMaxConnectionCount

setMaxIdleTickCount

setMaxPendingOperationsPerConnection

setMaxSecondaryLag

setMinConnectionCount

setReadTimeout

setReconnectTimeout

setServers

setSocketFactory

setThreadFactory

setUsingSoKeepalive