org.apache.nifi.processors.standard

Class LookupRecord

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.LookupRecord

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @InputRequirement(value=INPUT_REQUIRED)
 @WritesAttribute(attribute="mime.type",description="Sets the mime.type attribute to the MIME Type specified by the Record Writer") @WritesAttribute(attribute="record.count",description="The number of records in the FlowFile")
 @Tags(value={"lookup","enrichment","route","record","csv","json","avro","database","db","logs","convert","filter"})
 @CapabilityDescription(value="Extracts one or more fields from a Record and looks up a value for those fields in a LookupService. If a result is returned by the LookupService, that result is optionally added to the Record. In this case, the processor functions as an Enrichment processor. Regardless, the Record is then routed to either the \'matched\' relationship or \'unmatched\' relationship (if the \'Routing Strategy\' property is configured to do so), indicating whether or not a result was returned by the LookupService, allowing the processor to also function as a Routing processor. The \"coordinates\" to use for looking up a value in the Lookup Service are defined by adding a user-defined property. Each property that is added will have an entry added to a Map, where the name of the property becomes the Map Key and the value returned by the RecordPath becomes the value for that key. If multiple values are returned by the RecordPath, then the Record will be routed to the \'unmatched\' relationship (or \'success\', depending on the \'Routing Strategy\' property\'s configuration). If one or more fields match the Result RecordPath, all fields that match will be updated. If there is no match in the configured LookupService, then no fields will be updated. I.e., it will not overwrite an existing value in the Record with a null value. Please note, however, that if the results returned by the LookupService are not accounted for in your schema (specifically, the schema that is configured for your Record Writer) then the fields will not be written out to the FlowFile.")
 @DynamicProperty(name="Value To Lookup",
                 value="Valid Record Path",
                 expressionLanguageScope=FLOWFILE_ATTRIBUTES,
                 description="A RecordPath that points to the field whose value will be looked up in the configured Lookup Service")
 @SeeAlso(value={ConvertRecord.class,SplitRecord.class},
         classNames={"org.apache.nifi.lookup.SimpleKeyValueLookupService","org.apache.nifi.lookup.maxmind.IPLookupService","org.apache.nifi.lookup.db.DatabaseRecordLookupService"})
public class LookupRecord
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	LookupRecord.InPlaceReplacementStrategy
private static class	LookupRecord.LookupContext
private class	LookupRecord.RecordPathReplacementStrategy
private static interface	LookupRecord.ReplacementStrategy

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static PropertyDescriptor	CACHE_SIZE
(package private) static PropertyDescriptor	LOOKUP_SERVICE
private LookupService<?>	lookupService
private static Set<Relationship>	MATCHED_COLLECTION
(package private) static PropertyDescriptor	RECORD_READER
(package private) static PropertyDescriptor	RECORD_WRITER
private RecordPathCache	recordPathCache
(package private) static Relationship	REL_FAILURE
(package private) static Relationship	REL_MATCHED
(package private) static Relationship	REL_SUCCESS
(package private) static Relationship	REL_UNMATCHED
private Set<Relationship>	relationships
(package private) static AllowableValue	REPLACE_EXISTING_VALUES
(package private) static PropertyDescriptor	REPLACEMENT_STRATEGY
(package private) static PropertyDescriptor	RESULT_CONTENTS
(package private) static AllowableValue	RESULT_ENTIRE_RECORD
(package private) static AllowableValue	RESULT_RECORD_FIELDS
(package private) static PropertyDescriptor	RESULT_RECORD_PATH
(package private) static AllowableValue	ROUTE_TO_MATCHED_UNMATCHED
(package private) static AllowableValue	ROUTE_TO_SUCCESS
private boolean	routeToMatchedUnmatched
(package private) static PropertyDescriptor	ROUTING_STRATEGY
private static Set<Relationship>	SUCCESS_COLLECTION
private static Set<Relationship>	UNMATCHED_COLLECTION
(package private) static AllowableValue	USE_PROPERTY

Constructor Summary

Constructors

Constructor and Description
LookupRecord()

Method Summary

Modifier and Type	Method and Description
protected LookupRecord.LookupContext	createLookupContext(FlowFile flowFile, ProcessContext context, ProcessSession session, RecordSetWriterFactory writerFactory)
private LookupRecord.ReplacementStrategy	createReplacementStrategy(ProcessContext context)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onPropertyModified(PropertyDescriptor descriptor, String oldValue, String newValue)
void	onScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

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

equals, getPropertyDescriptor, getPropertyDescriptors, hashCode, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.nifi.processor.Processor

isStateful

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

getPropertyDescriptor, getPropertyDescriptors, validate

Field Detail

recordPathCache

private final RecordPathCache recordPathCache

lookupService

private volatile LookupService<?> lookupService

ROUTE_TO_SUCCESS

static final AllowableValue ROUTE_TO_SUCCESS

ROUTE_TO_MATCHED_UNMATCHED

static final AllowableValue ROUTE_TO_MATCHED_UNMATCHED

RESULT_ENTIRE_RECORD

static final AllowableValue RESULT_ENTIRE_RECORD

RESULT_RECORD_FIELDS

static final AllowableValue RESULT_RECORD_FIELDS

USE_PROPERTY

static final AllowableValue USE_PROPERTY

REPLACE_EXISTING_VALUES

static final AllowableValue REPLACE_EXISTING_VALUES

RECORD_READER

static final PropertyDescriptor RECORD_READER

RECORD_WRITER

static final PropertyDescriptor RECORD_WRITER

LOOKUP_SERVICE

static final PropertyDescriptor LOOKUP_SERVICE

RESULT_RECORD_PATH

static final PropertyDescriptor RESULT_RECORD_PATH

RESULT_CONTENTS

static final PropertyDescriptor RESULT_CONTENTS

ROUTING_STRATEGY

static final PropertyDescriptor ROUTING_STRATEGY

REPLACEMENT_STRATEGY

static final PropertyDescriptor REPLACEMENT_STRATEGY

CACHE_SIZE

static final PropertyDescriptor CACHE_SIZE

REL_MATCHED

static final Relationship REL_MATCHED

REL_UNMATCHED

static final Relationship REL_UNMATCHED

REL_SUCCESS

static final Relationship REL_SUCCESS

REL_FAILURE

static final Relationship REL_FAILURE

MATCHED_COLLECTION

private static final Set<Relationship> MATCHED_COLLECTION

UNMATCHED_COLLECTION

private static final Set<Relationship> UNMATCHED_COLLECTION

SUCCESS_COLLECTION

private static final Set<Relationship> SUCCESS_COLLECTION

relationships

private volatile Set<Relationship> relationships

routeToMatchedUnmatched

private volatile boolean routeToMatchedUnmatched

Constructor Detail

LookupRecord

public LookupRecord()

Method Detail

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

onPropertyModified

public void onPropertyModified(PropertyDescriptor descriptor,
                               String oldValue,
                               String newValue)

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractConfigurableComponent

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

createReplacementStrategy

private LookupRecord.ReplacementStrategy createReplacementStrategy(ProcessContext context)

createLookupContext

protected LookupRecord.LookupContext createLookupContext(FlowFile flowFile,
                                                         ProcessContext context,
                                                         ProcessSession session,
                                                         RecordSetWriterFactory writerFactory)