org.apache.nifi.security.repository.config

Class RepositoryEncryptionConfiguration

java.lang.Object

org.apache.nifi.security.repository.config.RepositoryEncryptionConfiguration

Direct Known Subclasses:

ContentRepositoryEncryptionConfiguration, ProvenanceRepositoryEncryptionConfiguration

public abstract class RepositoryEncryptionConfiguration
extends Object

Abstract class which defines the method contracts for various repository encryption configuration values. The implementing classes will act as data containers for the encryption configs when initializing the repositories.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) String	encryptionKeyId
(package private) Map<String,String>	encryptionKeys
(package private) String	keyProviderImplementation
(package private) String	keyProviderLocation
(package private) String	repositoryImplementation
(package private) RepositoryType	repositoryType

Constructor Summary

Constructors

Constructor and Description
RepositoryEncryptionConfiguration()

Method Summary

Modifier and Type	Method and Description
static RepositoryEncryptionConfiguration	fromNiFiProperties(NiFiProperties niFiProperties, RepositoryType repositoryType)
String	getEncryptionKeyId() Returns the "active" encryption key id.
Map<String,String>	getEncryptionKeys() Returns a map of all available encryption keys indexed by the key id if using StaticKeyProvider.
String	getKeyProviderImplementation() Returns the class name of the KeyProvider implementation used.
String	getKeyProviderLocation() Returns the location of the key provider.
String	getRepositoryImplementation() Returns the class name for the repository implementation.
RepositoryType	getRepositoryType() Returns the RepositoryType enum identifying this repository.

Methods inherited from class java.lang.Object

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

Field Detail

keyProviderImplementation

String keyProviderImplementation

keyProviderLocation

String keyProviderLocation

encryptionKeyId

String encryptionKeyId

encryptionKeys

Map<String,String> encryptionKeys

repositoryImplementation

String repositoryImplementation

repositoryType

RepositoryType repositoryType

Constructor Detail

RepositoryEncryptionConfiguration

public RepositoryEncryptionConfiguration()

Method Detail

getKeyProviderImplementation

public String getKeyProviderImplementation()

Returns the class name of the KeyProvider implementation used.

Returns:

the class of the key provider

getKeyProviderLocation

public String getKeyProviderLocation()

Returns the location of the key provider. For a StaticKeyProvider this will be null; for all others, it will be the location (file path/URL/etc.) to access the key definitions.

Returns:

the file, URL, etc. where the keys are defined

getEncryptionKeyId

public String getEncryptionKeyId()

Returns the "active" encryption key id.

Returns:

the key id

getEncryptionKeys

public Map<String,String> getEncryptionKeys()

Returns a map of all available encryption keys indexed by the key id if using StaticKeyProvider. For FileBasedKeyProvider, this method will return an empty map because the keys must be loaded using the master key to decrypt them via CryptoUtils.readKeys(String, SecretKey).

Returns:

a map of key ids & keys

See Also:

NiFiProperties.getContentRepositoryEncryptionKeys()

getRepositoryImplementation

public String getRepositoryImplementation()

Returns the class name for the repository implementation.

Returns:

the repository class

getRepositoryType

public RepositoryType getRepositoryType()

Returns the RepositoryType enum identifying this repository. Useful for programmatically determining the kind of repository being configured.

Returns:

the repository type

fromNiFiProperties

public static RepositoryEncryptionConfiguration fromNiFiProperties(NiFiProperties niFiProperties,
                                                                   RepositoryType repositoryType)