org.apache.nifi.processors.standard

Class RouteOnAttribute

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.RouteOnAttribute

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"attributes","routing","Attribute Expression Language","regexp","regex","Regular Expression","Expression Language","find","text","string","search","filter","detect"})
 @CapabilityDescription(value="Routes FlowFiles based on their Attributes using the Attribute Expression Language")
 @DynamicProperty(name="Relationship Name",
                 value="Attribute Expression Language",
                 expressionLanguageScope=FLOWFILE_ATTRIBUTES,
                 description="Routes FlowFiles whose attributes match the Attribute Expression Language 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 Attribute Expression Language")
 @WritesAttributes(value=@WritesAttribute(attribute="RouteOnAttribute.Route",description="The relation to which the FlowFile was routed"))
public class RouteOnAttribute
extends AbstractProcessor

This processor routes a FlowFile based on its flow file attributes by using the Attribute Expression Language. The Expression Language is used by adding Optional Properties to the processor. The name of the Property indicates the name of the relationship to which a FlowFile will be routed if matched. The value of the Property indicates an Attribute Expression Language Expression that will be used to determine whether or not a given FlowFile will be routed to the associated relationship. If multiple expressions match a FlowFile's attributes, that FlowFile will be cloned and routed to each corresponding relationship. If none of the supplied expressions matches for a given FlowFile, that FlowFile will be routed to the 'unmatched' relationship.

Field Summary

Fields

Modifier and Type	Field and Description
private String	configuredRouteStrategy
private Set<String>	dynamicPropertyNames
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
private AtomicReference<Set<Relationship>>	relationships
static AllowableValue	ROUTE_ALL_MATCH
static AllowableValue	ROUTE_ANY_MATCHES
static String	ROUTE_ATTRIBUTE_KEY
static AllowableValue	ROUTE_PROPERTY_NAME
static PropertyDescriptor	ROUTE_STRATEGY
private static String	routeAllMatchValue
private static String	routeAnyMatches
private static String	routePropertyNameValue

Constructor Summary

Constructors

Constructor and Description
RouteOnAttribute()

Method Summary

Modifier and Type	Method and Description
Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
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

customValidate, 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

routeAllMatchValue

private static final String routeAllMatchValue

See Also:

Constant Field Values

routeAnyMatches

private static final String routeAnyMatches

See Also:

Constant Field Values

routePropertyNameValue

private static final String routePropertyNameValue

See Also:

Constant Field Values

ROUTE_PROPERTY_NAME

public static final AllowableValue ROUTE_PROPERTY_NAME

ROUTE_ALL_MATCH

public static final AllowableValue ROUTE_ALL_MATCH

ROUTE_ANY_MATCHES

public static final AllowableValue ROUTE_ANY_MATCHES

ROUTE_STRATEGY

public static final PropertyDescriptor ROUTE_STRATEGY

REL_NO_MATCH

public static final Relationship REL_NO_MATCH

REL_MATCH

public static final Relationship REL_MATCH

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)

Constructor Detail

RouteOnAttribute

public RouteOnAttribute()

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

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)

Specified by:

onTrigger in class AbstractProcessor