org.apache.nifi.processors.attributes

Class UpdateAttribute

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.attributes.UpdateAttribute

All Implemented Interfaces:

ConfigurableComponent, Processor, Searchable

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"attributes","modification","update","delete","Attribute Expression Language","state"})
 @CapabilityDescription(value="Updates the Attributes for a FlowFile by using the Attribute Expression Language and/or deletes the attributes based on a regular expression")
 @DynamicProperty(name="A FlowFile attribute to update",
                 value="The value to set it to",
                 supportsExpressionLanguage=true,
                 description="Updates a FlowFile attribute specified by the Dynamic Property\'s key with the value specified by the Dynamic Property\'s value")
 @WritesAttribute(attribute="See additional details",
                 description="This processor may write or remove zero or more attributes as described in additional details")
 @Stateful(scopes=LOCAL,
          description="Gives the option to store values not only on the FlowFile but as stateful variables to be referenced in a recursive manner.")
public class UpdateAttribute
extends AbstractProcessor
implements Searchable

Field Summary

Fields

Modifier and Type	Field and Description
private AtomicReference<Criteria>	criteriaCache
private boolean	debugEnabled
private Map<String,Action>	defaultActions
static PropertyDescriptor	DELETE_ATTRIBUTES
static String	DELETE_ATTRIBUTES_EXPRESSION_NAME
private static Validator	DELETE_PROPERTY_VALIDATOR
static String	DO_NOT_STORE_STATE
private ConcurrentMap<String,PropertyValue>	propertyValues
static Relationship	REL_FAILED_SET_STATE
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships
private boolean	stateful
static PropertyDescriptor	STATEFUL_VARIABLES_INIT_VALUE
static String	STATEFUL_VARIABLES_INIT_VALUE_NAME
private static Set<Relationship>	statefulRelationshipSet
private static Set<Relationship>	statelessRelationshipSet
static PropertyDescriptor	STORE_STATE
static String	STORE_STATE_LOCALLY
static String	STORE_STATE_NAME

Constructor Summary

Constructors

Constructor and Description
UpdateAttribute()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext context)
private boolean	evaluateCondition(ProcessContext context, Condition condition, FlowFile flowfile, Map<String,String> statefulAttributes)
private boolean	evaluateCriteria(ProcessSession session, ProcessContext context, Criteria criteria, FlowFile flowfile, Map<FlowFile,List<Rule>> matchedRules, Map<String,String> statefulAttributes)
private boolean	evaluateRule(ProcessContext context, Rule rule, FlowFile flowfile, Map<String,String> statefulAttributes)
private FlowFile	executeActions(ProcessSession session, ProcessContext context, List<Rule> rules, Map<String,Action> defaultActions, FlowFile flowfile, Map<String,String> stateInitialAttributes, Map<String,String> stateWorkingAttributes)
private Map<String,Action>	getDefaultActions(Map<PropertyDescriptor,String> properties)
private PropertyValue	getPropertyValue(String text, ProcessContext context)
Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onPropertyModified(PropertyDescriptor descriptor, String oldValue, String newValue)
void	onScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)
Collection<SearchResult>	search(SearchContext context)

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

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

DO_NOT_STORE_STATE

public static final String DO_NOT_STORE_STATE

See Also:

Constant Field Values

STORE_STATE_LOCALLY

public static final String STORE_STATE_LOCALLY

See Also:

Constant Field Values

criteriaCache

private final AtomicReference<Criteria> criteriaCache

propertyValues

private final ConcurrentMap<String,PropertyValue> propertyValues

statelessRelationshipSet

private static final Set<Relationship> statelessRelationshipSet

statefulRelationshipSet

private static final Set<Relationship> statefulRelationshipSet

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILED_SET_STATE

public static final Relationship REL_FAILED_SET_STATE

relationships

private volatile Set<Relationship> relationships

DELETE_PROPERTY_VALIDATOR

private static final Validator DELETE_PROPERTY_VALIDATOR

DELETE_ATTRIBUTES_EXPRESSION_NAME

public static final String DELETE_ATTRIBUTES_EXPRESSION_NAME

See Also:

Constant Field Values

DELETE_ATTRIBUTES

public static final PropertyDescriptor DELETE_ATTRIBUTES

STORE_STATE_NAME

public static final String STORE_STATE_NAME

See Also:

Constant Field Values

STORE_STATE

public static final PropertyDescriptor STORE_STATE

STATEFUL_VARIABLES_INIT_VALUE_NAME

public static final String STATEFUL_VARIABLES_INIT_VALUE_NAME

See Also:

Constant Field Values

STATEFUL_VARIABLES_INIT_VALUE

public static final PropertyDescriptor STATEFUL_VARIABLES_INIT_VALUE

defaultActions

private volatile Map<String,Action> defaultActions

debugEnabled

private volatile boolean debugEnabled

stateful

private volatile boolean stateful

Constructor Detail

UpdateAttribute

public UpdateAttribute()

Method Detail

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)
                              throws IOException

Throws:

IOException

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext context)

Overrides:

customValidate in class AbstractConfigurableComponent

search

public Collection<SearchResult> search(SearchContext context)

Specified by:

search in interface Searchable

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)

Specified by:

onTrigger in class AbstractProcessor

evaluateCriteria

private boolean evaluateCriteria(ProcessSession session,
                                 ProcessContext context,
                                 Criteria criteria,
                                 FlowFile flowfile,
                                 Map<FlowFile,List<Rule>> matchedRules,
                                 Map<String,String> statefulAttributes)

evaluateRule

private boolean evaluateRule(ProcessContext context,
                             Rule rule,
                             FlowFile flowfile,
                             Map<String,String> statefulAttributes)

getPropertyValue

private PropertyValue getPropertyValue(String text,
                                       ProcessContext context)

evaluateCondition

private boolean evaluateCondition(ProcessContext context,
                                  Condition condition,
                                  FlowFile flowfile,
                                  Map<String,String> statefulAttributes)

executeActions

private FlowFile executeActions(ProcessSession session,
                                ProcessContext context,
                                List<Rule> rules,
                                Map<String,Action> defaultActions,
                                FlowFile flowfile,
                                Map<String,String> stateInitialAttributes,
                                Map<String,String> stateWorkingAttributes)

getDefaultActions

private Map<String,Action> getDefaultActions(Map<PropertyDescriptor,String> properties)