org.apache.nifi.processors.script

Class ScriptedTransformRecord

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.script.ScriptedTransformRecord

All Implemented Interfaces:

ConfigurableComponent, Processor, Searchable

@EventDriven
 @SupportsBatching
 @SideEffectFree
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"record","transform","script","groovy","jython","python","update","modify","filter"})
 @Restricted(restrictions=@Restriction(requiredPermission=EXECUTE_CODE,explanation="Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has."))
 @WritesAttribute(attribute="mime.type",description="Sets the mime.type attribute to the MIME Type specified by the Record Writer") @WritesAttribute(attribute="record.count",description="The number of records in the FlowFile") @WritesAttribute(attribute="record.error.message",description="This attribute provides on failure the error message encountered by the Reader or Writer.")
 @CapabilityDescription(value="Provides the ability to evaluate a simple script against each record in an incoming FlowFile. The script may transform the record in some way, filter the record, or fork additional records. See Processor\'s Additional Details for more information.")
 @SeeAlso(classNames={"org.apache.nifi.processors.script.ExecuteScript","org.apache.nifi.processors.standard.UpdateRecord","org.apache.nifi.processors.standard.QueryRecord","org.apache.nifi.processors.jolt.record.JoltTransformRecord","org.apache.nifi.processors.standard.LookupRecord"})
public class ScriptedTransformRecord
extends AbstractProcessor
implements Searchable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ScriptedTransformRecord.Counts
private class	ScriptedTransformRecord.InterpretedScriptEvaluator
private class	ScriptedTransformRecord.PythonScriptEvaluator
private static interface	ScriptedTransformRecord.RecordWriteAction
private static interface	ScriptedTransformRecord.ScriptEvaluator

Field Summary

Fields

Modifier and Type	Field and Description
private AtomicReference<CompiledScript>	compiledScriptRef
private List<PropertyDescriptor>	descriptors
(package private) static PropertyDescriptor	LANGUAGE
private static String	PYTHON_SCRIPT_LANGUAGE
(package private) static PropertyDescriptor	RECORD_READER
(package private) static PropertyDescriptor	RECORD_WRITER
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
private static Set<String>	SCRIPT_OPTIONS
private ScriptingComponentHelper	scriptingComponentHelper
private String	scriptToRun

Constructor Summary

Constructors

Constructor and Description
ScriptedTransformRecord()

Method Summary

Modifier and Type	Method and Description
private ScriptedTransformRecord.ScriptEvaluator	createEvaluator(ScriptEngine scriptEngine, FlowFile flowFile)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
private CompiledScript	getOrCompileScript(Compilable scriptEngine, String scriptToRun)
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onTrigger(ProcessContext context, ProcessSession session)
private void	processRecord(Record inputRecord, FlowFile flowFile, ScriptedTransformRecord.Counts counts, ScriptedTransformRecord.RecordWriteAction recordWriteAction, ScriptedTransformRecord.ScriptEvaluator evaluator)
Collection<SearchResult>	search(SearchContext context)
void	setup(ProcessContext context)
private static Bindings	setupBindings(ScriptEngine scriptEngine)
private void	transform(FlowFile flowFile, ScriptedTransformRecord.ScriptEvaluator evaluator, 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, init, 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.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

PYTHON_SCRIPT_LANGUAGE

private static final String PYTHON_SCRIPT_LANGUAGE

See Also:

Constant Field Values

SCRIPT_OPTIONS

private static final Set<String> SCRIPT_OPTIONS

RECORD_READER

static final PropertyDescriptor RECORD_READER

RECORD_WRITER

static final PropertyDescriptor RECORD_WRITER

LANGUAGE

static final PropertyDescriptor LANGUAGE

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

scriptToRun

private volatile String scriptToRun

compiledScriptRef

private final AtomicReference<CompiledScript> compiledScriptRef

scriptingComponentHelper

private final ScriptingComponentHelper scriptingComponentHelper

descriptors

private final List<PropertyDescriptor> descriptors

Constructor Detail

ScriptedTransformRecord

public ScriptedTransformRecord()

Method Detail

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

setup

@OnScheduled
public void setup(ProcessContext context)
                        throws IOException

Throws:

IOException

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

transform

private void transform(FlowFile flowFile,
                       ScriptedTransformRecord.ScriptEvaluator evaluator,
                       ProcessContext context,
                       ProcessSession session)

processRecord

private void processRecord(Record inputRecord,
                           FlowFile flowFile,
                           ScriptedTransformRecord.Counts counts,
                           ScriptedTransformRecord.RecordWriteAction recordWriteAction,
                           ScriptedTransformRecord.ScriptEvaluator evaluator)
                    throws IOException,
                           ScriptException

Throws:

IOException

ScriptException

createEvaluator

private ScriptedTransformRecord.ScriptEvaluator createEvaluator(ScriptEngine scriptEngine,
                                                                FlowFile flowFile)
                                                         throws ScriptException

Throws:

ScriptException

getOrCompileScript

private CompiledScript getOrCompileScript(Compilable scriptEngine,
                                          String scriptToRun)
                                   throws ScriptException

Throws:

ScriptException

setupBindings

private static Bindings setupBindings(ScriptEngine scriptEngine)

search

public Collection<SearchResult> search(SearchContext context)

Specified by:

search in interface Searchable