org.apache.nifi.processors.standard

Class RouteText

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.RouteText

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"attributes","routing","text","regexp","regex","Regular Expression","Expression Language","csv","filter","logs","delimited"})
 @CapabilityDescription(value="Routes textual data based on a set of user-defined rules. Each line in an incoming FlowFile is compared against the values specified by user-defined Properties. The mechanism by which the text is compared to these user-defined properties is defined by the \'Matching Strategy\'. The data is then routed according to these rules, routing each line of the text individually.")
 @DynamicProperty(name="Relationship Name",
                 value="value to match against",
                 description="Routes data that matches the value specified in the Dynamic Property Value to the Relationship specified in the Dynamic Property Key.")
 @DynamicRelationship(name="Name from Dynamic Property",
                     description="FlowFiles that match the Dynamic Property\'s value")
public class RouteText
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	RouteText.Group

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	CHARACTER_SET
private String	configuredRouteStrategy
static AllowableValue	CONTAINS
static AllowableValue	CONTAINS_REGULAR_EXPRESSION
private static String	containsRegularExpressionValue
private static String	containsValue
private Set<String>	dynamicPropertyNames
private static RouteText.Group	EMPTY_GROUP
static AllowableValue	ENDS_WITH
private static String	endsWithValue
static AllowableValue	EQUALS
private static String	equalsValue
static String	GROUP_ATTRIBUTE_KEY
(package private) static PropertyDescriptor	GROUPING_REGEX
private Pattern	groupingRegex
(package private) static PropertyDescriptor	IGNORE_CASE
static PropertyDescriptor	MATCH_STRATEGY
static AllowableValue	MATCHES_REGULAR_EXPRESSION
private static String	matchesRegularExpressionValue
private List<PropertyDescriptor>	properties
private Map<Relationship,PropertyValue>	propertyMap Cache of dynamic properties set during onScheduled(ProcessContext) for quick access in onTrigger(ProcessContext, ProcessSession)
static Relationship	REL_MATCH
static Relationship	REL_NO_MATCH
static Relationship	REL_ORIGINAL
private AtomicReference<Set<Relationship>>	relationships
static String	ROUTE_ATTRIBUTE_KEY
static PropertyDescriptor	ROUTE_STRATEGY
static AllowableValue	ROUTE_TO_MATCHED_WHEN_ALL_PROPERTIES_MATCH
static AllowableValue	ROUTE_TO_MATCHED_WHEN_ANY_PROPERTY_MATCHES
static AllowableValue	ROUTE_TO_MATCHING_PROPERTY_NAME
private static String	routeAllMatchValue
private static String	routeAnyMatchValue
private static String	routePropertyNameValue
static AllowableValue	SATISFIES_EXPRESSION
private static String	satisfiesExpression
static AllowableValue	STARTS_WITH
private static String	startsWithValue
static PropertyDescriptor	TRIM_WHITESPACE

Constructor Summary

Constructors

Constructor and Description
RouteText()

Method Summary

Modifier and Type	Method and Description
private void	appendLine(ProcessSession session, Map<Relationship,Map<RouteText.Group,FlowFile>> flowFileMap, Relationship relationship, FlowFile original, String line, Charset charset, RouteText.Group group)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
private RouteText.Group	getGroup(String line, Pattern groupPattern)
Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
protected static boolean	lineMatches(String line, Object comparison, String matchingStrategy, boolean ignoreCase, FlowFile flowFile, Map<String,String> variables)
void	onPropertyModified(PropertyDescriptor descriptor, String oldValue, String newValue)
void	onScheduled(ProcessContext context) When this processor is scheduled, update the dynamic properties into the map for quick access during each onTrigger call
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

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

getPropertyDescriptor, getPropertyDescriptors, validate

Field Detail

ROUTE_ATTRIBUTE_KEY

public static final String ROUTE_ATTRIBUTE_KEY

See Also:

Constant Field Values

GROUP_ATTRIBUTE_KEY

public static final String GROUP_ATTRIBUTE_KEY

See Also:

Constant Field Values

routeAllMatchValue

private static final String routeAllMatchValue

See Also:

Constant Field Values

routeAnyMatchValue

