org.apache.nifi.security.kms

Interface KeyProvider

All Known Implementing Classes:

FileBasedKeyProvider, StaticKeyProvider

public interface KeyProvider

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 list of available key identifiers (useful for encryption, as retired keys may not be listed here even if they are available for decryption for legacy/BC reasons).
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.

Method Detail

getKey

SecretKey getKey(String keyId)
          throws KeyManagementException

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

Parameters:

keyId - the key identifier

Returns:

the key

Throws:

KeyManagementException - if the key cannot be retrieved

keyExists

boolean keyExists(String keyId)

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

Parameters:

keyId - the key identifier

Returns:

true if the key can be used

getAvailableKeyIds

List<String> getAvailableKeyIds()

Returns a list of available key identifiers (useful for encryption, as retired keys may not be listed here even if they are available for decryption for legacy/BC reasons).

Returns:

a List of keyIds (empty list if none are available)

addKey

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.

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.