ConnectionString (mongo-java-driver 3.0.0-rc0 API)

java.lang.Object
- com.mongodb.ConnectionString

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

The format of the URI 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 URI. 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):

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:
- ssl=true|false: Whether to connect using SSL.
- 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.
- 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.
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 URI. 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.
Since:

3.0.0

MongoDB documentation

Connection String URI Format

Constructor Summary

Constructors
Constructor and Description

ConnectionString(String uri)
Creates a MongoURI from the given URI string, and MongoClientOptions.Builder.

Constructors
Constructor and Description
`ConnectionString(String uri)` Creates a MongoURI from the given URI string, and MongoClientOptions.Builder.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getCollection()` Gets the collection name
`Integer`	`getConnectTimeout()` Gets the socket connect timeout specified in the connection string.
`List<MongoCredential>`	`getCredentialList()` Gets the credentials.
`String`	`getDatabase()` Gets the database name
`List<String>`	`getHosts()` Gets the list of hosts
`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
`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`	`getSocketTimeout()` Gets the socket timeout specified in the connection string.
`Boolean`	`getSslEnabled()` Gets the SSL enabled 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()` Get the unparsed URI.
`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 uri)
```
    Creates a MongoURI from the given URI string, and MongoClientOptions.Builder. The builder can be configured with default options, which may be overridden by options specified in the URI string.
    
    Parameters:
    uri - the URI
    Since:
    
    2.11.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
```
public String getURI()
```
    Get the unparsed URI.
    
    Returns:
    the URI
  - 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
  - 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
  - getRequiredReplicaSetName
```
public String getRequiredReplicaSetName()
```
    Gets the required replica set name specified in the connection string.
    
    Returns:
    the required replica set name
  - 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

getCredentialList

getReadPreference

getWriteConcern

getMinConnectionPoolSize

getMaxConnectionPoolSize

getThreadsAllowedToBlockForConnectionMultiplier

getMaxWaitTime

getMaxConnectionIdleTime

getMaxConnectionLifeTime

getConnectTimeout

getSocketTimeout

getSslEnabled

getRequiredReplicaSetName

toString

equals

hashCode