Package org.apache.nifi.json

Class JsonPathReader

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.serialization.SchemaRegistryService

org.apache.nifi.json.JsonPathReader

All Implemented Interfaces:

org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.controller.ControllerService, RecordReaderFactory

@Tags({"json","jsonpath","record","reader","parser"})
@CapabilityDescription("Parses JSON records and evaluates user-defined JSON Path\'s against each JSON object. While the reader expects each record to be well-formed JSON, the content of a FlowFile may consist of many records, each as a well-formed JSON array or JSON object with optional whitespace between them, such as the common \'JSON-per-line\' format. If an array is encountered, each element in that array will be treated as a separate record. User-defined properties define the fields that should be extracted from the JSON in order to form the fields of a Record. Any JSON field that is not extracted via a JSONPath will not be returned in the JSON Records.")
@SeeAlso(JsonTreeReader.class)
@DynamicProperty(name="The field name for the record.",
                 value="A JSONPath Expression that will be evaluated against each JSON record. The result of the JSONPath will be the value of the field whose name is the same as the property name.",
                 description="User-defined properties identify how to extract specific fields from a JSON object in order to create a Record",
                 expressionLanguageScope=NONE)
public class JsonPathReader
extends SchemaRegistryService
implements RecordReaderFactory

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	allowComments
private String	dateFormat
private LinkedHashMap<String,com.jayway.jsonpath.JsonPath>	jsonPaths
private com.fasterxml.jackson.core.StreamReadConstraints	streamReadConstraints
private String	timeFormat
private String	timestampFormat

Fields inherited from class org.apache.nifi.serialization.SchemaRegistryService

schemaAccessStrategy

Constructor Summary

Constructors

Constructor	Description
JsonPathReader()

Method Summary

Modifier and Type	Method	Description
void	compileJsonPaths(org.apache.nifi.controller.ConfigurationContext context)
RecordReader	createRecordReader(Map<String,String> variables, InputStream in, long inputLength, org.apache.nifi.logging.ComponentLog logger)
protected Collection<org.apache.nifi.components.ValidationResult>	customValidate(org.apache.nifi.components.ValidationContext validationContext)
protected org.apache.nifi.components.AllowableValue	getDefaultSchemaAccessStrategy()
protected SchemaAccessStrategy	getSchemaAccessStrategy(String strategy, SchemaRegistry schemaRegistry, org.apache.nifi.context.PropertyContext context)
protected List<org.apache.nifi.components.AllowableValue>	getSchemaAccessStrategyValues()
protected org.apache.nifi.components.PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<org.apache.nifi.components.PropertyDescriptor>	getSupportedPropertyDescriptors()

Methods inherited from class org.apache.nifi.serialization.SchemaRegistryService

buildStrategyProperty, getConfigurationContext, getSchema, getSchema, getSchemaAccessStrategy, getSchemaAccessStrategyDescriptor, getSuppliedSchemaFields, migrateProperties, storeSchemaAccessStrategy

Methods inherited from class org.apache.nifi.controller.AbstractControllerService

abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, getProperty, getStateManager, init, initialize, isEnabled

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, hashCode, onPropertyModified, toString, 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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize, isStateful, migrateProperties

Methods inherited from interface org.apache.nifi.serialization.RecordReaderFactory

createRecordReader

Field Details

dateFormat

private volatile String dateFormat

timeFormat

private volatile String timeFormat

timestampFormat

private volatile String timestampFormat

jsonPaths

private volatile LinkedHashMap<String,com.jayway.jsonpath.JsonPath> jsonPaths

allowComments

private volatile boolean allowComments

streamReadConstraints

private volatile com.fasterxml.jackson.core.StreamReadConstraints streamReadConstraints

Constructor Details

JsonPathReader

public JsonPathReader()

Method Details

getSupportedPropertyDescriptors

protected List<org.apache.nifi.components.PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class SchemaRegistryService

getSupportedDynamicPropertyDescriptor

protected org.apache.nifi.components.PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class org.apache.nifi.components.AbstractConfigurableComponent

compileJsonPaths

@OnEnabled
public void compileJsonPaths(org.apache.nifi.controller.ConfigurationContext context)

customValidate

protected Collection<org.apache.nifi.components.ValidationResult> customValidate(org.apache.nifi.components.ValidationContext validationContext)

Overrides:

customValidate in class SchemaRegistryService

getSchemaAccessStrategyValues

protected List<org.apache.nifi.components.AllowableValue> getSchemaAccessStrategyValues()

Overrides:

getSchemaAccessStrategyValues in class SchemaRegistryService

getSchemaAccessStrategy

protected SchemaAccessStrategy getSchemaAccessStrategy(String strategy,
 SchemaRegistry schemaRegistry,
 org.apache.nifi.context.PropertyContext context)

Overrides:

getSchemaAccessStrategy in class SchemaRegistryService

getDefaultSchemaAccessStrategy

protected org.apache.nifi.components.AllowableValue getDefaultSchemaAccessStrategy()

Overrides:

getDefaultSchemaAccessStrategy in class SchemaRegistryService

createRecordReader

public RecordReader createRecordReader(Map<String,String> variables,
 InputStream in,
 long inputLength,
 org.apache.nifi.logging.ComponentLog logger)
                                throws IOException,
MalformedRecordException,
SchemaNotFoundException

Specified by:

createRecordReader in interface RecordReaderFactory

Throws:

IOException

MalformedRecordException

SchemaNotFoundException