org.apache.nifi.processors.standard

Class SplitContent

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.SplitContent

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @Tags(value={"content","split","binary"})
 @InputRequirement(value=INPUT_REQUIRED)
 @CapabilityDescription(value="Splits incoming FlowFiles by a specified byte sequence")
 @WritesAttribute(attribute="fragment.identifier",description="All split FlowFiles produced from the same parent FlowFile will have the same randomly generated UUID added for this attribute") @WritesAttribute(attribute="fragment.index",description="A one-up number that indicates the ordering of the split FlowFiles that were created from a single parent FlowFile") @WritesAttribute(attribute="fragment.count",description="The number of split FlowFiles generated from the parent FlowFile") @WritesAttribute(attribute="segment.original.filename ",description="The filename of the parent FlowFile")
 @SeeAlso(value=MergeContent.class)
 @SystemResourceConsideration(resource=MEMORY,
                             description="The FlowFile with its attributes is stored in memory, not the content of the FlowFile. If many splits are generated due to the size of the content, or how the content is configured to be split, a two-phase approach may be necessary to avoid excessive use of memory.")
public class SplitContent
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	SplitContent.HexStringPropertyValidator

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	BYTE_SEQUENCE
static PropertyDescriptor	BYTE_SEQUENCE_LOCATION
private AtomicReference<byte[]>	byteSequence
static PropertyDescriptor	FORMAT
static String	FRAGMENT_COUNT
static String	FRAGMENT_ID
static String	FRAGMENT_INDEX
(package private) static AllowableValue	HEX_FORMAT
static PropertyDescriptor	KEEP_SEQUENCE
(package private) static AllowableValue	LEADING_POSITION
private List<PropertyDescriptor>	properties
static Relationship	REL_ORIGINAL
static Relationship	REL_SPLITS
private Set<Relationship>	relationships
static String	SEGMENT_ORIGINAL_FILENAME
(package private) static AllowableValue	TRAILING_POSITION
(package private) static AllowableValue	UTF8_FORMAT

Constructor Summary

Constructors

Constructor and Description
SplitContent()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
private String	finishFragmentAttributes(ProcessSession session, FlowFile source, List<FlowFile> splits) Apply split index, count and other attributes.
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
void	initializeByteSequence(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, 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.processor.Processor

isStateful

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

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

FRAGMENT_ID

public static final String FRAGMENT_ID

FRAGMENT_INDEX

public static final String FRAGMENT_INDEX

FRAGMENT_COUNT

public static final String FRAGMENT_COUNT

SEGMENT_ORIGINAL_FILENAME

public static final String SEGMENT_ORIGINAL_FILENAME

HEX_FORMAT

static final AllowableValue HEX_FORMAT

UTF8_FORMAT

static final AllowableValue UTF8_FORMAT

TRAILING_POSITION

static final AllowableValue TRAILING_POSITION

LEADING_POSITION

static final AllowableValue LEADING_POSITION

FORMAT

public static final PropertyDescriptor FORMAT

BYTE_SEQUENCE

public static final PropertyDescriptor BYTE_SEQUENCE

KEEP_SEQUENCE

public static final PropertyDescriptor KEEP_SEQUENCE

BYTE_SEQUENCE_LOCATION

public static final PropertyDescriptor BYTE_SEQUENCE_LOCATION

REL_SPLITS

public static final Relationship REL_SPLITS

REL_ORIGINAL

public static final Relationship REL_ORIGINAL

relationships

private Set<Relationship> relationships

properties

private List<PropertyDescriptor> properties

byteSequence

private final AtomicReference<byte[]> byteSequence

Constructor Detail

SplitContent

public SplitContent()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

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

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

initializeByteSequence

@OnScheduled
public void initializeByteSequence(ProcessContext context)
                                         throws org.apache.commons.codec.DecoderException

Throws:

org.apache.commons.codec.DecoderException

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)

Specified by:

onTrigger in class AbstractProcessor

finishFragmentAttributes

private String finishFragmentAttributes(ProcessSession session,
                                        FlowFile source,
                                        List<FlowFile> splits)

Apply split index, count and other attributes.

Parameters:

session - session

source - source

splits - splits

Returns:

generated fragment identifier for the splits