org.apache.nifi.processors.standard

Class DebugFlow

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.DebugFlow

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @Tags(value={"test","debug","processor","utility","flow","FlowFile"})
 @CapabilityDescription(value="The DebugFlow processor aids testing and debugging the FlowFile framework by allowing various responses to be explicitly triggered in response to the receipt of a FlowFile or a timer event without a FlowFile if using timer or cron based scheduling.  It can force responses needed to exercise or test various failure modes that can occur when a processor runs.")
public class DebugFlow
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	DebugFlow.FlowFileResponse
private static class	DebugFlow.FlowFileResponseState
private class	DebugFlow.NoFlowFileResponse
private static class	DebugFlow.NoFlowFileResponseState
private static class	DebugFlow.RuntimeExceptionValidator

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static PropertyDescriptor	CONTENT_SIZE
private DebugFlow.FlowFileResponse	curr_ff_resp
private DebugFlow.NoFlowFileResponse	curr_noff_resp
(package private) static PropertyDescriptor	CUSTOM_VALIDATE_SLEEP_TIME
(package private) static PropertyDescriptor	FF_EXCEPTION_CLASS
(package private) static PropertyDescriptor	FF_EXCEPTION_ITERATIONS
(package private) static PropertyDescriptor	FF_FAILURE_ITERATIONS
(package private) static PropertyDescriptor	FF_ROLLBACK_ITERATIONS
(package private) static PropertyDescriptor	FF_ROLLBACK_PENALTY_ITERATIONS
(package private) static PropertyDescriptor	FF_ROLLBACK_YIELD_ITERATIONS
(package private) static PropertyDescriptor	FF_SUCCESS_ITERATIONS
private Integer	flowFileCurrException
private Integer	flowFileCurrFailure
private Integer	flowFileCurrPenalty
private Integer	flowFileCurrRollback
private Integer	flowFileCurrSuccess
private Integer	flowFileCurrYield
private Class<? extends RuntimeException>	flowFileExceptionClass
private Integer	flowFileMaxException
private Integer	flowFileMaxFailure
private Integer	flowFileMaxPenalty
private Integer	flowFileMaxRollback
private Integer	flowFileMaxSuccess
private Integer	flowFileMaxYield
(package private) static PropertyDescriptor	IGNORE_INTERRUPTS
(package private) static PropertyDescriptor	NO_FF_EXCEPTION_CLASS
(package private) static PropertyDescriptor	NO_FF_EXCEPTION_ITERATIONS
(package private) static PropertyDescriptor	NO_FF_SKIP_ITERATIONS
(package private) static PropertyDescriptor	NO_FF_YIELD_ITERATIONS
private Integer	noFlowFileCurrException
private Integer	noFlowFileCurrSkip
private Integer	noFlowFileCurrYield
private Class<? extends RuntimeException>	noFlowFileExceptionClass
private Integer	noFlowFileMaxException
private Integer	noFlowFileMaxSkip
private Integer	noFlowFileMaxYield
(package private) static PropertyDescriptor	ON_SCHEDULED_FAIL
(package private) static PropertyDescriptor	ON_SCHEDULED_SLEEP_TIME
(package private) static PropertyDescriptor	ON_STOPPED_FAIL
(package private) static PropertyDescriptor	ON_STOPPED_SLEEP_TIME
(package private) static PropertyDescriptor	ON_TRIGGER_SLEEP_TIME
(package private) static PropertyDescriptor	ON_UNSCHEDULED_FAIL
(package private) static PropertyDescriptor	ON_UNSCHEDULED_SLEEP_TIME
private AtomicReference<List<PropertyDescriptor>>	propertyDescriptors
(package private) static Relationship	REL_FAILURE
(package private) static Relationship	REL_SUCCESS
private AtomicReference<Set<Relationship>>	relationships
(package private) static PropertyDescriptor	WRITE_ITERATIONS

Constructor Summary

Constructors

Constructor and Description
DebugFlow()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
private void	fail(boolean isAppropriate, Class<?> annotationClass)
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onScheduled(ProcessContext context)
void	onStopped(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)
void	onUnscheduled(ProcessContext context)
private void	sleep(long millis, boolean ignoreInterrupts)

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

relationships

private final AtomicReference<Set<Relationship>> relationships

REL_SUCCESS

static final Relationship REL_SUCCESS

REL_FAILURE

static final Relationship REL_FAILURE

propertyDescriptors

private final AtomicReference<List<PropertyDescriptor>> propertyDescriptors

FF_SUCCESS_ITERATIONS

static final PropertyDescriptor FF_SUCCESS_ITERATIONS

FF_FAILURE_ITERATIONS

static final PropertyDescriptor FF_FAILURE_ITERATIONS

FF_ROLLBACK_ITERATIONS

