Package com.mongodb.crypt.capi

Class MongoCryptOptions

java.lang.Object

com.mongodb.crypt.capi.MongoCryptOptions

public class MongoCryptOptions
extends java.lang.Object

The options for configuring MongoCrypt.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MongoCryptOptions.Builder	The builder for the options

Method Summary

Modifier and Type	Method	Description
static MongoCryptOptions.Builder	builder()	Construct a builder for the options
MongoAwsKmsProviderOptions	getAwsKmsProviderOptions()	Gets the AWS KMS provider options.
java.util.Map<java.lang.String,org.bson.BsonDocument>	getEncryptedFieldsMap()	Gets the encrypted fields map.
org.bson.BsonDocument	getExtraOptions()	The extraOptions that relate to the mongocryptd process or shared library.
org.bson.BsonDocument	getKmsProviderOptions()	Returns the KMS provider options.
MongoLocalKmsProviderOptions	getLocalKmsProviderOptions()	Gets the local KMS provider options.
java.util.Map<java.lang.String,org.bson.BsonDocument>	getLocalSchemaMap()	Gets the local schema map.
java.util.List<java.lang.String>	getSearchPaths()	Gets the search paths
boolean	isBypassQueryAnalysis()	Gets whether automatic analysis of outgoing commands should be disabled.
boolean	isNeedsKmsCredentialsStateEnabled()	Gets whether the MONGOCRYPT_CTX_NEED_KMS_CREDENTIALS is enabled.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static MongoCryptOptions.Builder builder()

Construct a builder for the options

Returns:

the builder

getAwsKmsProviderOptions

public MongoAwsKmsProviderOptions getAwsKmsProviderOptions()

Gets the AWS KMS provider options.

Returns:

the AWS KMS provider options, which may be null

getLocalKmsProviderOptions

public MongoLocalKmsProviderOptions getLocalKmsProviderOptions()

Gets the local KMS provider options.

Returns:

the local KMS provider options, which may be null

getKmsProviderOptions

public org.bson.BsonDocument getKmsProviderOptions()

Returns the KMS provider options.

Returns:

the KMS provider options, which may be null

Since:

1.1

getLocalSchemaMap

public java.util.Map<java.lang.String,org.bson.BsonDocument> getLocalSchemaMap()

Gets the local schema map.

Returns:

the local schema map

isNeedsKmsCredentialsStateEnabled

public boolean isNeedsKmsCredentialsStateEnabled()

Gets whether the MONGOCRYPT_CTX_NEED_KMS_CREDENTIALS is enabled. Defaults to false

Returns:

whether the MONGOCRYPT_CTX_NEED_KMS_CREDENTIALS is enabled

Since:

1.4

getEncryptedFieldsMap

public java.util.Map<java.lang.String,org.bson.BsonDocument> getEncryptedFieldsMap()

Gets the encrypted fields map.

Returns:

the encrypted fields map

Since:

1.5

isBypassQueryAnalysis

public boolean isBypassQueryAnalysis()

Gets whether automatic analysis of outgoing commands should be disabled.

Returns:

true if bypassing query analysis

Since:

1.5

getExtraOptions

public org.bson.BsonDocument getExtraOptions()

The extraOptions that relate to the mongocryptd process or shared library.

Returns:

the extra options

Since:

1.5

getSearchPaths

public java.util.List<java.lang.String> getSearchPaths()

Gets the search paths

Returns:

this

Since:

1.5