com.mongodb.MongoClient Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2014 MongoDB, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.mongodb;
import java.net.UnknownHostException;
import java.util.List;
/**
* A MongoDB client with internal connection pooling. For most applications, you should have one MongoClient instance
* for the entire JVM.
*
* The following are equivalent, and all connect to the local database running on the default port:
*
* MongoClient mongoClient1 = new MongoClient();
* MongoClient mongoClient1 = new MongoClient("localhost");
* MongoClient mongoClient2 = new MongoClient("localhost", 27017);
* MongoClient mongoClient4 = new MongoClient(new ServerAddress("localhost"));
* MongoClient mongoClient5 = new MongoClient(new ServerAddress("localhost"), new MongoClientOptions.Builder().build());
*
*
* You can connect to a
* replica set using the Java driver by passing
* a ServerAddress list to the MongoClient constructor. For example:
*
* MongoClient mongoClient = new MongoClient(Arrays.asList(
* new ServerAddress("localhost", 27017),
* new ServerAddress("localhost", 27018),
* new ServerAddress("localhost", 27019)));
*
* You can connect to a sharded cluster using the same constructor. MongoClient will auto-detect whether the servers are
* a list of replica set members or a list of mongos servers.
*
* By default, all read and write operations will be made on the primary, but it's possible to read from secondaries
* by changing the read preference:
*
* mongoClient.setReadPreference(ReadPreference.secondaryPreferred());
*
* By default, all write operations will wait for acknowledgment by the server, as the default write concern is
* {@code WriteConcern.ACKNOWLEDGED}.
*
* Note: This class supersedes the {@code Mongo} class. While it extends {@code Mongo}, it differs from it in that
* the default write concern is to wait for acknowledgment from the server of all write operations. In addition, its
* constructors accept instances of {@code MongoClientOptions} and {@code MongoClientURI}, which both also
* set the same default write concern.
*
* In general, users of this class will pick up all of the default options specified in {@code MongoClientOptions}. In
* particular, note that the default value of the connectionsPerHost option has been increased to 100 from the old
* default value of 10 used by the superseded {@code Mongo} class.
*
* @see ReadPreference#primary()
* @see com.mongodb.WriteConcern#ACKNOWLEDGED
* @see MongoClientOptions
* @see MongoClientURI
* @since 2.10.0
*/
public class MongoClient extends Mongo {
private final MongoClientOptions options;
/**
* Creates an instance based on a (single) mongodb node (localhost, default port).
*
* @throws UnknownHostException
* @throws MongoException
*/
public MongoClient() throws UnknownHostException {
this(new ServerAddress());
}
/**
* Creates a Mongo instance based on a (single) mongodb node.
*
* @param host server to connect to in format host[:port]
* @throws UnknownHostException if the database host cannot be resolved
* @throws MongoException
*/
public MongoClient(String host) throws UnknownHostException {
this(new ServerAddress(host));
}
/**
* Creates a Mongo instance based on a (single) mongodb node (default port).
*
* @param host server to connect to in format host[:port]
* @param options default query options
* @throws UnknownHostException if the database host cannot be resolved
* @throws MongoException
*/
public MongoClient(String host, MongoClientOptions options) throws UnknownHostException {
this(new ServerAddress(host), options);
}
/**
* Creates a Mongo instance based on a (single) mongodb node.
*
* @param host the database's host address
* @param port the port on which the database is running
* @throws UnknownHostException if the database host cannot be resolved
* @throws MongoException
*/
public MongoClient(String host, int port) throws UnknownHostException {
this(new ServerAddress(host, port));
}
/**
* Creates a Mongo instance based on a (single) mongodb node
*
* @param addr the database address
* @throws MongoException
* @see com.mongodb.ServerAddress
*/
public MongoClient(ServerAddress addr) {
this(addr, new MongoClientOptions.Builder().build());
}
/**
* Creates a Mongo instance based on a (single) mongodb node and a list of credentials
*
* @param addr the database address
* @param credentialsList the list of credentials used to authenticate all connections
* @throws MongoException
* @see com.mongodb.ServerAddress
* @since 2.11.0
*/
public MongoClient(ServerAddress addr, List credentialsList) {
this(addr, credentialsList, new MongoClientOptions.Builder().build());
}
/**
* Creates a Mongo instance based on a (single) mongo node using a given ServerAddress and default options.
*
* @param addr the database address
* @param options default options
* @throws MongoException
* @see com.mongodb.ServerAddress
*/
public MongoClient(ServerAddress addr, MongoClientOptions options) {
this(addr, null, options);
}
/**
* Creates a Mongo instance based on a (single) mongo node using a given ServerAddress and default options.
*
* @param addr the database address
* @param credentialsList the list of credentials used to authenticate all connections
* @param options default options
* @throws MongoException
* @see com.mongodb.ServerAddress
* @since 2.11.0
*/
@SuppressWarnings("deprecation")
public MongoClient(ServerAddress addr, List credentialsList, MongoClientOptions options) {
super(MongoAuthority.direct(addr, new MongoCredentialsStore(credentialsList)), new MongoOptions(options));
this.options = options;
}
/**
* Creates a Mongo based on a list of replica set members or a list of mongos.
* It will find all members (the master will be used by default). If you pass in a single server in the list,
* the driver will still function as if it is a replica set. If you have a standalone server,
* use the Mongo(ServerAddress) constructor.
*
* If this is a list of mongos servers, it will pick the closest (lowest ping time) one to send all requests to,
* and automatically fail over to the next server if the closest is down.
*
* @param seeds Put as many servers as you can in the list and the system will figure out the rest. This can
* either be a list of mongod servers in the same replica set or a list of mongos servers in the same
* sharded cluster.
* @throws MongoException
* @see com.mongodb.ServerAddress
*/
public MongoClient(List seeds) {
this(seeds, null, new MongoClientOptions.Builder().build());
}
/**
* Creates a Mongo based on a list of replica set members or a list of mongos.
* It will find all members (the master will be used by default). If you pass in a single server in the list,
* the driver will still function as if it is a replica set. If you have a standalone server,
* use the Mongo(ServerAddress) constructor.
*
* If this is a list of mongos servers, it will pick the closest (lowest ping time) one to send all requests to,
* and automatically fail over to the next server if the closest is down.
*
* @param seeds Put as many servers as you can in the list and the system will figure out the rest. This can
* either be a list of mongod servers in the same replica set or a list of mongos servers in the same
* sharded cluster. \
* @param credentialsList the list of credentials used to authenticate all connections
* @throws MongoException
* @see com.mongodb.ServerAddress
* @since 2.11.0
*/
public MongoClient(List seeds, List credentialsList) {
this(seeds, credentialsList, new MongoClientOptions.Builder().build());
}
/**
* Creates a Mongo based on a list of replica set members or a list of mongos.
* It will find all members (the master will be used by default). If you pass in a single server in the list,
* the driver will still function as if it is a replica set. If you have a standalone server,
* use the Mongo(ServerAddress) constructor.
*
* If this is a list of mongos servers, it will pick the closest (lowest ping time) one to send all requests to,
* and automatically fail over to the next server if the closest is down.
*
* @param seeds Put as many servers as you can in the list and the system will figure out the rest. This can
* either be a list of mongod servers in the same replica set or a list of mongos servers in the same
* sharded cluster.
* @param options default options
* @throws MongoException
* @see com.mongodb.ServerAddress
*/
public MongoClient(List seeds, MongoClientOptions options) {
this(seeds, null, options);
}
/**
* Creates a Mongo based on a list of replica set members or a list of mongos.
* It will find all members (the master will be used by default). If you pass in a single server in the list,
* the driver will still function as if it is a replica set. If you have a standalone server,
* use the Mongo(ServerAddress) constructor.
*
* If this is a list of mongos servers, it will pick the closest (lowest ping time) one to send all requests to,
* and automatically fail over to the next server if the closest is down.
*
* @param seeds Put as many servers as you can in the list and the system will figure out the rest. This can
* either be a list of mongod servers in the same replica set or a list of mongos servers in the same
* sharded cluster.
* @param credentialsList the list of credentials used to authenticate all connections
* @param options default options
* @throws MongoException
* @see com.mongodb.ServerAddress
* @since 2.11.0
*/
@SuppressWarnings("deprecation")
public MongoClient(List seeds, List credentialsList, MongoClientOptions options) {
super(MongoAuthority.dynamicSet(seeds, new MongoCredentialsStore(credentialsList)), new MongoOptions(options));
this.options = options;
}
/**
* Creates a Mongo described by a URI.
* If only one address is used it will only connect to that node, otherwise it will discover all nodes.
* @param uri the URI
* @throws MongoException
* @throws UnknownHostException
* @see MongoURI
* @dochub connections
*/
@SuppressWarnings("deprecation")
public MongoClient(MongoClientURI uri) throws UnknownHostException {
super(new MongoURI(uri));
this.options = uri.getOptions();
}
/**
* Gets the list of credentials that this client authenticates all connections with
*
* @return the list of credentials
* @since 2.11.0
*/
public List getCredentialsList() {
return getAuthority().getCredentialsStore().asList();
}
public MongoClientOptions getMongoClientOptions() {
return options;
}
}