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<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(String,Object>> kmsProviders)

Sets the KMS providers map.

ClientEncryptionSettings.Builder

kmsProviderSslContextMap(SSLContext> kmsProviderSslContextMap)

Sets the KMS provider to SSLContext map

Methods inherited from class java.lang.Object

getClass, toString, 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(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<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(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()

build

public ClientEncryptionSettings build()

Build an instance of ClientEncryptionSettings.

Returns:

the settings from this builder