Package com.mongodb.client.model.vault

Class EncryptOptions

com.mongodb.client.model.vault.EncryptOptions

public class EncryptOptions
extends 

The options for explicit encryption.

Since:

3.11

Constructor Summary

Constructors

Constructor	Description
algorithm)	Construct an instance with the given algorithm.

Method Summary

Modifier and Type	Method	Description
	getAlgorithm()	Gets the encryption algorithm, which must be either "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic" or "AEAD_AES_256_CBC_HMAC_SHA_512-Random".
	getKeyAltName()	Gets the alternate name with which to look up the key.
BsonBinary	getKeyId()	Gets the key identifier.
EncryptOptions	keyAltName)	Sets the alternate key name
EncryptOptions	keyId(BsonBinary keyId)	Sets the key identifier
	toString()

Methods inherited from class java.lang.

, , , , , , , , ,

Constructor Detail

EncryptOptions

public EncryptOptions( algorithm)

Construct an instance with the given algorithm.

Parameters:

algorithm - the encryption algorithm

See Also:

getAlgorithm()

Method Detail

getAlgorithm

public  getAlgorithm()

Gets the encryption algorithm, which must be either "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic" or "AEAD_AES_256_CBC_HMAC_SHA_512-Random".

Returns:

the encryption algorithm

getKeyId

public BsonBinary getKeyId()

Gets the key identifier.

Identifies the data key by its _id value. The value is a UUID (binary subtype 4).

Returns:

the key identifier

getKeyAltName

public  getKeyAltName()

Gets the alternate name with which to look up the key.

Identifies the alternate key name to look up the key by.

Returns:

the alternate name

keyId

public EncryptOptions keyId(BsonBinary keyId)

Sets the key identifier

Parameters:

keyId - the key identifier

Returns:

this

See Also:

getKeyId()

keyAltName

public  keyAltName)

Sets the alternate key name

Parameters:

keyAltName - the alternate key name

Returns:

this

See Also:

getKeyAltName()

toString

public  toString()

Overrides:

in class