ConnectionString

java.lang.Object
- com.mongodb.ConnectionString

```
public class ConnectionString
extends Object
```
Represents a Connection String. The Connection String describes the hosts to be used and options.

The format of the Connection String is:
```
   mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]
 
```
- mongodb:// is a required prefix to identify that this is a string in the standard connection format.
- username:password@ are optional. If given, the driver will attempt to login to a database after connecting to a database server. For some authentication mechanisms, only the username is specified and the password is not, in which case the ":" after the username is left off as well
- host1 is the only required part of the connection string. It identifies a server address to connect to.
- :portX is optional and defaults to :27017 if not provided.
- /database is the name of the database to login to and thus is only relevant if the username:password@ syntax is used. If not specified the "admin" database will be used by default.
- ?options are connection options. Note that if database is absent there is still a / required between the last host and the ? introducing the options. Options are name=value pairs and the pairs are separated by "&". For backwards compatibility, ";" is accepted as a separator in addition to "&", but should be considered as deprecated.
The following options are supported (case insensitive):

Server Selection Configuration:
- serverSelectionTimeoutMS=ms: How long the driver will wait for server selection to succeed before throwing an exception.
- localThresholdMS=ms: When choosing among multiple MongoDB servers to send a request, the driver 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 local threshold.
Server Monitoring Configuration:
- heartbeatFrequencyMS=ms: The frequency that the driver will attempt to determine the current state of each server in the cluster.
Replica set configuration:
- replicaSet=name: Implies that the hosts given are a seed list, and the driver will attempt to find all members of the set.
Connection Configuration:

Connection Configuration:
- streamType=nio2|netty: The stream type to use for connections. If unspecified, nio2 will be used.
- ssl=true|false: Whether to connect using SSL.
- sslInvalidHostNameAllowed=true|false: Whether to allow invalid host names for SSL connections.
- connectTimeoutMS=ms: How long a connection can take to be opened before timing out.
- socketTimeoutMS=ms: How long a send or receive on a socket can take before timing out.
- maxIdleTimeMS=ms: Maximum idle time of a pooled connection. A connection that exceeds this limit will be closed
- maxLifeTimeMS=ms: Maximum life time of a pooled connection. A connection that exceeds this limit will be closed
Connection pool configuration:
- maxPoolSize=n: The maximum number of connections in the connection pool.
- waitQueueMultiple=n : this multiplier, multiplied with the maxPoolSize 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.
- waitQueueTimeoutMS=ms: The maximum wait time in milliseconds that a thread may wait for a connection to become available.
Write concern configuration:
- safe=true|false
  - true: the driver sends a getLastError command after every update to ensure that the update succeeded (see also w and wtimeoutMS).
  - false: the driver does not send a getLastError command after every update.
- journal=true|false
  - true: the driver waits for the server to group commit to the journal file on disk.
  - false: the driver does not wait for the server to group commit to the journal file on disk.
- w=wValue
  - The driver adds { w : wValue } to the getLastError command. Implies safe=true.
  - wValue is typically a number, but can be any string in order to allow for specifications like "majority"
- wtimeoutMS=ms
  - The driver adds { wtimeout : ms } to the getlasterror command. Implies safe=true.
  - Used in combination with w
Read preference configuration:
- readPreference=enum: The read preference for this connection.
  - Enumerated values:
    - primary
    - primaryPreferred
    - secondary
    - secondaryPreferred
    - nearest
- readPreferenceTags=string. A representation of a tag set as a comma-separated list of colon-separated key-value pairs, e.g. "dc:ny,rack:1". Spaces are stripped from beginning and end of all keys and values. To specify a list of tag sets, using multiple readPreferenceTags, e.g. readPreferenceTags=dc:ny,rack:1;readPreferenceTags=dc:ny;readPreferenceTags=
  - Note the empty value for the last one, which means match any secondary as a last resort.
  - Order matters when using multiple readPreferenceTags.
