Module spring.data.mongodb

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

Interface EncryptionContext

public interface EncryptionContext

Context to encapsulate encryption for a specific MongoPersistentProperty.

Since:

4.1

Author:

Christoph Strobl

Method Summary

Modifier and Type	Method	Description
Object	convertToMongoType(Object value)	Shortcut for converting a given value into its store representation using the root ValueConversionContext.
EvaluationContext	getEvaluationContext(Object source)
MongoPersistentProperty	getProperty()	Returns the MongoPersistentProperty to be handled.
Object	lookupValue(String path)	Lookup the value for a given path within the current context.
default <T> T	read(Object value)	Reads the value as an instance of the property type.
default <T> T	read(Object value, Class<T> target)	Reads the value as an instance of type.
<T> T	read(Object value, TypeInformation<T> target)	Reads the value as an instance of type.
default <T> T	write(Object value)	Write the value as an instance of the property type.
default <T> T	write(Object value, Class<T> target)	Write the value as an instance of type.
<T> T	write(Object value, TypeInformation<T> target)	Write the value as an instance of given type.

Method Details

getProperty

MongoPersistentProperty getProperty()

Returns the MongoPersistentProperty to be handled.

Returns:

will never be null.

convertToMongoType

Object convertToMongoType(Object value)

Shortcut for converting a given value into its store representation using the root ValueConversionContext.

Parameters:

value -

Returns:

read

default <T> T read(@Nullable
 Object value)

Reads the value as an instance of the property type.

Parameters:

value - value to be read; can be null.

Returns:

can be null.

Throws:

IllegalStateException - if value cannot be read as an instance of type.

read

default <T> T read(@Nullable
 Object value,
 Class<T> target)

Reads the value as an instance of type.

Parameters:

value - value to be read; can be null.

target - type of value to be read; must not be null.

Returns:

can be null.

Throws:

IllegalStateException - if value cannot be read as an instance of type.

read

<T> T read(@Nullable
 Object value,
 TypeInformation<T> target)

Reads the value as an instance of type.

Parameters:

value - value to be read; can be null.

target - type of value to be read; must not be null.

Returns:

can be null.

Throws:

IllegalStateException - if value cannot be read as an instance of type.

write

@Nullable
default <T> T write(@Nullable
 Object value)

Write the value as an instance of the property type.

Parameters:

value - value to write; can be null.

Returns:

can be null.

Throws:

IllegalStateException - if value cannot be written as an instance of the property type.

See Also:

• PersistentProperty.getTypeInformation()
• write(Object, TypeInformation)

write

@Nullable
default <T> T write(@Nullable
 Object value,
 Class<T> target)

Write the value as an instance of type.

Parameters:

value - value to write; can be null.

target - type of value to be written; must not be null.

Returns:

can be null.

Throws:

IllegalStateException - if value cannot be written as an instance of type.

write

@Nullable
<T> T write(@Nullable
 Object value,
 TypeInformation<T> target)

Write the value as an instance of given type.

Parameters:

value - value to write; can be null.

target - type of value to be written; must not be null.

Returns:

can be null.

Throws:

IllegalStateException - if value cannot be written as an instance of type.

lookupValue

@Nullable
Object lookupValue(String path)

Lookup the value for a given path within the current context.

Parameters:

path - the path/property name to resolve the current value for.

Returns:

can be null.

getEvaluationContext

EvaluationContext getEvaluationContext(Object source)