com.cloudant.sync.datastore.encryption

Class CachingKeyProvider

java.lang.Object

com.cloudant.sync.datastore.encryption.CachingKeyProvider

All Implemented Interfaces:

KeyProvider

public class CachingKeyProvider
extends java.lang.Object
implements KeyProvider

Given a user-provided KeyProvider, it provides an in-memory cache for retrieving an EncryptionKey. This improves performance when multiple encrypted datastores are used. This class implements the interface KeyProvider and it can be used to create an encrypted datastore.

See Also:

KeyProvider

API Status: Public

Constructor Summary

Constructors

Constructor and Description
CachingKeyProvider(KeyProvider keyProvider) Creates a CachingKeyProvider containing a KeyProvider whose EncryptionKey can be cached

Method Summary

Modifier and Type	Method and Description
EncryptionKey	getEncryptionKey()
KeyProvider	getKeyProvider()

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingKeyProvider

public CachingKeyProvider(KeyProvider keyProvider)

Creates a CachingKeyProvider containing a KeyProvider whose EncryptionKey can be cached

Parameters:

keyProvider - The KeyProvider to use for encrypting a datastore

Method Detail

getEncryptionKey

public EncryptionKey getEncryptionKey()

Specified by:

getEncryptionKey in interface KeyProvider

Returns:

the encryption key used to encrypt datastore data

getKeyProvider

public KeyProvider getKeyProvider()

Returns:

the KeyProvider used for creating and retrieving the EncryptionKey