org.apache.nifi.processors.standard

Class LookupAttribute

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.LookupAttribute

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"lookup","cache","enrich","join","attributes","Attribute Expression Language"})
 @CapabilityDescription(value="Lookup attributes from a lookup service")
 @DynamicProperty(name="The name of the attribute to add to the FlowFile",
                 value="The name of the key or property to retrieve from the lookup service",
                 expressionLanguageScope=FLOWFILE_ATTRIBUTES,
                 description="Adds a FlowFile attribute specified by the dynamic property\'s key with the value found in the lookup service using the the dynamic property\'s value")
public class LookupAttribute
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
private List<PropertyDescriptor>	descriptors
private Map<PropertyDescriptor,PropertyValue>	dynamicProperties
static PropertyDescriptor	INCLUDE_EMPTY_VALUES
static PropertyDescriptor	LOOKUP_SERVICE
static Relationship	REL_FAILURE
static Relationship	REL_MATCHED
static Relationship	REL_UNMATCHED
private Set<Relationship>	relationships

Constructor Summary

Constructors

Constructor and Description
LookupAttribute()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
void	onScheduled(ProcessContext context)
private void	onTrigger(ComponentLog logger, LookupService lookupService, boolean includeEmptyValues, FlowFile flowFile, ProcessSession session)
void	onTrigger(ProcessContext context, ProcessSession session)
private boolean	putAttribute(String attributeName, Optional<String> attributeValue, Map<String,String> attributes, boolean includeEmptyValues, ComponentLog logger)

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

onTrigger

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

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

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

equals, getPropertyDescriptor, getPropertyDescriptors, hashCode, onPropertyModified, 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, onPropertyModified, validate

Field Detail

LOOKUP_SERVICE

public static final PropertyDescriptor LOOKUP_SERVICE

INCLUDE_EMPTY_VALUES

public static final PropertyDescriptor INCLUDE_EMPTY_VALUES

REL_MATCHED

public static final Relationship REL_MATCHED

REL_UNMATCHED

public static final Relationship REL_UNMATCHED

REL_FAILURE

public static final Relationship REL_FAILURE

descriptors

private List<PropertyDescriptor> descriptors

relationships

private Set<Relationship> relationships

dynamicProperties

private Map<PropertyDescriptor,PropertyValue> dynamicProperties

Constructor Detail

LookupAttribute

public LookupAttribute()

Method Detail

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

onTrigger

private void onTrigger(ComponentLog logger,
                       LookupService lookupService,
                       boolean includeEmptyValues,
                       FlowFile flowFile,
                       ProcessSession session)
                throws ProcessException,
                       IOException

Throws:

ProcessException

IOException

putAttribute

private boolean putAttribute(String attributeName,
                             Optional<String> attributeValue,
                             Map<String,String> attributes,
                             boolean includeEmptyValues,
                             ComponentLog logger)