- maxStalenessMS=ms. The maximum staleness in milliseconds. For use with any non-primary read preference, the driver estimates the staleness of each secondary, based on lastWriteDate values provided in server isMaster responses, and selects only those secondaries whose staleness is less than or equal to maxStalenessMS. The default is 0, meaning there is no staleness check.
Authentication configuration:
- authMechanism=MONGO-CR|GSSAPI|PLAIN|MONGODB-X509: The authentication mechanism to use if a credential was supplied. The default is unspecified, in which case the client will pick the most secure mechanism available based on the sever version. For the GSSAPI and MONGODB-X509 mechanisms, no password is accepted, only the username.
- authSource=string: The source of the authentication credentials. This is typically the database that the credentials have been created. The value defaults to the database specified in the path portion of the connection string. If the database is specified in neither place, the default value is "admin". This option is only respected when using the MONGO-CR mechanism (the default).
- authMechanismProperties=PROPERTY_NAME:PROPERTY_VALUE,PROPERTY_NAME2:PROPERTY_VALUE2: This option allows authentication mechanism properties to be set on the connection string.
- gssapiServiceName=string: This option only applies to the GSSAPI mechanism and is used to alter the service name. Deprecated, please use authMechanismProperties=SERVICE_NAME:string instead.
Server Handshake configuration:
- appName=string: Sets the logical name of the application. The application name may be used by the client to identify the application to the server, for use in server logs, slow query logs, and profile collection.
Since:

3.0.0

MongoDB documentation

Connection String Format

Constructor Summary

Constructors
Constructor and Description

ConnectionString(String connectionString)
Creates a ConnectionString from the given string.

