org.apache.nifi.lookup.configuration2

Class CommonsConfigurationLookupService<T extends org.apache.commons.configuration2.FileBasedConfiguration>

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.lookup.configuration2.CommonsConfigurationLookupService<T>

All Implemented Interfaces:

ConfigurableComponent, ControllerService, LookupService<String>, StringLookupService

Direct Known Subclasses:

PropertiesFileLookupService, XMLFileLookupService

public abstract class CommonsConfigurationLookupService<T extends org.apache.commons.configuration2.FileBasedConfiguration>
extends AbstractControllerService
implements StringLookupService

This abstract class defines a generic LookupService backed by an Apache Commons Configuration FileBasedConfiguration.

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.commons.configuration2.builder.ReloadingFileBasedConfigurationBuilder<T>	builder
static PropertyDescriptor	CONFIGURATION_FILE
private static String	KEY
private List<PropertyDescriptor>	properties
private static Set<String>	REQUIRED_KEYS
private Class<T>	resultClass

Constructor Summary

Constructors

Constructor and Description
CommonsConfigurationLookupService()

Method Summary

Modifier and Type	Method and Description
private org.apache.commons.configuration2.Configuration	getConfiguration()
Set<String>	getRequiredKeys()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ControllerServiceInitializationContext context)
Optional<String>	lookup(Map<String,Object> coordinates)
void	onEnabled(ConfigurationContext context)

Methods inherited from class org.apache.nifi.controller.AbstractControllerService

abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getConfigurationContext, getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, getProperty, getStateManager, initialize, isEnabled

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.lookup.StringLookupService

getValueType

Methods inherited from interface org.apache.nifi.lookup.LookupService

lookup

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize, isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

KEY

private static final String KEY

See Also:

Constant Field Values

REQUIRED_KEYS

private static final Set<String> REQUIRED_KEYS

CONFIGURATION_FILE

public static final PropertyDescriptor CONFIGURATION_FILE

resultClass

private final Class<T extends org.apache.commons.configuration2.FileBasedConfiguration> resultClass

properties

private List<PropertyDescriptor> properties

builder

private volatile org.apache.commons.configuration2.builder.ReloadingFileBasedConfigurationBuilder<T extends org.apache.commons.configuration2.FileBasedConfiguration> builder

Constructor Detail

CommonsConfigurationLookupService

public CommonsConfigurationLookupService()

Method Detail

getConfiguration

private org.apache.commons.configuration2.Configuration getConfiguration()
                                                                  throws LookupFailureException

Throws:

LookupFailureException

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

init

protected void init(ControllerServiceInitializationContext context)
             throws InitializationException

Overrides:

init in class AbstractControllerService

Throws:

InitializationException

onEnabled

@OnEnabled
public void onEnabled(ConfigurationContext context)
                          throws InitializationException

Throws:

InitializationException

lookup

public Optional<String> lookup(Map<String,Object> coordinates)
                        throws LookupFailureException

Specified by:

lookup in interface LookupService<String>

Throws:

LookupFailureException

getRequiredKeys

public Set<String> getRequiredKeys()

Specified by:

getRequiredKeys in interface LookupService<String>