org.apache.nifi.processors.standard

Class GenerateFlowFile

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.GenerateFlowFile

All Implemented Interfaces:

ConfigurableComponent, Processor

@SupportsBatching
 @Tags(value={"test","random","generate","load"})
 @InputRequirement(value=INPUT_FORBIDDEN)
 @CapabilityDescription(value="This processor creates FlowFiles with random data or custom content. GenerateFlowFile is useful for load testing, configuration, and simulation. Also see DuplicateFlowFile for additional load testing.")
 @DynamicProperty(name="Generated FlowFile attribute name",
                 value="Generated FlowFile attribute value",
                 expressionLanguageScope=VARIABLE_REGISTRY,
                 description="Specifies an attribute on generated FlowFiles defined by the Dynamic Property\'s key and value. If Expression Language is used, evaluation will be performed only once per batch of generated FlowFiles.")
 @DefaultSchedule(strategy=TIMER_DRIVEN,
                 period="1 min")
public class GenerateFlowFile
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	BATCH_SIZE
static PropertyDescriptor	CHARSET
static PropertyDescriptor	CUSTOM_TEXT
private AtomicReference<byte[]>	data
static PropertyDescriptor	DATA_FORMAT
static String	DATA_FORMAT_BINARY
static String	DATA_FORMAT_TEXT
private List<PropertyDescriptor>	descriptors
static PropertyDescriptor	FILE_SIZE
static PropertyDescriptor	MIME_TYPE
private Set<Relationship>	relationships
static Relationship	SUCCESS
private static char[]	TEXT_CHARS
static PropertyDescriptor	UNIQUE_FLOWFILES

Constructor Summary

Constructors

Constructor and Description
GenerateFlowFile()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
private byte[]	generateData(ProcessContext context)
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

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.processor.Processor

isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

data

private final AtomicReference<byte[]> data

DATA_FORMAT_BINARY

public static final String DATA_FORMAT_BINARY

See Also:

Constant Field Values

DATA_FORMAT_TEXT

public static final String DATA_FORMAT_TEXT

See Also:

Constant Field Values

FILE_SIZE

public static final PropertyDescriptor FILE_SIZE

BATCH_SIZE

public static final PropertyDescriptor BATCH_SIZE

DATA_FORMAT

public static final PropertyDescriptor DATA_FORMAT

UNIQUE_FLOWFILES

public static final PropertyDescriptor UNIQUE_FLOWFILES

CUSTOM_TEXT

public static final PropertyDescriptor CUSTOM_TEXT

CHARSET

public static final PropertyDescriptor CHARSET

MIME_TYPE

public static final PropertyDescriptor MIME_TYPE

SUCCESS

public static final Relationship SUCCESS

descriptors

private List<PropertyDescriptor> descriptors

relationships

private Set<Relationship> relationships

TEXT_CHARS

private static final char[] TEXT_CHARS

Constructor Detail

GenerateFlowFile

public GenerateFlowFile()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

generateData

private byte[] generateData(ProcessContext context)

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)

Specified by:

onTrigger in class AbstractProcessor