Package com.mongodb

Class AutoEncryptionSettings.Builder

java.lang.Object

com.mongodb.AutoEncryptionSettings.Builder

Enclosing class:

AutoEncryptionSettings

@NotThreadSafe
public static final class AutoEncryptionSettings.Builder
extends Object

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

Method Summary

Modifier and Type

Method

Description

AutoEncryptionSettings

build()

Build an instance of AutoEncryptionSettings.

AutoEncryptionSettings.Builder

bypassAutoEncryption(boolean bypassAutoEncryption)

Sets whether auto-encryption should be bypassed.

AutoEncryptionSettings.Builder

bypassQueryAnalysis(boolean bypassQueryAnalysis)

Enable or disable automatic analysis of outgoing commands.

AutoEncryptionSettings.Builder

encryptedFieldsMap(BsonDocument> encryptedFieldsMap)

Maps a collection namespace to an encryptedFields.

AutoEncryptionSettings.Builder

extraOptions(Object> extraOptions)

Sets the extra options.

AutoEncryptionSettings.Builder

keyVaultMongoClientSettings(MongoClientSettings keyVaultMongoClientSettings)

Sets the key vault settings.

AutoEncryptionSettings.Builder

keyVaultNamespace(String keyVaultNamespace)

Sets the key vault namespace

AutoEncryptionSettings.Builder

kmsProviderPropertySuppliers(Map<Object>>> kmsProviderPropertySuppliers)

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

AutoEncryptionSettings.Builder

kmsProviders(String,Object>> kmsProviders)

Sets the KMS providers map.

AutoEncryptionSettings.Builder

kmsProviderSslContextMap(SSLContext> kmsProviderSslContextMap)

Sets the KMS provider to SSLContext map

AutoEncryptionSettings.Builder

schemaMap(BsonDocument> schemaMap)

Sets the map from namespace to local schema document

Methods inherited from class java.lang.Object

getClass, toString, wait

Method Details

keyVaultMongoClientSettings

public AutoEncryptionSettings.Builder keyVaultMongoClientSettings(MongoClientSettings keyVaultMongoClientSettings)

Sets the key vault settings.

Parameters:

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

Returns:

this

See Also:

• AutoEncryptionSettings.getKeyVaultMongoClientSettings()

keyVaultNamespace

public AutoEncryptionSettings.Builder keyVaultNamespace(String keyVaultNamespace)

Sets the key vault namespace

Parameters:

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

Returns:

this

See Also:

• AutoEncryptionSettings.getKeyVaultNamespace()

kmsProviders

public AutoEncryptionSettings.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)
• AutoEncryptionSettings.getKmsProviders()

kmsProviderPropertySuppliers

public AutoEncryptionSettings.Builder kmsProviderPropertySuppliers(Map<Object>>> kmsProviderPropertySuppliers)

This method is similar to kmsProviders(Map), but instead of configuring properties for KMS providers, it configures 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:

• AutoEncryptionSettings.getKmsProviderPropertySuppliers()

kmsProviderSslContextMap

public AutoEncryptionSettings.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:

• AutoEncryptionSettings.getKmsProviderSslContextMap()

schemaMap

public AutoEncryptionSettings.Builder schemaMap(BsonDocument> schemaMap)

Sets the map from namespace to local schema document

Parameters:

schemaMap - the map from namespace to local schema document

Returns:

this

See Also:

• AutoEncryptionSettings.getSchemaMap()

extraOptions

public AutoEncryptionSettings.Builder extraOptions(Object> extraOptions)

Sets the extra options.

Note: When setting cryptSharedLibPath, the override path must be given as a path to the shared crypt library file itself, and not simply the directory that contains it.

Parameters:

extraOptions - the extra options, which may not be null

Returns:

this

See Also:

• AutoEncryptionSettings.getExtraOptions()

bypassAutoEncryption

public AutoEncryptionSettings.Builder bypassAutoEncryption(boolean bypassAutoEncryption)

Sets whether auto-encryption should be bypassed.

Parameters:

bypassAutoEncryption - whether auto-encryption should be bypassed

Returns:

this

See Also:

• AutoEncryptionSettings.isBypassAutoEncryption()

encryptedFieldsMap

public AutoEncryptionSettings.Builder encryptedFieldsMap(BsonDocument> encryptedFieldsMap)

Maps a collection namespace to an encryptedFields.

Note: only applies to queryable encryption. Automatic encryption in queryable encryption is configured with the encryptedFields.

If a collection is present in both the encryptedFieldsMap and schemaMap, the driver will error.

If a collection is present on the encryptedFieldsMap, the behavior of collection.createCollection() and collection.drop() is altered.

If a collection is not present on the encryptedFieldsMap a server-side collection encryptedFieldsMap may be used by the driver.

Parameters:

encryptedFieldsMap - the mapping of the collection namespace to the encryptedFields

Returns:

this

Since:

4.7

Since server release

7.0

bypassQueryAnalysis

public AutoEncryptionSettings.Builder bypassQueryAnalysis(boolean bypassQueryAnalysis)

Enable or disable automatic analysis of outgoing commands.

Set bypassQueryAnalysis to true to use explicit encryption on indexed fields without the MongoDB Enterprise Advanced licensed crypt shared library.

Parameters:

bypassQueryAnalysis - whether query analysis should be bypassed

Returns:

this

Since:

4.7

Since server release

7.0

build

public AutoEncryptionSettings build()

Build an instance of AutoEncryptionSettings.

Returns:

the settings from this builder