com.mongodb.async.client

Class MongoClientSettings.Builder

java.lang.Object

com.mongodb.async.client.MongoClientSettings.Builder

Enclosing class:

MongoClientSettings

@NotThreadSafe
public static final class MongoClientSettings.Builder
extends java.lang.Object

A builder for MongoClientSettings so that MongoClientSettings can be immutable, and to support easier construction through chaining.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	applicationName
private ClusterSettings	clusterSettings
private CodecRegistry	codecRegistry
private java.util.List<CommandListener>	commandListeners
private ConnectionPoolSettings	connectionPoolSettings
private java.util.List<MongoCredential>	credentialList
private SocketSettings	heartbeatSocketSettings
private ReadConcern	readConcern
private ReadPreference	readPreference
private ServerSettings	serverSettings
private SocketSettings	socketSettings
private SslSettings	sslSettings
private StreamFactoryFactory	streamFactoryFactory
private WriteConcern	writeConcern

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Builder()
private	Builder(MongoClientSettings settings) Creates a Builder from an existing MongoClientSettings.

Method Summary

Modifier and Type	Method and Description
MongoClientSettings.Builder	addCommandListener(CommandListener commandListener) Adds the given command listener.
MongoClientSettings.Builder	applicationName(java.lang.String applicationName) Sets the logical name of the application using this MongoClient.
MongoClientSettings	build() Build an instance of MongoClientSettings.
MongoClientSettings.Builder	clusterSettings(ClusterSettings clusterSettings) Sets the cluster settings.
MongoClientSettings.Builder	codecRegistry(CodecRegistry codecRegistry) Sets the codec registry
MongoClientSettings.Builder	connectionPoolSettings(ConnectionPoolSettings connectionPoolSettings) Sets the connection pool settings.
MongoClientSettings.Builder	credentialList(java.util.List<MongoCredential> credentialList) Sets the credential list.
MongoClientSettings.Builder	heartbeatSocketSettings(SocketSettings heartbeatSocketSettings) Sets the heartbeat socket settings.
MongoClientSettings.Builder	readConcern(ReadConcern readConcern) Sets the read concern.
MongoClientSettings.Builder	readPreference(ReadPreference readPreference) Sets the read preference.
MongoClientSettings.Builder	serverSettings(ServerSettings serverSettings) Sets the server settings.
MongoClientSettings.Builder	socketSettings(SocketSettings socketSettings) Sets the socket settings.
MongoClientSettings.Builder	sslSettings(SslSettings sslSettings) Sets the socket settings.
MongoClientSettings.Builder	streamFactoryFactory(StreamFactoryFactory streamFactoryFactory) Sets the factory to use to create a StreamFactory.
MongoClientSettings.Builder	writeConcern(WriteConcern writeConcern) Sets the write concern.

Methods inherited from class java.lang.Object

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

Field Detail

readPreference

private ReadPreference readPreference

writeConcern

private WriteConcern writeConcern

readConcern

private ReadConcern readConcern

codecRegistry

private CodecRegistry codecRegistry

streamFactoryFactory

private StreamFactoryFactory streamFactoryFactory

commandListeners

private final java.util.List<CommandListener> commandListeners

clusterSettings

private ClusterSettings clusterSettings

socketSettings

private SocketSettings socketSettings

heartbeatSocketSettings

private SocketSettings heartbeatSocketSettings

connectionPoolSettings

private ConnectionPoolSettings connectionPoolSettings

serverSettings

private ServerSettings serverSettings

sslSettings

private SslSettings sslSettings

credentialList

private java.util.List<MongoCredential> credentialList

applicationName

private java.lang.String applicationName

Constructor Detail

Builder

private Builder()

Builder

private Builder(MongoClientSettings settings)

Creates a Builder from an existing MongoClientSettings.

Parameters:

settings - create a builder from existing settings

Method Detail

clusterSettings

public MongoClientSettings.Builder clusterSettings(ClusterSettings clusterSettings)

Sets the cluster settings.

Parameters:

clusterSettings - the cluster settings

Returns:

this

See Also:

MongoClientSettings.getClusterSettings()

socketSettings

public MongoClientSettings.Builder socketSettings(SocketSettings socketSettings)

Sets the socket settings.

Parameters:

socketSettings - the socket settings

Returns:

this

See Also:

MongoClientSettings.getSocketSettings()

heartbeatSocketSettings

public MongoClientSettings.Builder heartbeatSocketSettings(SocketSettings heartbeatSocketSettings)

Sets the heartbeat socket settings.

Parameters:

heartbeatSocketSettings - the socket settings

Returns:

this

See Also:

MongoClientSettings.getHeartbeatSocketSettings()

connectionPoolSettings

public MongoClientSettings.Builder connectionPoolSettings(ConnectionPoolSettings connectionPoolSettings)

Sets the connection pool settings.

Parameters:

connectionPoolSettings - the connection settings

Returns:

this

See Also:

()

serverSettings

public MongoClientSettings.Builder serverSettings(ServerSettings serverSettings)

Sets the server settings.

Parameters:

serverSettings - the server settings

Returns:

this

See Also:

()

sslSettings

public MongoClientSettings.Builder sslSettings(SslSettings sslSettings)

Sets the socket settings.

Parameters:

sslSettings - the SSL settings

Returns:

this

See Also:

()

readPreference

public MongoClientSettings.Builder readPreference(ReadPreference readPreference)

Sets the read preference.

Parameters:

readPreference - read preference

Returns:

this

See Also:

MongoClientSettings.getReadPreference()

writeConcern

public MongoClientSettings.Builder writeConcern(WriteConcern writeConcern)

Sets the write concern.

Parameters:

writeConcern - the write concern

Returns:

this

See Also:

MongoClientSettings.getWriteConcern()

readConcern

public MongoClientSettings.Builder readConcern(ReadConcern readConcern)

Sets the read concern.

Parameters:

readConcern - the read concern

Returns:

this

Since:

3.2

credentialList

public MongoClientSettings.Builder credentialList(java.util.List<MongoCredential> credentialList)

Sets the credential list.

Parameters:

credentialList - the credential list

Returns:

this

See Also:

MongoClientSettings.getCredentialList()

codecRegistry

public MongoClientSettings.Builder codecRegistry(CodecRegistry codecRegistry)

Sets the codec registry

Parameters:

codecRegistry - the codec registry

Returns:

this

Since:

3.0

See Also:

MongoClientSettings.getCodecRegistry()

streamFactoryFactory

public MongoClientSettings.Builder streamFactoryFactory(StreamFactoryFactory streamFactoryFactory)

Sets the factory to use to create a StreamFactory.

Parameters:

streamFactoryFactory - the stream factory factory

Returns:

this

Since:

3.1

addCommandListener

public MongoClientSettings.Builder addCommandListener(CommandListener commandListener)

Adds the given command listener.

Parameters:

commandListener - the command listener

Returns:

this

Since:

3.3

applicationName

public MongoClientSettings.Builder applicationName(java.lang.String applicationName)

Sets 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.

Parameters:

applicationName - the logical name of the application using this MongoClient. It may be null. The UTF-8 encoding may not exceed 128 bytes.

Returns:

this

Since:

3.4

See Also:

MongoClientSettings.getApplicationName()

build

public MongoClientSettings build()

Build an instance of MongoClientSettings.

Returns:

the settings from this builder