com.mongodb.async.client.MongoClients Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mongodb-driver-async Show documentation
Show all versions of mongodb-driver-async Show documentation
The MongoDB Asynchronous Driver
/*
* Copyright 2008-present 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.async.client;
import com.mongodb.ConnectionString;
import com.mongodb.MongoClientException;
import com.mongodb.MongoDriverInformation;
import com.mongodb.MongoInternalException;
import com.mongodb.connection.AsynchronousSocketChannelStreamFactoryFactory;
import com.mongodb.connection.Cluster;
import com.mongodb.connection.DefaultClusterFactory;
import com.mongodb.connection.StreamFactory;
import com.mongodb.connection.StreamFactoryFactory;
import com.mongodb.connection.TlsChannelStreamFactoryFactory;
import com.mongodb.lang.Nullable;
import org.bson.codecs.configuration.CodecRegistry;
import java.io.Closeable;
import static com.mongodb.assertions.Assertions.notNull;
import static com.mongodb.internal.event.EventListenerHelper.getCommandListener;
/**
* A factory for MongoClient instances.
*
* @since 3.0
* @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
*/
@Deprecated
public final class MongoClients {
/**
* Creates a new client with the default connection string "mongodb://localhost".
*
* @return the client
*/
public static MongoClient create() {
return create(new ConnectionString("mongodb://localhost"));
}
/**
* Create a new client with the given client settings.
*
* @param settings the settings
* @return the client
* @deprecated use {@link #create(com.mongodb.MongoClientSettings)} instead
*/
@Deprecated
public static MongoClient create(final MongoClientSettings settings) {
return create(settings, null);
}
/**
* Create a new client with the given connection string as if by a call to {@link #create(ConnectionString)}.
*
* @param connectionString the connection
* @return the client
* @see #create(ConnectionString)
*/
public static MongoClient create(final String connectionString) {
return create(new ConnectionString(connectionString));
}
/**
* Create a new client with the given connection string.
*
* For each of the settings classed configurable via {@link com.mongodb.MongoClientSettings}, the connection string is applied by
* calling the {@code applyConnectionString} method on an instance of setting's builder class, building the setting, and adding it to
* an instance of {@link com.mongodb.MongoClientSettings.Builder}.
*
*
* The connection string's stream type is then applied by setting the
* {@link com.mongodb.connection.StreamFactory} to an instance of NettyStreamFactory,
*
*
* @param connectionString the settings
* @return the client
* @throws IllegalArgumentException if the connection string's stream type is not one of "netty" or "nio2"
*
* @see ConnectionString#getStreamType()
* @see com.mongodb.MongoClientSettings.Builder
* @see com.mongodb.connection.ClusterSettings.Builder#applyConnectionString(ConnectionString)
* @see com.mongodb.connection.ConnectionPoolSettings.Builder#applyConnectionString(ConnectionString)
* @see com.mongodb.connection.ServerSettings.Builder#applyConnectionString(ConnectionString)
* @see com.mongodb.connection.SslSettings.Builder#applyConnectionString(ConnectionString)
* @see com.mongodb.connection.SocketSettings.Builder#applyConnectionString(ConnectionString)
*/
public static MongoClient create(final ConnectionString connectionString) {
return create(connectionString, null);
}
/**
* Creates a new client with the given client settings.
*
* Note: Intended for driver and library authors to associate extra driver metadata with the connections.
*
* @param settings the settings
* @param mongoDriverInformation any driver information to associate with the MongoClient
* @return the client
* @since 3.4
* @deprecated use {@link #create(com.mongodb.MongoClientSettings, MongoDriverInformation)} instead
*/
@Deprecated
public static MongoClient create(final MongoClientSettings settings, @Nullable final MongoDriverInformation mongoDriverInformation) {
return create(settings, mongoDriverInformation, null);
}
/**
* Create a new client with the given connection string.
*
* Note: Intended for driver and library authors to associate extra driver metadata with the connections.
*
* @param connectionString the settings
* @param mongoDriverInformation any driver information to associate with the MongoClient
* @return the client
* @throws IllegalArgumentException if the connection string's stream type is not one of "netty" or "nio2"
* @see MongoClients#create(ConnectionString)
*/
public static MongoClient create(final ConnectionString connectionString,
@Nullable final MongoDriverInformation mongoDriverInformation) {
return create(MongoClientSettings.builder().applyConnectionString(connectionString).build(),
mongoDriverInformation, connectionString.getStreamType());
}
/**
* Create a new client with the given client settings.
*
* @param settings the settings
* @return the client
* @since 3.7
*/
public static MongoClient create(final com.mongodb.MongoClientSettings settings) {
return create(settings, null);
}
/**
* Creates a new client with the given client settings.
*
* Note: Intended for driver and library authors to associate extra driver metadata with the connections.
*
* @param settings the settings
* @param mongoDriverInformation any driver information to associate with the MongoClient
* @return the client
* @since 3.7
*/
public static MongoClient create(final com.mongodb.MongoClientSettings settings,
@Nullable final MongoDriverInformation mongoDriverInformation) {
return create(MongoClientSettings.createFromClientSettings(settings), mongoDriverInformation, null);
}
private static MongoClient create(final MongoClientSettings settings,
@Nullable final MongoDriverInformation mongoDriverInformation,
@Nullable final String requestedStreamType) {
String streamType = getStreamType(requestedStreamType);
if (settings.getStreamFactoryFactory() == null) {
if (isNetty(streamType)) {
return NettyMongoClients.create(settings, mongoDriverInformation);
} else if (isNio(streamType)) {
if (settings.getSslSettings().isEnabled()) {
return createWithTlsChannel(settings, mongoDriverInformation);
} else {
return createWithAsynchronousSocketChannel(settings, mongoDriverInformation);
}
} else {
throw new IllegalArgumentException("Unsupported stream type: " + streamType);
}
} else {
return createMongoClient(settings, mongoDriverInformation, getStreamFactory(settings, false),
getStreamFactory(settings, true), null);
}
}
static MongoClient createMongoClient(final MongoClientSettings settings, @Nullable final MongoDriverInformation mongoDriverInformation,
final StreamFactory streamFactory, final StreamFactory heartbeatStreamFactory,
@Nullable final Closeable externalResourceCloser) {
return new MongoClientImpl(settings, createCluster(settings, mongoDriverInformation, streamFactory, heartbeatStreamFactory),
externalResourceCloser);
}
private static Cluster createCluster(final MongoClientSettings settings, @Nullable final MongoDriverInformation mongoDriverInformation,
final StreamFactory streamFactory, final StreamFactory heartbeatStreamFactory) {
notNull("settings", settings);
MongoDriverInformation.Builder builder = mongoDriverInformation == null ? MongoDriverInformation.builder()
: MongoDriverInformation.builder(mongoDriverInformation);
return new DefaultClusterFactory().createCluster(settings.getClusterSettings(), settings.getServerSettings(),
settings.getConnectionPoolSettings(), streamFactory, heartbeatStreamFactory, settings.getCredentialList(),
getCommandListener(settings.getCommandListeners()), settings.getApplicationName(), builder.driverName("async").build(),
settings.getCompressorList());
}
/**
* Gets the default codec registry. It includes the following providers:
*
*
* - {@link org.bson.codecs.ValueCodecProvider}
* - {@link org.bson.codecs.BsonValueCodecProvider}
* - {@link com.mongodb.DBRefCodecProvider}
* - {@link com.mongodb.DBObjectCodecProvider}
* - {@link org.bson.codecs.DocumentCodecProvider}
* - {@link org.bson.codecs.IterableCodecProvider}
* - {@link org.bson.codecs.MapCodecProvider}
* - {@link com.mongodb.client.model.geojson.codecs.GeoJsonCodecProvider}
* - {@link com.mongodb.client.gridfs.codecs.GridFSFileCodecProvider}
* - {@link org.bson.codecs.jsr310.Jsr310CodecProvider}
* - {@link org.bson.codecs.BsonCodecProvider}
*
*
* @return the default codec registry
* @see com.mongodb.MongoClientSettings#getCodecRegistry()
* @since 3.1
*/
public static CodecRegistry getDefaultCodecRegistry() {
return com.mongodb.MongoClientSettings.getDefaultCodecRegistry();
}
private static MongoClient createWithTlsChannel(final MongoClientSettings settings,
@Nullable final MongoDriverInformation mongoDriverInformation) {
if (!isJava8()) {
throw new MongoClientException("TLS is only supported natively with Java 8 and above. Please use Netty instead");
}
final TlsChannelStreamFactoryFactory streamFactoryFactory = new TlsChannelStreamFactoryFactory();
StreamFactory streamFactory = streamFactoryFactory.create(settings.getSocketSettings(), settings.getSslSettings());
StreamFactory heartbeatStreamFactory = streamFactoryFactory.create(settings.getHeartbeatSocketSettings(),
settings.getSslSettings());
return createMongoClient(settings, mongoDriverInformation, streamFactory, heartbeatStreamFactory,
new Closeable() {
@Override
public void close() {
streamFactoryFactory.close();
}
});
}
private static boolean isJava8() {
try {
Class.forName("java.time.Instant");
return true;
} catch (ClassNotFoundException e) {
return false;
}
}
private static MongoClient createWithAsynchronousSocketChannel(final MongoClientSettings settings,
@Nullable final MongoDriverInformation mongoDriverInformation) {
StreamFactoryFactory streamFactoryFactory = new AsynchronousSocketChannelStreamFactoryFactory();
StreamFactory streamFactory = streamFactoryFactory.create(settings.getSocketSettings(), settings.getSslSettings());
StreamFactory heartbeatStreamFactory = streamFactoryFactory.create(settings.getHeartbeatSocketSettings(),
settings.getSslSettings());
return createMongoClient(settings, mongoDriverInformation, streamFactory, heartbeatStreamFactory, null);
}
private static StreamFactory getStreamFactory(final MongoClientSettings settings, final boolean isHeartbeat) {
StreamFactoryFactory streamFactoryFactory = settings.getStreamFactoryFactory();
if (streamFactoryFactory == null) {
throw new MongoInternalException("should not happen");
}
return streamFactoryFactory.create(isHeartbeat ? settings.getHeartbeatSocketSettings() : settings.getSocketSettings(),
settings.getSslSettings());
}
private static boolean isNetty(final String streamType) {
return streamType.toLowerCase().equals("netty");
}
private static boolean isNio(final String streamType) {
return streamType.toLowerCase().equals("nio2");
}
private static String getStreamType(@Nullable final String requestedStreamType) {
if (requestedStreamType != null) {
return requestedStreamType;
} else {
return System.getProperty("org.mongodb.async.type", "nio2");
}
}
private MongoClients() {
}
}