org.apache.nifi.processors.standard

Class SplitJson

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.AbstractJsonPathProcessor

org.apache.nifi.processors.standard.SplitJson

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @Tags(value={"json","split","jsonpath"})
 @InputRequirement(value=INPUT_REQUIRED)
 @CapabilityDescription(value="Splits a JSON File into multiple, separate FlowFiles for an array element specified by a JsonPath expression. Each generated FlowFile is comprised of an element of the specified array and transferred to relationship \'split,\' with the original file transferred to the \'original\' relationship. If the specified JsonPath is not found or does not evaluate to an array element, the original file is routed to \'failure\' and no files are generated.")
 @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")
 @SystemResourceConsideration(resource=MEMORY,
                             description="The entirety of the FlowFile\'s content (as a JsonNode object) is read into memory, in addition to all of the generated FlowFiles representing the split JSON. If many splits are generated due to the size of the JSON, or how the JSON is configured to be split, a two-phase approach may be necessary to avoid excessive use of memory.")
public class SplitJson
extends AbstractJsonPathProcessor

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.nifi.processors.standard.AbstractJsonPathProcessor

AbstractJsonPathProcessor.JsonPathValidator

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	ARRAY_JSON_PATH_EXPRESSION
private AtomicReference<com.jayway.jsonpath.JsonPath>	JSON_PATH_REF
private String	nullDefaultValue
private List<PropertyDescriptor>	properties
static Relationship	REL_FAILURE
static Relationship	REL_ORIGINAL
static Relationship	REL_SPLIT
private Set<Relationship>	relationships

Fields inherited from class org.apache.nifi.processors.standard.AbstractJsonPathProcessor

EMPTY_STRING_OPTION, NULL_REPRESENTATION_MAP, NULL_STRING_OPTION, NULL_VALUE_DEFAULT_REPRESENTATION

Constructor Summary

Constructors

Constructor and Description
SplitJson()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
void	onPropertyModified(PropertyDescriptor descriptor, String oldValue, String newValue)
void	onScheduled(ProcessContext processContext)
void	onTrigger(ProcessContext processContext, ProcessSession processSession)

Methods inherited from class org.apache.nifi.processors.standard.AbstractJsonPathProcessor

getResultRepresentation, isJsonScalar, validateAndEstablishJsonContext

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

ARRAY_JSON_PATH_EXPRESSION

public static final PropertyDescriptor ARRAY_JSON_PATH_EXPRESSION

REL_ORIGINAL

public static final Relationship REL_ORIGINAL

REL_SPLIT

public static final Relationship REL_SPLIT

REL_FAILURE

public static final Relationship REL_FAILURE

properties

private List<PropertyDescriptor> properties

relationships

private Set<Relationship> relationships

JSON_PATH_REF

private final AtomicReference<com.jayway.jsonpath.JsonPath> JSON_PATH_REF

nullDefaultValue

private volatile String nullDefaultValue

Constructor Detail

SplitJson

public SplitJson()

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

onPropertyModified

public void onPropertyModified(PropertyDescriptor descriptor,
                               String oldValue,
                               String newValue)

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractConfigurableComponent

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

onScheduled

@OnScheduled
public void onScheduled(ProcessContext processContext)

onTrigger

public void onTrigger(ProcessContext processContext,
                      ProcessSession processSession)

Specified by:

onTrigger in class AbstractProcessor