org.apache.nifi.processors.standard

Class RetryFlowFile

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.RetryFlowFile

All Implemented Interfaces:

ConfigurableComponent, Processor

@Tags(value={"Retry","FlowFile"})
 @CapabilityDescription(value="FlowFiles passed to this Processor have a \'Retry Attribute\' value checked against a configured \'Maximum Retries\' value. If the current attribute value is below the configured maximum, the FlowFile is passed to a retry relationship. The FlowFile may or may not be penalized in that condition. If the FlowFile\'s attribute value exceeds the configured maximum, the FlowFile will be passed to a \'retries_exceeded\' relationship. WARNING: If the incoming FlowFile has a non-numeric value in the configured \'Retry Attribute\' attribute, it will be reset to \'1\'. You may choose to fail the FlowFile instead of performing the reset. Additional dynamic properties can be defined for any attributes you wish to add to the FlowFiles transferred to \'retries_exceeded\'. These attributes support attribute expression language.")
 @InputRequirement(value=INPUT_REQUIRED)
 @SupportsBatching
 @SideEffectFree
 @ReadsAttribute(attribute="Retry Attribute",
                description="Will read the attribute or attribute expression language result as defined in \'Retry Attribute\'")
 @WritesAttribute(attribute="Retry Attribute",description="User defined retry attribute is updated with the current retry count") @WritesAttribute(attribute="Retry Attribute .uuid",description="User defined retry attribute with .uuid that determines what processor retried the FlowFile last")
 @DynamicProperty(name="Exceeded FlowFile Attribute Key",
                 value="The value of the attribute added to the FlowFile",
                 description="One or more dynamic properties can be used to add attributes to FlowFiles passed to the \'retries_exceeded\' relationship",
                 expressionLanguageScope=FLOWFILE_ATTRIBUTES)
public class RetryFlowFile
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	FAIL_ON_OVERWRITE
static AllowableValue	FAIL_ON_REUSE
private Boolean	failOnOverwrite
static Relationship	FAILURE
private String	lastRetriedBy
static PropertyDescriptor	MAXIMUM_RETRIES
static PropertyDescriptor	PENALIZE_RETRIED
private Boolean	penalizeRetried
private List<PropertyDescriptor>	properties
private Set<Relationship>	relationships
static AllowableValue	RESET_ON_REUSE
static Relationship	RETRIES_EXCEEDED
static Relationship	RETRY
static PropertyDescriptor	RETRY_ATTRIBUTE
private String	retryAttribute
static PropertyDescriptor	REUSE_MODE
private String	reuseMode
static AllowableValue	WARN_ON_REUSE

Constructor Summary

Constructors

Constructor and Description
RetryFlowFile()

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	onScheduled(ProcessContext context)
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, onPropertyModified, 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, onPropertyModified, validate

Field Detail

properties

private List<PropertyDescriptor> properties

relationships

private Set<Relationship> relationships

retryAttribute

private String retryAttribute

penalizeRetried

private Boolean penalizeRetried

failOnOverwrite

private Boolean failOnOverwrite

reuseMode

private String reuseMode

lastRetriedBy

private String lastRetriedBy

RETRY_ATTRIBUTE

public static final PropertyDescriptor RETRY_ATTRIBUTE

MAXIMUM_RETRIES

public static final PropertyDescriptor MAXIMUM_RETRIES

PENALIZE_RETRIED

public static final PropertyDescriptor PENALIZE_RETRIED

FAIL_ON_OVERWRITE

public static final PropertyDescriptor FAIL_ON_OVERWRITE

FAIL_ON_REUSE

public static final AllowableValue FAIL_ON_REUSE

WARN_ON_REUSE

public static final AllowableValue WARN_ON_REUSE

RESET_ON_REUSE

public static final AllowableValue RESET_ON_REUSE

REUSE_MODE

public static final PropertyDescriptor REUSE_MODE

RETRY

public static final Relationship RETRY

RETRIES_EXCEEDED

public static final Relationship RETRIES_EXCEEDED

FAILURE

public static final Relationship FAILURE

Constructor Detail

RetryFlowFile

public RetryFlowFile()

Method Detail

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException