Package com.mongodb.embedded.client

Class MongoClientSettings

java.lang.Object

com.mongodb.embedded.client.MongoClientSettings

@Immutable
public final class MongoClientSettings
extends Object

Various settings to control the behavior of an Embedded MongoClient.

Since:

3.8

Since server release

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MongoClientSettings.Builder	A builder for MongoClientSettings so that MongoClientSettings can be immutable, and to support easier construction through chaining.

Method Summary

Modifier and Type	Method	Description
static MongoClientSettings.Builder	builder()	Convenience method to create a Builder.
static MongoClientSettings.Builder	builder(MongoClientSettings settings)	Convenience method to create a from an existing MongoClientSettings.
String	getApplicationName()	Gets the logical name of the application using this MongoClient.
CodecRegistry	getCodecRegistry()	The codec registry to use, or null if not set.
List<CommandListener>	getCommandListeners()	Gets the list of added CommandListener.
String	getDbPath()	Gets the dbPath for the embedded mongod.
static CodecRegistry	getDefaultCodecRegistry()	Gets the default codec registry.
MongoClientSettings	getWrappedMongoClientSettings()	Returns the wrapped MongoClientSettings instance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDefaultCodecRegistry

public static CodecRegistry getDefaultCodecRegistry()

Gets the default codec registry. It includes the following providers:

• ValueCodecProvider
• BsonValueCodecProvider
• DBRefCodecProvider
• DBObjectCodecProvider
• DocumentCodecProvider
• IterableCodecProvider
• MapCodecProvider
• GeoJsonCodecProvider
• GridFSFileCodecProvider

Returns:

the default codec registry

builder

public static MongoClientSettings.Builder builder()

Convenience method to create a Builder.

Returns:

a builder

builder

public static MongoClientSettings.Builder builder(MongoClientSettings settings)

Convenience method to create a from an existing MongoClientSettings.

Parameters:

settings - create a builder from existing settings

Returns:

a builder

getApplicationName

public String getApplicationName()

Gets the logical name of the application using this MongoClient. 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.

Default is null.

Returns:

the application name, which may be null

getCodecRegistry

public CodecRegistry getCodecRegistry()

The codec registry to use, or null if not set.

Returns:

the codec registry

getCommandListeners

public List<CommandListener> getCommandListeners()

Gets the list of added CommandListener.

The default is an empty list.

Returns:

the unmodifiable list of command listeners

getDbPath

public String getDbPath()

Gets the dbPath for the embedded mongod.

Returns:

the dbPath

getWrappedMongoClientSettings

public MongoClientSettings getWrappedMongoClientSettings()

Returns the wrapped MongoClientSettings instance

Returns:

the wrapped MongoClient Settings instance.