Package org.apache.nifi.processors.standard

Class ScanContent

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.ScanContent

All Implemented Interfaces:

org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.processor.Processor

@SideEffectFree
@SupportsBatching
@InputRequirement(INPUT_REQUIRED)
@Tags({"aho-corasick","scan","content","byte sequence","search","find","dictionary"})
@CapabilityDescription("Scans the content of FlowFiles for terms that are found in a user-supplied dictionary. If a term is matched, the UTF-8 encoded version of the term will be added to the FlowFile using the \'matching.term\' attribute")
@WritesAttribute(attribute="matching.term",
                 description="The term that caused the Processor to route the FlowFile to the \'matched\' relationship; if FlowFile is routed to the \'unmatched\' relationship, this attribute is not added")
public class ScanContent
extends org.apache.nifi.processor.AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ScanContent.BinaryTermLoader
private static interface	ScanContent.TermLoader
private static class	ScanContent.TextualTermLoader

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BINARY_ENCODING
static final org.apache.nifi.components.PropertyDescriptor	DICTIONARY
static final org.apache.nifi.components.PropertyDescriptor	DICTIONARY_ENCODING
private final ReentrantLock	dictionaryUpdateLock
private final AtomicReference<SynchronousFileWatcher>	fileWatcherRef
static final String	MATCH_ATTRIBUTE_KEY
private static final List<org.apache.nifi.components.PropertyDescriptor>	PROPERTY_DESCRIPTORS
static final org.apache.nifi.processor.Relationship	REL_MATCH
static final org.apache.nifi.processor.Relationship	REL_NO_MATCH
private static final Set<org.apache.nifi.processor.Relationship>	RELATIONSHIPS
private final AtomicReference<Search<byte[]>>	searchRef
static final String	TEXT_ENCODING
static final Charset	UTF8

Constructor Summary

Constructors

Constructor	Description
ScanContent()

Method Summary

Modifier and Type	Method	Description
private ScanContent.TermLoader	createTermLoader(org.apache.nifi.processor.ProcessContext context, InputStream in)
Set<org.apache.nifi.processor.Relationship>	getRelationships()
protected List<org.apache.nifi.components.PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onPropertyModified(org.apache.nifi.components.PropertyDescriptor descriptor, String oldValue, String newValue)
void	onTrigger(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.ProcessSession session)
private boolean	reloadDictionary(org.apache.nifi.processor.ProcessContext context, boolean force, org.apache.nifi.logging.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, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

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

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

getPropertyDescriptor, getPropertyDescriptors, validate

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

isStateful, migrateProperties, migrateRelationships

Field Details

TEXT_ENCODING

public static final String TEXT_ENCODING

See Also:

• Constant Field Values

BINARY_ENCODING

public static final String BINARY_ENCODING

See Also:

• Constant Field Values

MATCH_ATTRIBUTE_KEY

public static final String MATCH_ATTRIBUTE_KEY

See Also:

• Constant Field Values

DICTIONARY

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

DICTIONARY_ENCODING

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

PROPERTY_DESCRIPTORS

private static final List<org.apache.nifi.components.PropertyDescriptor> PROPERTY_DESCRIPTORS

REL_MATCH

public static final org.apache.nifi.processor.Relationship REL_MATCH

REL_NO_MATCH

public static final org.apache.nifi.processor.Relationship REL_NO_MATCH

RELATIONSHIPS

private static final Set<org.apache.nifi.processor.Relationship> RELATIONSHIPS

UTF8

public static final Charset UTF8

fileWatcherRef

private final AtomicReference<SynchronousFileWatcher> fileWatcherRef

searchRef

private final AtomicReference<Search<byte[]>> searchRef

dictionaryUpdateLock

private final ReentrantLock dictionaryUpdateLock

Constructor Details

ScanContent

public ScanContent()

Method Details

getSupportedPropertyDescriptors

protected List<org.apache.nifi.components.PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class org.apache.nifi.components.AbstractConfigurableComponent

getRelationships

public Set<org.apache.nifi.processor.Relationship> getRelationships()

Specified by:

getRelationships in interface org.apache.nifi.processor.Processor

Overrides:

getRelationships in class org.apache.nifi.processor.AbstractSessionFactoryProcessor

onPropertyModified

public void onPropertyModified(org.apache.nifi.components.PropertyDescriptor descriptor,
 String oldValue,
 String newValue)

Specified by:

onPropertyModified in interface org.apache.nifi.components.ConfigurableComponent

Overrides:

onPropertyModified in class org.apache.nifi.components.AbstractConfigurableComponent

reloadDictionary

private boolean reloadDictionary(org.apache.nifi.processor.ProcessContext context,
 boolean force,
 org.apache.nifi.logging.ComponentLog logger)
                          throws IOException

Throws:

IOException

createTermLoader

private ScanContent.TermLoader createTermLoader(org.apache.nifi.processor.ProcessContext context,
 InputStream in)

onTrigger

public void onTrigger(org.apache.nifi.processor.ProcessContext context,
 org.apache.nifi.processor.ProcessSession session)
               throws org.apache.nifi.processor.exception.ProcessException

Specified by:

onTrigger in class org.apache.nifi.processor.AbstractProcessor

Throws:

org.apache.nifi.processor.exception.ProcessException