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
static PropertyDescriptor	DELETE_ATTRIBUTES
static java.lang.String	DELETE_ATTRIBUTES_EXPRESSION_NAME
static java.lang.String	DO_NOT_STORE_STATE
static Relationship	REL_FAILED_SET_STATE
static Relationship	REL_SUCCESS
static PropertyDescriptor	STATEFUL_VARIABLES_INIT_VALUE
static java.lang.String	STATEFUL_VARIABLES_INIT_VALUE_NAME
static PropertyDescriptor	STORE_STATE
static java.lang.String	STORE_STATE_LOCALLY
static java.lang.String	STORE_STATE_NAME

Constructor Summary

Constructors

Constructor and Description
UpdateAttribute()

Method Summary

Modifier and Type	Method and Description
protected java.util.Collection<ValidationResult>	customValidate(ValidationContext context) Allows subclasses to perform their own validation on the already set properties.
java.util.Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(java.lang.String propertyDescriptorName) Used to allow subclasses to determine what PropertyDescriptor if any to use when a property is requested for which a descriptor is not already registered.
protected java.util.List<PropertyDescriptor>	getSupportedPropertyDescriptors() Allows subclasses to register which property descriptor objects are supported.
void	onPropertyModified(PropertyDescriptor descriptor, java.lang.String oldValue, java.lang.String newValue) Hook method allowing subclasses to eagerly react to a configuration change for the given property descriptor.
void	onScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)
java.util.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 java.lang.String DO_NOT_STORE_STATE

See Also:

Constant Field Values

STORE_STATE_LOCALLY

public static final java.lang.String STORE_STATE_LOCALLY

See Also:

Constant Field Values

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILED_SET_STATE

public static final Relationship REL_FAILED_SET_STATE

DELETE_ATTRIBUTES_EXPRESSION_NAME

public static final java.lang.String DELETE_ATTRIBUTES_EXPRESSION_NAME

See Also:

Constant Field Values

DELETE_ATTRIBUTES

public static final PropertyDescriptor DELETE_ATTRIBUTES

STORE_STATE_NAME

public static final java.lang.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 java.lang.String STATEFUL_VARIABLES_INIT_VALUE_NAME

See Also:

Constant Field Values

STATEFUL_VARIABLES_INIT_VALUE

public static final PropertyDescriptor STATEFUL_VARIABLES_INIT_VALUE

Constructor Detail

UpdateAttribute

public UpdateAttribute()

Method Detail

getRelationships

public java.util.Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

Returns:

Set of all relationships this processor expects to transfer a flow file to. An empty set indicates this processor does not have any destination relationships. Guaranteed non null.

getSupportedPropertyDescriptors

protected java.util.List<PropertyDescriptor> getSupportedPropertyDescriptors()

Description copied from class: AbstractConfigurableComponent

Allows subclasses to register which property descriptor objects are supported. Default return is an empty set.

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

Returns:

PropertyDescriptor objects this processor currently supports

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(java.lang.String propertyDescriptorName)

Description copied from class: AbstractConfigurableComponent

Used to allow subclasses to determine what PropertyDescriptor if any to use when a property is requested for which a descriptor is not already registered. By default this method simply returns a null descriptor. By overriding this method processor implementations can support dynamic properties since this allows them to register properties on demand. It is acceptable for a dynamically generated property to indicate it is required so long as it is understood it is only required once set. Dynamic properties by definition cannot be required until used.

This method should be side effect free in the subclasses in terms of how often it is called for a given property name because there is guarantees how often it will be called for a given property name.

Default is null.

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

Parameters:

propertyDescriptorName - used to lookup if any property descriptors exist for that name

Returns:

new property descriptor if supported

onPropertyModified

public void onPropertyModified(PropertyDescriptor descriptor,
                               java.lang.String oldValue,
                               java.lang.String newValue)

Description copied from class: AbstractConfigurableComponent

Hook method allowing subclasses to eagerly react to a configuration change for the given property descriptor. As an alternative to using this method a processor may simply get the latest value whenever it needs it and if necessary lazily evaluate it.

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractConfigurableComponent

Parameters:

descriptor - of the modified property

oldValue - non-null property value (previous)

newValue - the new property value or if null indicates the property was removed

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)
                              throws java.io.IOException

Throws:

java.io.IOException

customValidate

protected java.util.Collection<ValidationResult> customValidate(ValidationContext context)

Description copied from class: AbstractConfigurableComponent

Allows subclasses to perform their own validation on the already set properties. Since each property is validated as it is set this allows validation of groups of properties together. Default return is an empty set. This method will be called only when it has been determined that all property values are valid according to their corresponding PropertyDescriptor's validators.

Overrides:

customValidate in class AbstractConfigurableComponent

Parameters:

context - provides a mechanism for obtaining externally managed values, such as property values and supplies convenience methods for operating on those values

Returns:

Collection of ValidationResult objects that will be added to any other validation findings - may be null

search

public java.util.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