Class MongoEncryptionConverter

java.lang.Object

org.springframework.data.mongodb.core.convert.encryption.MongoEncryptionConverter

All Implemented Interfaces:

PropertyValueConverter<Object, Object, MongoConversionContext>, EncryptingConverter<Object,Object>, MongoValueConverter<Object,Object>

public class MongoEncryptionConverter
extends Object
implements EncryptingConverter<Object,Object>

Default implementation of EncryptingConverter. Properties used with this converter must be annotated with @Encrypted to provide key and algorithm metadata.

Since:

4.1

Author:

Christoph Strobl, Ross Lawley

Nested Class Summary

Nested classes/interfaces inherited from interface PropertyValueConverter

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AND_OPERATOR

Constructor Summary

Constructors

Constructor	Description
MongoEncryptionConverter(Encryption<org.bson.BsonValue, org.bson.BsonBinary> encryption, EncryptionKeyResolver keyResolver)

Method Summary

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

Methods inherited from class Object

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

Methods inherited from interface EncryptingConverter

write

Methods inherited from interface PropertyValueConverter

readNull, writeNull

Field Details

AND_OPERATOR

public static final String AND_OPERATOR

See Also:

• Constant Field Values

Constructor Details

MongoEncryptionConverter

public MongoEncryptionConverter(Encryption<org.bson.BsonValue, org.bson.BsonBinary> encryption,
 EncryptionKeyResolver keyResolver)

Method Details

read

public @Nullable Object read(Object value,
 MongoConversionContext context)

Specified by:

read in interface EncryptingConverter<Object,Object>

Specified by:

read in interface PropertyValueConverter<Object, Object, MongoConversionContext>

decrypt

public @Nullable Object decrypt(Object encryptedValue,
 EncryptionContext context)

Description copied from interface: EncryptingConverter

Decrypt the given encrypted source value within the given context.

Specified by:

decrypt in interface EncryptingConverter<Object,Object>

Parameters:

encryptedValue - the encrypted source.

context - the context to operate in.

Returns:

never null.

encrypt

public Object encrypt(@Nullable Object value,
 EncryptionContext context)

Description copied from interface: EncryptingConverter

Encrypt the given raw source value within the given context.

Specified by:

encrypt in interface EncryptingConverter<Object,Object>

Parameters:

value - the encrypted source.

context - the context to operate in.

Returns:

never null.

buildEncryptionContext

public EncryptionContext buildEncryptionContext(MongoConversionContext context)

Description copied from interface: EncryptingConverter

Obtain the EncryptionContext for a given value conversion context.

Specified by:

buildEncryptionContext in interface EncryptingConverter<Object,Object>

Parameters:

context - the current MongoDB specific ValueConversionContext.

Returns:

the EncryptionContext to operate in.

See Also:

• ValueConversionContext

getProperty

protected MongoPersistentProperty getProperty(EncryptionContext context)