akka.persistence.gdpr.scaladsl

Interface GdprEncryption

All Superinterfaces:

akka.actor.Extension

All Known Implementing Classes:

AbstractGdprEncryption, DelegatingGdprEncryption, JavaKeyStoreGdprEncryption, TestGdprEncryption

public interface GdprEncryption
extends akka.actor.Extension

Extension point for plugging in encryption for GDPR. If you only want to provide key management then instead extend AbstractGdprEncryption.

Implementations must be thread-safe.

Method Summary

Modifier and Type	Method and Description
scala.concurrent.Future<scala.Option<byte[]>>	decrypt(byte[] payload, java.lang.String dataSubjectId) Decrypt the given payload with the key identified by dataSubjectId.
scala.concurrent.Future<byte[]>	encrypt(byte[] payload, java.lang.String dataSubjectId) Encrypt the given payload with the key identified by dataSubjectId.
scala.concurrent.Future<akka.Done>	shred(java.lang.String dataSubjectId) Remove the key identified by dataSubjectId from [KeyManagement].

Method Detail

encrypt

scala.concurrent.Future<byte[]> encrypt(byte[] payload,
                                        java.lang.String dataSubjectId)

Encrypt the given payload with the key identified by dataSubjectId.

Parameters:

payload - (undocumented)

dataSubjectId - (undocumented)

Returns:

(undocumented)

decrypt

scala.concurrent.Future<scala.Option<byte[]>> decrypt(byte[] payload,
                                                      java.lang.String dataSubjectId)

Decrypt the given payload with the key identified by dataSubjectId.

Parameters:

payload - (undocumented)

dataSubjectId - (undocumented)

Returns:

None if the key has been deleted

shred

scala.concurrent.Future<akka.Done> shred(java.lang.String dataSubjectId)

Remove the key identified by dataSubjectId from [KeyManagement].

Parameters:

dataSubjectId - (undocumented)

Returns:

(undocumented)