org.apache.nifi.processors.standard

Class EvaluateXPath

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.EvaluateXPath

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @Tags(value={"XML","evaluate","XPath"})
 @InputRequirement(value=INPUT_REQUIRED)
 @CapabilityDescription(value="Evaluates one or more XPaths against the content of a FlowFile. The results of those XPaths are assigned to FlowFile Attributes or are written to the content of the FlowFile itself, depending on configuration of the Processor. XPaths 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 XPath expression. If the XPath evaluates to more than one node and the Return Type is set to \'nodeset\' (either directly, or via \'auto-detect\' with a Destination of \'flowfile-content\'), the FlowFile will be unmodified and will be routed to failure. If the XPath does not evaluate to a Node, 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\'")
 @WritesAttribute(attribute="user-defined",
                 description="This processor adds user-defined attributes if the <Destination> property is set to flowfile-attribute.")
 @DynamicProperty(name="A FlowFile attribute(if <Destination> is set to \'flowfile-attribute\'",
                 value="An XPath expression",
                 description="If <Destination>=\'flowfile-attribute\' then the FlowFile attribute is set to the result of the XPath Expression.  If <Destination>=\'flowfile-content\' then the FlowFile content is set to the result of the XPath Expression.")
 @SystemResourceConsiderations(value=@SystemResourceConsideration(resource=MEMORY,description="Processing requires reading the entire FlowFile into memory"))
public class EvaluateXPath
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	EvaluateXPath.XPathValidator

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	DESTINATION
static String	DESTINATION_ATTRIBUTE
static String	DESTINATION_CONTENT
private AtomicReference<XPathFactory>	factoryRef
private List<PropertyDescriptor>	properties
static Relationship	REL_FAILURE
static Relationship	REL_MATCH
static Relationship	REL_NO_MATCH
private Set<Relationship>	relationships
static PropertyDescriptor	RETURN_TYPE
static String	RETURN_TYPE_AUTO
static String	RETURN_TYPE_NODESET
static String	RETURN_TYPE_STRING
static PropertyDescriptor	VALIDATE_DTD

Constructor Summary

Constructors

Constructor and Description
EvaluateXPath()

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

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_NODESET

public static final String RETURN_TYPE_NODESET

See Also:

Constant Field Values

RETURN_TYPE_STRING

public static final String RETURN_TYPE_STRING

See Also:

Constant Field Values

DESTINATION

public static final PropertyDescriptor DESTINATION

RETURN_TYPE

public static final PropertyDescriptor RETURN_TYPE

VALIDATE_DTD

public static final PropertyDescriptor VALIDATE_DTD

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

factoryRef

private final AtomicReference<XPathFactory> factoryRef

Constructor Detail

EvaluateXPath

public EvaluateXPath()

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

initializeXPathFactory

@OnScheduled
public void initializeXPathFactory()

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)

Specified by:

onTrigger in class AbstractProcessor