MongoClientURI (mongo-java-driver 3.3.0-query-log-max-size API)

java.lang.Object
- com.mongodb.MongoClientURI

```
public class MongoClientURI
extends java.lang.Object
```
Represents a URI which can be used to create a MongoClient instance. 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):

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:
- 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.
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:
- slaveOk=true|false: Whether a driver connected to a replica set will send reads to slaves/secondaries.
- readPreference=enum: The read preference for this connection. If set, it overrides any slaveOk value.
  - 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).
- gssapiServiceName=string: This option only applies to the GSSAPI mechanism and is used to alter the service name..
Note: This class is a replacement for MongoURI, to be used with MongoClient. The main difference in behavior is that the default write concern is WriteConcern.ACKNOWLEDGED.
从以下版本开始:

2.10.0

另请参阅:

for the default values for all options

MongoDB documentation

Connection String URI Format

构造器概要

构造器
构造器和说明
`MongoClientURI(java.lang.String uri)` Creates a MongoURI from the given string.
`MongoClientURI(java.lang.String uri, MongoClientOptions.Builder builder)` Creates a MongoURI from the given URI string, and MongoClientOptions.Builder.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getCollection()` Gets the collection name
`MongoCredential`	`getCredentials()` Gets the credentials.
`java.lang.String`	`getDatabase()` Gets the database name
`java.util.List<java.lang.String>`	`getHosts()` Gets the list of hosts
`MongoClientOptions`	`getOptions()` Gets the options
`char[]`	`getPassword()` Gets the password
`java.lang.String`	`getURI()` Get the unparsed URI.
`java.lang.String`	`getUsername()` Gets the username
`int`	`hashCode()`
`java.lang.String`	`toString()`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - MongoClientURI
```
public MongoClientURI(java.lang.String uri)
```
    Creates a MongoURI from the given string.
    
    参数:
    
    uri - the URI
  - MongoClientURI
```
public MongoClientURI(java.lang.String uri,
                      MongoClientOptions.Builder builder)
```
    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.
    The MongoClientURI takes ownership of the MongoClientOptions.Builder instance that is passed to this constructor, and may modify it.
    
    参数:
    
    uri - the URI
    
    builder - a non-null Builder, which may be modified within this constructor,
    
    从以下版本开始:
    
    2.11.0
- 方法详细资料
  - getUsername
```
public java.lang.String getUsername()
```
    Gets the username
    
    返回:
    
    the username
  - getPassword
```
public char[] getPassword()
```
    Gets the password
    
    返回:
    
    the password
  - getHosts
```
public java.util.List<java.lang.String> getHosts()
```
    Gets the list of hosts
    
    返回:
    
    the host list
  - getDatabase
```
public java.lang.String getDatabase()
```
    Gets the database name
    
    返回:
    
    the database name
  - getCollection
```
public java.lang.String getCollection()
```
    Gets the collection name
    
    返回:
    
    the collection name
  - getURI
```
public java.lang.String getURI()
```
    Get the unparsed URI.
    
    返回:
    
    the URI
  - getCredentials
```
public MongoCredential getCredentials()
```
    Gets the credentials.
    
    返回:
    
    the credentials
  - getOptions
```
public MongoClientOptions getOptions()
```
    Gets the options
    
    返回:
    
    the MongoClientOptions based on this URI.
  - equals
```
public boolean equals(java.lang.Object o)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object

类 MongoClientURI

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

MongoClientURI

MongoClientURI

方法详细资料

getUsername

getPassword

getHosts

getDatabase

getCollection

getURI

getCredentials

getOptions

equals

hashCode

toString