org.apache.nifi.processors.standard

Class ScanAttribute

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.ScanAttribute

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"scan","attributes","search","lookup","find","text"})
 @CapabilityDescription(value="Scans the specified attributes of FlowFiles, checking to see if any of their values are present within the specified dictionary of terms")
public class ScanAttribute
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	ATTRIBUTE_PATTERN
private Pattern	attributePattern
static PropertyDescriptor	DICTIONARY_FILE
static PropertyDescriptor	DICTIONARY_FILTER
private Pattern	dictionaryFilterPattern
private Set<String>	dictionaryTerms
private SynchronousFileWatcher	fileWatcher
static String	MATCH_CRITERIA_ALL
static String	MATCH_CRITERIA_ANY
static PropertyDescriptor	MATCHING_CRITERIA
private List<PropertyDescriptor>	properties
static Relationship	REL_MATCHED
static Relationship	REL_UNMATCHED
private Set<Relationship>	relationships

Constructor Summary

Constructors

Constructor and Description
ScanAttribute()

Method Summary

Modifier and Type	Method and Description
private boolean	allMatch(FlowFile flowFile, Pattern attributePattern, Set<String> dictionary)
private boolean	anyMatch(FlowFile flowFile, Pattern attributePattern, Set<String> dictionary)
private Set<String>	createDictionary(ProcessContext context)
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
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, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

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

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, 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

MATCH_CRITERIA_ALL

public static final String MATCH_CRITERIA_ALL

See Also:

Constant Field Values

MATCH_CRITERIA_ANY

public static final String MATCH_CRITERIA_ANY

See Also:

Constant Field Values

MATCHING_CRITERIA

public static final PropertyDescriptor MATCHING_CRITERIA

ATTRIBUTE_PATTERN

public static final PropertyDescriptor ATTRIBUTE_PATTERN

DICTIONARY_FILE

public static final PropertyDescriptor DICTIONARY_FILE

DICTIONARY_FILTER

public static final PropertyDescriptor DICTIONARY_FILTER

properties

private List<PropertyDescriptor> properties

relationships

private Set<Relationship> relationships

dictionaryFilterPattern

private volatile Pattern dictionaryFilterPattern

attributePattern

private volatile Pattern attributePattern

dictionaryTerms

private volatile Set<String> dictionaryTerms

fileWatcher

private volatile SynchronousFileWatcher fileWatcher

REL_MATCHED

public static final Relationship REL_MATCHED

REL_UNMATCHED

public static final Relationship REL_UNMATCHED

Constructor Detail

ScanAttribute

public ScanAttribute()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)
                              throws IOException

Throws:

IOException

createDictionary

private Set<String> createDictionary(ProcessContext context)
                              throws IOException

Throws:

IOException

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

allMatch

private boolean allMatch(FlowFile flowFile,
                         Pattern attributePattern,
                         Set<String> dictionary)

anyMatch

private boolean anyMatch(FlowFile flowFile,
                         Pattern attributePattern,
                         Set<String> dictionary)