Package com.mongodb

Class ClientEncryptionSettings.Builder

java.lang.Object

com.mongodb.ClientEncryptionSettings.Builder

Enclosing class:

ClientEncryptionSettings

@NotThreadSafe
public static final class ClientEncryptionSettings.Builder
extends Object

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

Method Summary

Modifier and Type	Method	Description
ClientEncryptionSettings	build()	Build an instance of ClientEncryptionSettings.
ClientEncryptionSettings.Builder	keyVaultMongoClientSettings(MongoClientSettings keyVaultMongoClientSettings)	Sets the MongoClientSettings that will be used to access the key vault.
ClientEncryptionSettings.Builder	keyVaultNamespace(String keyVaultNamespace)	Sets the key vault namespace
ClientEncryptionSettings.Builder	kmsProviderPropertySuppliers(Map<String,Supplier<Map<String,Object>>> kmsProviderPropertySuppliers)	This method is similar to kmsProviders(Map), but instead of setting properties for KMS providers, it sets Suppliers of properties.
ClientEncryptionSettings.Builder	kmsProviders(Map<String,Map<String,Object>> kmsProviders)	Sets the KMS providers map.
ClientEncryptionSettings.Builder	kmsProviderSslContextMap(Map<String,SSLContext> kmsProviderSslContextMap)	Sets the KMS provider to SSLContext map
ClientEncryptionSettings.Builder	timeout(long timeout, TimeUnit timeUnit)	Sets the time limit for the full execution of an operation.

Methods inherited from class java.lang.Object

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

Method Details

keyVaultMongoClientSettings

public ClientEncryptionSettings.Builder keyVaultMongoClientSettings(MongoClientSettings keyVaultMongoClientSettings)

Sets the MongoClientSettings that will be used to access the key vault.

Parameters:

keyVaultMongoClientSettings - the key vault mongo client settings, which may not be null.

Returns:

this

See Also:

• ClientEncryptionSettings.getKeyVaultMongoClientSettings()

keyVaultNamespace

public ClientEncryptionSettings.Builder keyVaultNamespace(String keyVaultNamespace)

Sets the key vault namespace

Parameters:

keyVaultNamespace - the key vault namespace, which may not be null

Returns:

this

See Also:

• ClientEncryptionSettings.getKeyVaultNamespace()

kmsProviders

public ClientEncryptionSettings.Builder kmsProviders(Map<String,Map<String,Object>> kmsProviders)

Sets the KMS providers map.

Parameters:

kmsProviders - the KMS providers map, which may not be null

Returns:

this

See Also:

• kmsProviderPropertySuppliers(Map)
• ClientEncryptionSettings.getKmsProviders()

kmsProviderPropertySuppliers

public ClientEncryptionSettings.Builder kmsProviderPropertySuppliers(Map<String,Supplier<Map<String,Object>>> kmsProviderPropertySuppliers)

This method is similar to kmsProviders(Map), but instead of setting properties for KMS providers, it sets Suppliers of properties.

Parameters:

kmsProviderPropertySuppliers - A Map where keys identify KMS providers, and values specify Suppliers of properties for the KMS providers. Must not be null. Each Supplier must return non-empty properties.

Returns:

this

Since:

4.6

See Also:

• ClientEncryptionSettings.getKmsProviderPropertySuppliers()

kmsProviderSslContextMap

public ClientEncryptionSettings.Builder kmsProviderSslContextMap(Map<String,SSLContext> kmsProviderSslContextMap)

Sets the KMS provider to SSLContext map

Parameters:

kmsProviderSslContextMap - the KMS provider to SSLContext map, which may not be null

Returns:

this

Since:

4.4

See Also:

• ClientEncryptionSettings.getKmsProviderSslContextMap()

timeout

@Alpha(CLIENT)
public ClientEncryptionSettings.Builder timeout(long timeout,
 TimeUnit timeUnit)

Sets the time limit for the full execution of an operation.

• null means that the timeout mechanism for operations will defer to using:
  • waitQueueTimeoutMS: The maximum wait time in milliseconds that a thread may wait for a connection to become available
  • socketTimeoutMS: How long a send or receive on a socket can take before timing out.
  • wTimeoutMS: How long the server will wait for the write concern to be fulfilled before timing out.
  • maxTimeMS: The cumulative time limit for processing operations on a cursor. See: cursor.maxTimeMS.
  • maxCommitTimeMS: The maximum amount of time to allow a single commitTransaction command to execute. See: TransactionOptions.getMaxCommitTime(java.util.concurrent.TimeUnit).
• 0 means infinite timeout.
• > 0 The time limit to use for the full execution of an operation.

Note: The timeout set through this method overrides the timeout defined in the key vault client settings specified in keyVaultMongoClientSettings(MongoClientSettings). Essentially, for operations that require accessing the key vault, the remaining timeout from the initial operation determines the duration allowed for key vault access.

Parameters:

timeout - the timeout

timeUnit - the time unit

Returns:

this

Since:

5.2

See Also:

• ClientEncryptionSettings.getTimeout(java.util.concurrent.TimeUnit)

build

public ClientEncryptionSettings build()

Build an instance of ClientEncryptionSettings.

Returns:

the settings from this builder