The client-side settings for data key creation and explicit encryption.
Explicit encryption/decryption is a community feature, enabled with the new
com.mongodb.client.vault.ClientEncryptiontype, for which this is the settings.
Note: support for client side encryption is in beta. Backwards-breaking changes may be made before the final release.
Nested Class Summary
Nested Classes Modifier and Type Class Description
ClientEncryptionSettings.BuilderA builder for
ClientEncryptionSettingscan be immutable, and to support easier construction through chaining.
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description
builder()Convenience method to create a Builder.
getKeyVaultMongoClientSettings()Gets the key vault settings.
getKeyVaultNamespace()Gets the key vault namespace.
getKmsProviders()Gets the map of KMS provider properties.
public static ClientEncryptionSettings.Builder builder()Convenience method to create a Builder.
- a builder
public MongoClientSettings getKeyVaultMongoClientSettings()Gets the key vault settings.
The key vault collection is assumed to reside on the same MongoDB cluster as indicated by the connecting URI. But the optional keyVaultMongoClientSettings can be used to route data key queries to a separate MongoDB cluster, or the same cluster but with a different credential.
- the key vault settings, which may be null to indicate that the same
MongoClientshould be used to access the key vault collection as is used for the rest of the application.
public String getKeyVaultNamespace()Gets the key vault namespace.
The key vault namespace refers to a collection that contains all data keys used for encryption and decryption (aka the key vault collection). Data keys are stored as documents in a special MongoDB collection. Data keys are protected with encryption by a KMS provider (AWS KMS or a local master key).
- the key vault namespace, which may not be null
getKmsProvidersGets the map of KMS provider properties.
Multiple KMS providers may be specified. Initially, two KMS providers are supported: "aws" and "local". The kmsProviders map values differ by provider:
For "aws", the properties are:
- accessKeyId: a String containing the AWS access key identifier
- secretAccessKey: a String the AWS secret access key
For "local", the properties are:
- key: <byte array of length 96>
- map of KMS provider properties