org.apache.nifi.security.kms

Class StaticKeyProvider

java.lang.Object

org.apache.nifi.security.kms.StaticKeyProvider

All Implemented Interfaces:

KeyProvider

Direct Known Subclasses:

FileBasedKeyProvider

public class StaticKeyProvider
extends Object
implements KeyProvider

Reference implementation for static key provider (used during tests).

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,SecretKey>	keys
private static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
StaticKeyProvider(Map<String,SecretKey> keys)
StaticKeyProvider(String keyId, String keyHex)

Method Summary

Modifier and Type	Method and Description
boolean	addKey(String keyId, SecretKey key) Adds the key to the provider and associates it with the given ID.
List<String>	getAvailableKeyIds() Returns a singleton list of the available key identifier.
SecretKey	getKey(String keyId) Returns the key identified by this ID or throws an exception if one is not available.
boolean	keyExists(String keyId) Returns true if the key exists and is available.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.slf4j.Logger logger

keys

private Map<String,SecretKey> keys

Constructor Detail

StaticKeyProvider

public StaticKeyProvider(String keyId,
                         String keyHex)
                  throws KeyManagementException

Throws:

KeyManagementException

StaticKeyProvider

public StaticKeyProvider(Map<String,SecretKey> keys)
                  throws KeyManagementException

Throws:

KeyManagementException

Method Detail

getKey

public SecretKey getKey(String keyId)
                 throws KeyManagementException

Returns the key identified by this ID or throws an exception if one is not available.

Specified by:

getKey in interface KeyProvider

Parameters:

keyId - the key identifier

Returns:

the key

Throws:

KeyManagementException - if the key cannot be retrieved

keyExists

public boolean keyExists(String keyId)

Returns true if the key exists and is available. Null or empty IDs will return false.

Specified by:

keyExists in interface KeyProvider

Parameters:

keyId - the key identifier

Returns:

true if the key can be used

getAvailableKeyIds

public List<String> getAvailableKeyIds()

Returns a singleton list of the available key identifier.

Specified by:

getAvailableKeyIds in interface KeyProvider

Returns:

a List containing the KEY_ID

addKey

public boolean addKey(String keyId,
                      SecretKey key)
               throws OperationNotSupportedException,
                      KeyManagementException

Adds the key to the provider and associates it with the given ID. Some implementations may not allow this operation.

Specified by:

addKey in interface KeyProvider

Parameters:

keyId - the key identifier

key - the key

Returns:

true if the key was successfully added

Throws:

OperationNotSupportedException - if this implementation doesn't support adding keys

KeyManagementException - if the key is invalid, the ID conflicts, etc.