Constructors
Constructor and Description
`ConnectionString(String connectionString)` Creates a ConnectionString from the given string.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getApplicationName()` Gets the logical name of the application.
`String`	`getCollection()` Gets the collection name
`String`	`getConnectionString()` Get the unparsed connection string.
`Integer`	`getConnectTimeout()` Gets the socket connect timeout specified in the connection string.
`List<MongoCredential>`	`getCredentialList()` Gets the credentials.
`String`	`getDatabase()` Gets the database name
`Integer`	`getHeartbeatFrequency()`
`List<String>`	`getHosts()` Gets the list of hosts
`Integer`	`getLocalThreshold()`
`Integer`	`getMaxConnectionIdleTime()` Gets the maximum connection idle time specified in the connection string.
`Integer`	`getMaxConnectionLifeTime()` Gets the maximum connection life time specified in the connection string.
`Integer`	`getMaxConnectionPoolSize()` Gets the maximum connection pool size specified in the connection string.
`Integer`	`getMaxWaitTime()` Gets the maximum wait time of a thread waiting for a connection specified in the connection string.
`Integer`	`getMinConnectionPoolSize()` Gets the minimum connection pool size specified in the connection string.
`char[]`	`getPassword()` Gets the password
`ReadConcern`	`getReadConcern()` Gets the read concern specified in the connection string.
`ReadPreference`	`getReadPreference()` Gets the read preference specified in the connection string.
`String`	`getRequiredReplicaSetName()` Gets the required replica set name specified in the connection string.
`Integer`	`getServerSelectionTimeout()`
`Integer`	`getSocketTimeout()` Gets the socket timeout specified in the connection string.
`Boolean`	`getSslEnabled()` Gets the SSL enabled value specified in the connection string.
`Boolean`	`getSslInvalidHostnameAllowed()` Gets the SSL invalidHostnameAllowed value specified in the connection string.
`String`	`getStreamType()` Gets the stream type value specified in the connection string.
`Integer`	`getThreadsAllowedToBlockForConnectionMultiplier()` Gets the multiplier for the number of threads allowed to block waiting for a connection specified in the connection string.
`String`	`getURI()` Deprecated.
`String`	`getUsername()` Gets the username
`WriteConcern`	`getWriteConcern()` Gets the write concern specified in the connection string.
`int`	`hashCode()`
`String`	`toString()`

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

- Constructor Detail
  - ConnectionString
```
public ConnectionString(String connectionString)
```
    Creates a ConnectionString from the given string.
    
    Parameters:
    
    connectionString - the connection string
    
    Since:
    
    3.0
- Method Detail
  - getUsername
```
public String getUsername()
```
    Gets the username
    
    Returns:
    
    the username
  - getPassword
```
public char[] getPassword()
```
    Gets the password
    
    Returns:
    
    the password
  - getHosts
```
public List<String> getHosts()
```
    Gets the list of hosts
    
    Returns:
    
    the host list
  - getDatabase
```
public String getDatabase()
```
    Gets the database name
    
    Returns:
    
    the database name
  - getCollection
```
public String getCollection()
```
    Gets the collection name
    
    Returns:
    
    the collection name
  - getURI
```
@Deprecated
public String getURI()
```
    Deprecated.
    
    Get the unparsed connection string.
    
    Returns:
    
    the connection string deprecated use getConnectionString()
  - getConnectionString
```
public String getConnectionString()
```
    Get the unparsed connection string.
    
    Returns:
    
    the connection string
    
    Since:
    
    3.1
  - getCredentialList
```
public List<MongoCredential> getCredentialList()
```
    Gets the credentials.
    
    Returns:
    
    the credentials
  - getReadPreference
```
public ReadPreference getReadPreference()
```
    Gets the read preference specified in the connection string.
    
    Returns:
    
    the read preference
  - getReadConcern
```
public ReadConcern getReadConcern()
```
    Gets the read concern specified in the connection string.
    
    Returns:
    
    the read concern
  - getWriteConcern
```
public WriteConcern getWriteConcern()
```
    Gets the write concern specified in the connection string.
    
    Returns:
    
    the write concern
  - getMinConnectionPoolSize
```
public Integer getMinConnectionPoolSize()
```
    Gets the minimum connection pool size specified in the connection string.
    
    Returns:
    
    the minimum connection pool size
  - getMaxConnectionPoolSize
```
public Integer getMaxConnectionPoolSize()
```
    Gets the maximum connection pool size specified in the connection string.
    
    Returns:
    
    the maximum connection pool size
  - getThreadsAllowedToBlockForConnectionMultiplier
```
public Integer getThreadsAllowedToBlockForConnectionMultiplier()
```
    Gets the multiplier for the number of threads allowed to block waiting for a connection specified in the connection string.
    
    Returns:
    
    the multiplier for the number of threads allowed to block waiting for a connection
  - getMaxWaitTime
```
public Integer getMaxWaitTime()
```
    Gets the maximum wait time of a thread waiting for a connection specified in the connection string.
    
    Returns:
    
    the maximum wait time of a thread waiting for a connection
  - getMaxConnectionIdleTime
```
public Integer getMaxConnectionIdleTime()
```
    Gets the maximum connection idle time specified in the connection string.
    
    Returns:
    
    the maximum connection idle time
  - getMaxConnectionLifeTime
```
public Integer getMaxConnectionLifeTime()
```
    Gets the maximum connection life time specified in the connection string.
    
    Returns:
    
    the maximum connection life time
  - getConnectTimeout
```
public Integer getConnectTimeout()
```
    Gets the socket connect timeout specified in the connection string.
    
    Returns:
    
    the socket connect timeout
  - getSocketTimeout
```
public Integer getSocketTimeout()
```
    Gets the socket timeout specified in the connection string.
    
    Returns:
    
    the socket timeout
  - getSslEnabled
```
public Boolean getSslEnabled()
```
    Gets the SSL enabled value specified in the connection string.
    
    Returns:
    
    the SSL enabled value
  - getStreamType
```
public String getStreamType()
```
    Gets the stream type value specified in the connection string.
    
    Returns:
    
    the stream type value
    
    Since:
    
    3.3
  - getSslInvalidHostnameAllowed
```
public Boolean getSslInvalidHostnameAllowed()
```
    Gets the SSL invalidHostnameAllowed value specified in the connection string.
    
    Returns:
    
    the SSL invalidHostnameAllowed value
    
    Since:
    
    3.3
  - getRequiredReplicaSetName
```
public String getRequiredReplicaSetName()
```
    Gets the required replica set name specified in the connection string.
    
    Returns:
    
    the required replica set name
  - getServerSelectionTimeout
```
public Integer getServerSelectionTimeout()
```
    Returns:
    
    the server selection timeout (in milliseconds), or null if unset
    
    Since:
    
    3.3
  - getLocalThreshold
```
public Integer getLocalThreshold()
```
    Returns:
    
    the local threshold (in milliseconds), or null if unset since 3.3
  - getHeartbeatFrequency
```
public Integer getHeartbeatFrequency()
```
    Returns:
    
    the heartbeat frequency (in milliseconds), or null if unset since 3.3
  - getApplicationName
```
public String getApplicationName()
```
    Gets the logical name of the application. The application name may be used by the client to identify the application to the server, for use in server logs, slow query logs, and profile collection.
    Default is null.
    
    Returns:
    
    the application name, which may be null
    
    Since:
    
    3.4
    
    Since server release
    
    3.4
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ConnectionString

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConnectionString

Method Detail

getUsername

getPassword

getHosts

getDatabase

getCollection

getURI

getConnectionString

getCredentialList

getReadPreference

getReadConcern

getWriteConcern

getMinConnectionPoolSize

getMaxConnectionPoolSize

getThreadsAllowedToBlockForConnectionMultiplier

getMaxWaitTime

getMaxConnectionIdleTime

getMaxConnectionLifeTime

getConnectTimeout

getSocketTimeout

getSslEnabled

getStreamType

getSslInvalidHostnameAllowed

getRequiredReplicaSetName

getServerSelectionTimeout

getLocalThreshold

getHeartbeatFrequency

getApplicationName

toString

equals

hashCode