Package org.apache.nifi.lookup

Class SimpleCsvFileLookupService

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.lookup.AbstractCSVLookupService

org.apache.nifi.lookup.SimpleCsvFileLookupService

All Implemented Interfaces:

org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.controller.ControllerService, LookupService<String>, StringLookupService

@Tags({"lookup","cache","enrich","join","csv","reloadable","key","value"})
@CapabilityDescription("A reloadable CSV file-based lookup service. The first line of the csv file is considered as header.")
@Restricted(restrictions=@Restriction(requiredPermission=READ_FILESYSTEM,explanation="Provides operator the ability to read from any file that NiFi has access to."))
public class SimpleCsvFileLookupService
extends AbstractCSVLookupService
implements StringLookupService

Field Summary

Fields

Modifier and Type	Field	Description
private ConcurrentMap<String,String>	cache
static final org.apache.nifi.components.PropertyDescriptor	LOOKUP_VALUE_COLUMN
private String	lookupValueColumn
private static final Set<String>	REQUIRED_KEYS

Fields inherited from class org.apache.nifi.lookup.AbstractCSVLookupService

charset, CHARSET, CSV_FILE, CSV_FORMAT, csvFile, csvFormat, DEFAULT, IGNORE_DUPLICATES, ignoreDuplicates, KEY, lock, LOOKUP_KEY_COLUMN, lookupKeyColumn, properties, RFC4180, watcher

Constructor Summary

Constructors

Constructor	Description
SimpleCsvFileLookupService()

Method Summary

Modifier and Type	Method	Description
Set<String>	getRequiredKeys()
protected void	init(org.apache.nifi.controller.ControllerServiceInitializationContext context)
(package private) boolean	isCaching()
protected void	loadCache()
Optional<String>	lookup(Map<String,Object> coordinates)
void	onDisabled()
void	onEnabled(org.apache.nifi.controller.ConfigurationContext context)

Methods inherited from class org.apache.nifi.lookup.AbstractCSVLookupService

getSupportedPropertyDescriptors

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.components.ConfigurableComponent

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

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

initialize, isStateful, migrateProperties

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

lookup

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

getValueType

Field Details

REQUIRED_KEYS

private static final Set<String> REQUIRED_KEYS

LOOKUP_VALUE_COLUMN

public static final org.apache.nifi.components.PropertyDescriptor LOOKUP_VALUE_COLUMN

cache

private volatile ConcurrentMap<String,String> cache

lookupValueColumn

private volatile String lookupValueColumn

Constructor Details

SimpleCsvFileLookupService

public SimpleCsvFileLookupService()

Method Details

loadCache

protected void loadCache()
                  throws IllegalStateException,
IOException

Specified by:

loadCache in class AbstractCSVLookupService

Throws:

IllegalStateException

IOException

init

protected void init(org.apache.nifi.controller.ControllerServiceInitializationContext context)

Overrides:

init in class AbstractCSVLookupService

onEnabled

@OnEnabled
public void onEnabled(org.apache.nifi.controller.ConfigurationContext context)
               throws IOException,
InitializationException

Overrides:

onEnabled in class AbstractCSVLookupService

Throws:

IOException

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>

onDisabled

@OnDisabled
public void onDisabled()

isCaching

boolean isCaching()