Interface EncryptingConverter<S,T>

All Superinterfaces:

MongoValueConverter<S,T>, PropertyValueConverter<S, T, MongoConversionContext>

All Known Implementing Classes:

MongoEncryptionConverter

public interface EncryptingConverter<S,T>
extends MongoValueConverter<S,T>

A specialized MongoValueConverter for encrypting and decrypting properties.

Since:

4.1

Author:

Christoph Strobl

Nested Class Summary

Nested classes/interfaces inherited from interface PropertyValueConverter

PropertyValueConverter.FunctionPropertyValueConverter<DV,SV,P>, PropertyValueConverter.ObjectToObjectPropertyValueConverter

Method Summary

Modifier and Type	Method	Description
EncryptionContext	buildEncryptionContext(MongoConversionContext context)	Obtain the EncryptionContext for a given value conversion context.
@Nullable S	decrypt(Object encryptedValue, EncryptionContext context)	Decrypt the given encrypted source value within the given context.
T	encrypt(@Nullable Object value, EncryptionContext context)	Encrypt the given raw source value within the given context.
default @Nullable S	read(Object value, MongoConversionContext context)
default @Nullable T	write(Object value, MongoConversionContext context)

Methods inherited from interface PropertyValueConverter

readNull, writeNull

Method Details

read

default @Nullable S read(Object value,
 MongoConversionContext context)

Specified by:

read in interface PropertyValueConverter<S, T, MongoConversionContext>

decrypt

@Nullable S decrypt(Object encryptedValue,
 EncryptionContext context)

Decrypt the given encrypted source value within the given context.

Parameters:

encryptedValue - the encrypted source.

context - the context to operate in.

Returns:

never null.

write

default @Nullable T write(Object value,
 MongoConversionContext context)

Specified by:

write in interface PropertyValueConverter<S, T, MongoConversionContext>

encrypt

T encrypt(@Nullable Object value,
 EncryptionContext context)

Encrypt the given raw source value within the given context.

Parameters:

value - the encrypted source.

context - the context to operate in.

Returns:

never null.

buildEncryptionContext

EncryptionContext buildEncryptionContext(MongoConversionContext context)

Obtain the EncryptionContext for a given value conversion context.

Parameters:

context - the current MongoDB specific ValueConversionContext.

Returns:

the EncryptionContext to operate in.

See Also:

• ValueConversionContext