org.apache.nifi.properties

Class StandardSensitivePropertyProviderFactory

java.lang.Object

org.apache.nifi.properties.StandardSensitivePropertyProviderFactory

All Implemented Interfaces:

SensitivePropertyProviderFactory

public class StandardSensitivePropertyProviderFactory
extends Object
implements SensitivePropertyProviderFactory

Standard implementation of Sensitive Property Provider Factory with custom initialization for each provider

Field Summary

Fields

Modifier and Type	Field and Description
private Supplier<BootstrapProperties>	bootstrapPropertiesSupplier
private Map<String,Pattern>	customPropertyContextMap
private Optional<String>	keyHex
private static org.slf4j.Logger	logger
private static List<Class<? extends SensitivePropertyProvider>>	PROVIDER_CLASSES
private Map<Class<? extends SensitivePropertyProvider>,SensitivePropertyProvider>	providers

Constructor Summary

Constructors

Modifier	Constructor and Description
	StandardSensitivePropertyProviderFactory() Factory default constructor to support java.util.ServiceLoader
private	StandardSensitivePropertyProviderFactory(String keyHex, Supplier<BootstrapProperties> bootstrapPropertiesSupplier)

Method Summary

Modifier and Type	Method and Description
private BootstrapProperties	getBootstrapProperties()
private <T> Properties	getClientProperties(ClientProvider<T> clientProvider)
private String	getKeyHex()
ProtectedPropertyContext	getPropertyContext(String groupIdentifier, String propertyName)
private SensitivePropertyProvider	getProvider(Class<? extends SensitivePropertyProvider> providerClass)
SensitivePropertyProvider	getProvider(ProtectionScheme protectionScheme) Get Provider where Protection Scheme path starts with a prefix mapped to the Provider Class
Collection<SensitivePropertyProvider>	getSupportedProviders() Get Supported Sensitive Property Providers instantiates providers as needed and checks supported status
private void	populateCustomPropertyContextMap()
void	setKeyHex(String hexadecimalKey)
static SensitivePropertyProviderFactory	withDefaults() Creates a StandardSensitivePropertyProviderFactory using the default bootstrap.conf location and the keyHex extracted from this bootstrap.conf.
static SensitivePropertyProviderFactory	withKey(String keyHex) Creates a StandardSensitivePropertyProviderFactory using only the provided secret key hex.
static SensitivePropertyProviderFactory	withKeyAndBootstrapSupplier(String keyHex, Supplier<BootstrapProperties> bootstrapPropertiesSupplier) Creates a new StandardSensitivePropertyProviderFactory using a separate keyHex and provided bootstrap.conf.

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

PROVIDER_CLASSES

private static final List<Class<? extends SensitivePropertyProvider>> PROVIDER_CLASSES

keyHex

private Optional<String> keyHex

bootstrapPropertiesSupplier

private final Supplier<BootstrapProperties> bootstrapPropertiesSupplier

providers

private final Map<Class<? extends SensitivePropertyProvider>,SensitivePropertyProvider> providers

customPropertyContextMap

private Map<String,Pattern> customPropertyContextMap

Constructor Detail

StandardSensitivePropertyProviderFactory

public StandardSensitivePropertyProviderFactory()

Factory default constructor to support java.util.ServiceLoader

StandardSensitivePropertyProviderFactory

private StandardSensitivePropertyProviderFactory(String keyHex,
                                                 Supplier<BootstrapProperties> bootstrapPropertiesSupplier)

Method Detail

setKeyHex

public void setKeyHex(String hexadecimalKey)

withDefaults

public static SensitivePropertyProviderFactory withDefaults()

Creates a StandardSensitivePropertyProviderFactory using the default bootstrap.conf location and the keyHex extracted from this bootstrap.conf.

withKey

public static SensitivePropertyProviderFactory withKey(String keyHex)

Creates a StandardSensitivePropertyProviderFactory using only the provided secret key hex. The default bootstrap.conf will be used for any providers that may require it, but the provided keyHex will be used instead of the one from the default bootstrap.conf.

Parameters:

keyHex - The secret key hex for encrypting properties

Returns:

A StandardSensitivePropertyProviderFactory

withKeyAndBootstrapSupplier

public static SensitivePropertyProviderFactory withKeyAndBootstrapSupplier(String keyHex,
                                                                           Supplier<BootstrapProperties> bootstrapPropertiesSupplier)

Creates a new StandardSensitivePropertyProviderFactory using a separate keyHex and provided bootstrap.conf. The provided keyHex will be used instead of the one from the bootstrap.conf.

Parameters:

keyHex - The secret key hex for encrypting properties

bootstrapPropertiesSupplier - A supplier for the BootstrapProperties that represent bootstrap.conf. If the supplier returns null, the default bootstrap.conf will be used instead.

Returns:

A StandardSensitivePropertyProviderFactory

getProvider

public SensitivePropertyProvider getProvider(ProtectionScheme protectionScheme)
                                      throws SensitivePropertyProtectionException

Get Provider where Protection Scheme path starts with a prefix mapped to the Provider Class

Specified by:

getProvider in interface SensitivePropertyProviderFactory

Parameters:

protectionScheme - Protection Scheme requested

Returns:

Sensitive Property Provider

Throws:

SensitivePropertyProtectionException - Thrown when provider path not found for requested scheme

getSupportedProviders

public Collection<SensitivePropertyProvider> getSupportedProviders()

Get Supported Sensitive Property Providers instantiates providers as needed and checks supported status

Specified by:

getSupportedProviders in interface SensitivePropertyProviderFactory

Returns:

Supported Sensitive Property Providers

getPropertyContext

public ProtectedPropertyContext getPropertyContext(String groupIdentifier,
                                                   String propertyName)

Specified by:

getPropertyContext in interface SensitivePropertyProviderFactory

populateCustomPropertyContextMap

private void populateCustomPropertyContextMap()

getKeyHex

private String getKeyHex()

getBootstrapProperties

private BootstrapProperties getBootstrapProperties()

getClientProperties

private <T> Properties getClientProperties(ClientProvider<T> clientProvider)

getProvider

private SensitivePropertyProvider getProvider(Class<? extends SensitivePropertyProvider> providerClass)
                                       throws SensitivePropertyProtectionException

Throws:

SensitivePropertyProtectionException