static final PropertyDescriptor FF_ROLLBACK_ITERATIONS

FF_ROLLBACK_YIELD_ITERATIONS

static final PropertyDescriptor FF_ROLLBACK_YIELD_ITERATIONS

FF_ROLLBACK_PENALTY_ITERATIONS

static final PropertyDescriptor FF_ROLLBACK_PENALTY_ITERATIONS

FF_EXCEPTION_ITERATIONS

static final PropertyDescriptor FF_EXCEPTION_ITERATIONS

FF_EXCEPTION_CLASS

static final PropertyDescriptor FF_EXCEPTION_CLASS

NO_FF_SKIP_ITERATIONS

static final PropertyDescriptor NO_FF_SKIP_ITERATIONS

NO_FF_EXCEPTION_ITERATIONS

static final PropertyDescriptor NO_FF_EXCEPTION_ITERATIONS

NO_FF_YIELD_ITERATIONS

static final PropertyDescriptor NO_FF_YIELD_ITERATIONS

NO_FF_EXCEPTION_CLASS

static final PropertyDescriptor NO_FF_EXCEPTION_CLASS

WRITE_ITERATIONS

static final PropertyDescriptor WRITE_ITERATIONS

CONTENT_SIZE

static final PropertyDescriptor CONTENT_SIZE

ON_SCHEDULED_SLEEP_TIME

static final PropertyDescriptor ON_SCHEDULED_SLEEP_TIME

ON_SCHEDULED_FAIL

static final PropertyDescriptor ON_SCHEDULED_FAIL

ON_UNSCHEDULED_SLEEP_TIME

static final PropertyDescriptor ON_UNSCHEDULED_SLEEP_TIME

ON_UNSCHEDULED_FAIL

static final PropertyDescriptor ON_UNSCHEDULED_FAIL

ON_STOPPED_SLEEP_TIME

static final PropertyDescriptor ON_STOPPED_SLEEP_TIME

ON_STOPPED_FAIL

static final PropertyDescriptor ON_STOPPED_FAIL

ON_TRIGGER_SLEEP_TIME

static final PropertyDescriptor ON_TRIGGER_SLEEP_TIME

CUSTOM_VALIDATE_SLEEP_TIME

static final PropertyDescriptor CUSTOM_VALIDATE_SLEEP_TIME

IGNORE_INTERRUPTS

static final PropertyDescriptor IGNORE_INTERRUPTS

flowFileMaxSuccess

private volatile Integer flowFileMaxSuccess

flowFileMaxFailure

private volatile Integer flowFileMaxFailure

flowFileMaxRollback

private volatile Integer flowFileMaxRollback

flowFileMaxYield

private volatile Integer flowFileMaxYield

flowFileMaxPenalty

private volatile Integer flowFileMaxPenalty

flowFileMaxException

private volatile Integer flowFileMaxException

noFlowFileMaxSkip

private volatile Integer noFlowFileMaxSkip

noFlowFileMaxException

private volatile Integer noFlowFileMaxException

noFlowFileMaxYield

private volatile Integer noFlowFileMaxYield

flowFileCurrSuccess

private volatile Integer flowFileCurrSuccess

flowFileCurrFailure

private volatile Integer flowFileCurrFailure

flowFileCurrRollback

private volatile Integer flowFileCurrRollback

flowFileCurrYield

private volatile Integer flowFileCurrYield

flowFileCurrPenalty

private volatile Integer flowFileCurrPenalty

flowFileCurrException

private volatile Integer flowFileCurrException

noFlowFileCurrSkip

private volatile Integer noFlowFileCurrSkip

noFlowFileCurrException

private volatile Integer noFlowFileCurrException

noFlowFileCurrYield

private volatile Integer noFlowFileCurrYield

flowFileExceptionClass

private volatile Class<? extends RuntimeException> flowFileExceptionClass

noFlowFileExceptionClass

private volatile Class<? extends RuntimeException> noFlowFileExceptionClass

curr_ff_resp

private final DebugFlow.FlowFileResponse curr_ff_resp

curr_noff_resp

private final DebugFlow.NoFlowFileResponse curr_noff_resp

Constructor Detail

DebugFlow

public DebugFlow()

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

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)
                              throws ClassNotFoundException,
                                     InterruptedException

Throws:

ClassNotFoundException

InterruptedException

onUnscheduled

@OnUnscheduled
public void onUnscheduled(ProcessContext context)
                                  throws InterruptedException

Throws:

InterruptedException

onStopped

@OnStopped
public void onStopped(ProcessContext context)
                          throws InterruptedException

Throws:

InterruptedException

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

sleep

private void sleep(long millis,
                   boolean ignoreInterrupts)
            throws InterruptedException

Throws:

InterruptedException

fail

private void fail(boolean isAppropriate,
                  Class<?> annotationClass)

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException