org.apache.nifi.security.kms

Class FileBasedKeyProvider

java.lang.Object

org.apache.nifi.security.kms.StaticKeyProvider

org.apache.nifi.security.kms.FileBasedKeyProvider

All Implemented Interfaces:

KeyProvider

public class FileBasedKeyProvider
extends StaticKeyProvider

Field Summary

Fields

Modifier and Type	Field and Description
private String	filepath
private static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
FileBasedKeyProvider(String location, SecretKey rootKey)

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.

Methods inherited from class org.apache.nifi.security.kms.StaticKeyProvider

getAvailableKeyIds, getKey, keyExists

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

filepath

private final String filepath

Constructor Detail

FileBasedKeyProvider

public FileBasedKeyProvider(String location,
                            SecretKey rootKey)
                     throws KeyManagementException

Throws:

KeyManagementException

Method Detail

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

Overrides:

addKey in class StaticKeyProvider

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.