private static final String routeAnyMatchValue

See Also:

Constant Field Values

routePropertyNameValue

private static final String routePropertyNameValue

See Also:

Constant Field Values

startsWithValue

private static final String startsWithValue

See Also:

Constant Field Values

endsWithValue

private static final String endsWithValue

See Also:

Constant Field Values

containsValue

private static final String containsValue

See Also:

Constant Field Values

equalsValue

private static final String equalsValue

See Also:

Constant Field Values

matchesRegularExpressionValue

private static final String matchesRegularExpressionValue

See Also:

Constant Field Values

containsRegularExpressionValue

private static final String containsRegularExpressionValue

See Also:

Constant Field Values

satisfiesExpression

private static final String satisfiesExpression

See Also:

Constant Field Values

ROUTE_TO_MATCHING_PROPERTY_NAME

public static final AllowableValue ROUTE_TO_MATCHING_PROPERTY_NAME

ROUTE_TO_MATCHED_WHEN_ALL_PROPERTIES_MATCH

public static final AllowableValue ROUTE_TO_MATCHED_WHEN_ALL_PROPERTIES_MATCH

ROUTE_TO_MATCHED_WHEN_ANY_PROPERTY_MATCHES

public static final AllowableValue ROUTE_TO_MATCHED_WHEN_ANY_PROPERTY_MATCHES

STARTS_WITH

public static final AllowableValue STARTS_WITH

ENDS_WITH

public static final AllowableValue ENDS_WITH

CONTAINS

public static final AllowableValue CONTAINS

EQUALS

public static final AllowableValue EQUALS

MATCHES_REGULAR_EXPRESSION

public static final AllowableValue MATCHES_REGULAR_EXPRESSION

CONTAINS_REGULAR_EXPRESSION

public static final AllowableValue CONTAINS_REGULAR_EXPRESSION

SATISFIES_EXPRESSION

public static final AllowableValue SATISFIES_EXPRESSION

ROUTE_STRATEGY

public static final PropertyDescriptor ROUTE_STRATEGY

MATCH_STRATEGY

public static final PropertyDescriptor MATCH_STRATEGY

TRIM_WHITESPACE

public static final PropertyDescriptor TRIM_WHITESPACE

IGNORE_CASE

static final PropertyDescriptor IGNORE_CASE

GROUPING_REGEX

static final PropertyDescriptor GROUPING_REGEX

CHARACTER_SET

public static final PropertyDescriptor CHARACTER_SET

REL_ORIGINAL

public static final Relationship REL_ORIGINAL

REL_NO_MATCH

public static final Relationship REL_NO_MATCH

REL_MATCH

public static final Relationship REL_MATCH

EMPTY_GROUP

private static RouteText.Group EMPTY_GROUP

relationships

private AtomicReference<Set<Relationship>> relationships

properties

private List<PropertyDescriptor> properties

configuredRouteStrategy

private volatile String configuredRouteStrategy

dynamicPropertyNames

private volatile Set<String> dynamicPropertyNames

propertyMap

private volatile Map<Relationship,PropertyValue> propertyMap

Cache of dynamic properties set during onScheduled(ProcessContext) for quick access in onTrigger(ProcessContext, ProcessSession)

groupingRegex

private volatile Pattern groupingRegex

Constructor Detail

RouteText

public RouteText()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

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

onPropertyModified

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

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractConfigurableComponent

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)

When this processor is scheduled, update the dynamic properties into the map for quick access during each onTrigger call

Parameters:

context - ProcessContext used to retrieve dynamic properties

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)

Specified by:

onTrigger in class AbstractProcessor

getGroup

private RouteText.Group getGroup(String line,
                                 Pattern groupPattern)

appendLine

private void appendLine(ProcessSession session,
                        Map<Relationship,Map<RouteText.Group,FlowFile>> flowFileMap,
                        Relationship relationship,
                        FlowFile original,
                        String line,
                        Charset charset,
                        RouteText.Group group)

lineMatches

protected static boolean lineMatches(String line,
                                     Object comparison,
                                     String matchingStrategy,
                                     boolean ignoreCase,
                                     FlowFile flowFile,
                                     Map<String,String> variables)