Module spring.data.mongodb

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

Interface EncryptionKeyResolver

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface EncryptionKeyResolver

Interface to obtain a Data Encryption Key that is valid in a given context.

Use the based variant which will first try to resolve a potential Key Alternate Name from annotations before calling the fallback resolver.

Since:

4.1

Author:

Christoph Strobl

See Also:

• EncryptionKey

Method Summary

Modifier and Type	Method	Description
static EncryptionKeyResolver	annotated(EncryptionKeyResolver fallback)	Obtain an EncryptionKeyResolver that evaluates ExplicitEncrypted.keyAltName() and only calls the fallback resolver if no Key Alternate Name is present.
EncryptionKey	getKey(EncryptionContext encryptionContext)	Get the Data Encryption Key.

Method Details

getKey

EncryptionKey getKey(EncryptionContext encryptionContext)

Get the Data Encryption Key.

Parameters:

encryptionContext - the current context.

Returns:

never null.

annotated

static EncryptionKeyResolver annotated(EncryptionKeyResolver fallback)

Obtain an EncryptionKeyResolver that evaluates ExplicitEncrypted.keyAltName() and only calls the fallback resolver if no Key Alternate Name is present.

Parameters:

fallback - must not be null.

Returns:

new instance of EncryptionKeyResolver.