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.collection][?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 wellhost1
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 closedmaxLifeTimeMS=ms
: Maximum life time of a pooled connection. A connection that exceeds this limit will be closedConnection 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 ensures that all writes are acknowledged by the MongoDB server, or else throws an exception.
(see also w
and wtimeoutMS
).false
: the driver does not ensure that all writes are acknowledged by the MongoDB server.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
safe=true
."majority"
wtimeoutMS=ms
safe=true
.w
Read preference configuration:
readPreference=enum
: The read preference for this connection.
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=
maxStalenessSeconds=seconds
. The maximum staleness in seconds. 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 maxStalenessSeconds. Not providing the parameter or explicitly setting it to -1
indicates that there should be no max staleness check. The maximum staleness feature is designed to prevent badly-lagging servers from
being selected. The staleness estimate is imprecise and shouldn't be used to try to select "up-to-date" secondaries. The minimum value
is either 90 seconds, or the heartbeat frequency plus 10 seconds, whichever is greatest.
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.Constructor and Description |
---|
ConnectionString(String connectionString)
Creates a ConnectionString from the given string.
|
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 in an immutable list.
|
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() |
public ConnectionString(String connectionString)
connectionString
- the connection stringpublic String getUsername()
public char[] getPassword()
public String getDatabase()
public String getCollection()
@Deprecated public String getURI()
getConnectionString()
public String getConnectionString()
public List<MongoCredential> getCredentialList()
public ReadPreference getReadPreference()
public ReadConcern getReadConcern()
public WriteConcern getWriteConcern()
public Integer getMinConnectionPoolSize()
public Integer getMaxConnectionPoolSize()
public Integer getThreadsAllowedToBlockForConnectionMultiplier()
public Integer getMaxWaitTime()
public Integer getMaxConnectionIdleTime()
public Integer getMaxConnectionLifeTime()
public Integer getConnectTimeout()
public Integer getSocketTimeout()
public Boolean getSslEnabled()
public String getStreamType()
public Boolean getSslInvalidHostnameAllowed()
public String getRequiredReplicaSetName()
public Integer getServerSelectionTimeout()
public Integer getLocalThreshold()
public Integer getHeartbeatFrequency()
public String getApplicationName()
Default is null.