org.apache.nifi.processors.standard

Class EvaluateJsonPath

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.EvaluateJsonPath

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @Tags(value={"JSON","evaluate","JsonPath"})
 @InputRequirement(value=INPUT_REQUIRED)
 @CapabilityDescription(value="Evaluates one or more JsonPath expressions against the content of a FlowFile. The results of those expressions are assigned to FlowFile Attributes or are written to the content of the FlowFile itself, depending on configuration of the Processor. JsonPaths are entered by adding user-defined properties; the name of the property maps to the Attribute Name into which the result will be placed (if the Destination is flowfile-attribute; otherwise, the property name is ignored). The value of the property must be a valid JsonPath expression. A Return Type of \'auto-detect\' will make a determination based off the configured destination. When \'Destination\' is set to \'flowfile-attribute,\' a return type of \'scalar\' will be used. When \'Destination\' is set to \'flowfile-content,\' a return type of \'JSON\' will be used.If the JsonPath evaluates to a JSON array or JSON object and the Return Type is set to \'scalar\' the FlowFile will be unmodified and will be routed to failure. A Return Type of JSON can return scalar values if the provided JsonPath evaluates to the specified value and will be routed as a match.If Destination is \'flowfile-content\' and the JsonPath does not evaluate to a defined path, the FlowFile will be routed to \'unmatched\' without having its contents modified. If Destination is flowfile-attribute and the expression matches nothing, attributes will be created with empty strings as the value, and the FlowFile will always be routed to \'matched.\'")
 @DynamicProperty(name="A FlowFile attribute(if <Destination> is set to \'flowfile-attribute\')",
                 value="A JsonPath expression",
                 description="If <Destination>=\'flowfile-attribute\' then that FlowFile attribute will be set to any JSON objects that match the JsonPath.  If <Destination>=\'flowfile-content\' then the FlowFile content will be updated to any JSON objects that match the JsonPath.")
public class EvaluateJsonPath
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
private Queue<Set<Map.Entry<String,com.jayway.jsonpath.JsonPath>>>	attributeToJsonPathEntrySetQueue
private ConcurrentMap<String,com.jayway.jsonpath.JsonPath>	cachedJsonPathMap
static PropertyDescriptor	DESTINATION
static String	DESTINATION_ATTRIBUTE
static String	DESTINATION_CONTENT
private boolean	destinationIsAttribute
private String	nullDefaultValue
static PropertyDescriptor	PATH_NOT_FOUND
static String	PATH_NOT_FOUND_IGNORE
static String	PATH_NOT_FOUND_WARN
private String	pathNotFound
private List<PropertyDescriptor>	properties
static Relationship	REL_FAILURE
static Relationship	REL_MATCH
static Relationship	REL_NO_MATCH
private Set<Relationship>	relationships
private String	representationOption
static PropertyDescriptor	RETURN_TYPE
static String	RETURN_TYPE_AUTO
static String	RETURN_TYPE_JSON
static String	RETURN_TYPE_SCALAR
private String	returnType

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
EvaluateJsonPath()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext context)
Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
void	onPropertyModified(PropertyDescriptor descriptor, String oldValue, String newValue)
void	onRemoved(ProcessContext processContext) Provides cleanup of the map for any JsonPath values that may have been created.
void	onScheduled(ProcessContext processContext)
void	onTrigger(ProcessContext processContext, ProcessSession processSession)
void	onUnscheduled()

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

DESTINATION_ATTRIBUTE

public static final String DESTINATION_ATTRIBUTE

See Also:

Constant Field Values

DESTINATION_CONTENT

public static final String DESTINATION_CONTENT

See Also:

Constant Field Values

RETURN_TYPE_AUTO

public static final String RETURN_TYPE_AUTO

See Also:

Constant Field Values

RETURN_TYPE_JSON

public static final String RETURN_TYPE_JSON

See Also:

Constant Field Values

RETURN_TYPE_SCALAR

public static final String RETURN_TYPE_SCALAR

See Also:

Constant Field Values

PATH_NOT_FOUND_IGNORE

public static final String PATH_NOT_FOUND_IGNORE

See Also:

Constant Field Values

PATH_NOT_FOUND_WARN

public static final String PATH_NOT_FOUND_WARN

See Also:

Constant Field Values

DESTINATION

public static final PropertyDescriptor DESTINATION

RETURN_TYPE

public static final PropertyDescriptor RETURN_TYPE

PATH_NOT_FOUND

public static final PropertyDescriptor PATH_NOT_FOUND

REL_MATCH

public static final Relationship REL_MATCH

REL_NO_MATCH

public static final Relationship REL_NO_MATCH

REL_FAILURE

public static final Relationship REL_FAILURE

relationships

private Set<Relationship> relationships

properties

private List<PropertyDescriptor> properties

cachedJsonPathMap

private final ConcurrentMap<String,com.jayway.jsonpath.JsonPath> cachedJsonPathMap

attributeToJsonPathEntrySetQueue

private final Queue<Set<Map.Entry<String,com.jayway.jsonpath.JsonPath>>> attributeToJsonPathEntrySetQueue

representationOption

private volatile String representationOption

destinationIsAttribute

private volatile boolean destinationIsAttribute

returnType

private volatile String returnType

pathNotFound

private volatile String pathNotFound

nullDefaultValue

private volatile String nullDefaultValue

Constructor Detail

EvaluateJsonPath

public EvaluateJsonPath()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext context)

Overrides:

customValidate in class AbstractConfigurableComponent

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

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

onPropertyModified

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

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractConfigurableComponent

onRemoved

@OnRemoved
public void onRemoved(ProcessContext processContext)

Provides cleanup of the map for any JsonPath values that may have been created. This will remove common values shared between multiple instances, but will be regenerated when the next validation cycle occurs as a result of isStale()

Parameters:

processContext - context

onScheduled

@OnScheduled
public void onScheduled(ProcessContext processContext)

onUnscheduled

@OnUnscheduled
public void onUnscheduled()

onTrigger

public void onTrigger(ProcessContext processContext,
                      ProcessSession processSession)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException