Module spring.data.mongodb

Package org.springframework.data.mongodb.core.encryption

Class EncryptionOptions

java.lang.Object

org.springframework.data.mongodb.core.encryption.EncryptionOptions

public class EncryptionOptions
extends Object

Options used to provide additional information when encrypting values. like the algorithm() to be used.

Since:

4.1

Author:

Christoph Strobl, Ross Lawley

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EncryptionOptions.QueryableEncryptionOptions	Options, like the EncryptionOptions.QueryableEncryptionOptions.getQueryType(), to apply when encrypting queryable values.

Constructor Summary

Constructors

Constructor	Description
EncryptionOptions(String algorithm, EncryptionKey key)
EncryptionOptions(String algorithm, EncryptionKey key, EncryptionOptions.QueryableEncryptionOptions queryableEncryptionOptions)

Method Summary

Modifier and Type	Method	Description
String	algorithm()
boolean	equals(Object o)
int	hashCode()
EncryptionKey	key()
EncryptionOptions.QueryableEncryptionOptions	queryableEncryptionOptions()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

EncryptionOptions

public EncryptionOptions(String algorithm,
 EncryptionKey key)

EncryptionOptions

public EncryptionOptions(String algorithm,
 EncryptionKey key,
 @Nullable
 EncryptionOptions.QueryableEncryptionOptions queryableEncryptionOptions)

Method Details

key

public EncryptionKey key()

algorithm

public String algorithm()

queryableEncryptionOptions

@Nullable
public EncryptionOptions.QueryableEncryptionOptions queryableEncryptionOptions()

Returns:

null if not set.

Since:

4.5

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object