org.apache.nifi.processors.script

Class ExecuteScript

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processors.script.ExecuteScript

All Implemented Interfaces:

ConfigurableComponent, Processor, Searchable

@Tags(value={"script","execute","groovy","python","jython","jruby","ruby","javascript","js","lua","luaj","clojure"})
 @CapabilityDescription(value="Experimental - Executes a script given the flow file and a process session.  The script is responsible for handling the incoming flow file (transfer to SUCCESS or remove, e.g.) as well as any flow files created by the script. If the handling is incomplete or incorrect, the session will be rolled back. Experimental: Impact of sustained usage not yet verified.")
 @DynamicProperty(name="A script engine property to update",
                 value="The value to set it to",
                 expressionLanguageScope=FLOWFILE_ATTRIBUTES,
                 description="Updates a script engine property specified by the Dynamic Property\'s key with the value specified by the Dynamic Property\'s value")
 @Restricted(restrictions=@Restriction(requiredPermission=EXECUTE_CODE,explanation="Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has."))
 @InputRequirement(value=INPUT_ALLOWED)
 @Stateful(scopes={LOCAL,CLUSTER},
          description="Scripts can store and retrieve state using the State Management APIs. Consult the State Manager section of the Developer\'s Guide for more details.")
 @SeeAlso(value=InvokeScriptedProcessor.class)
public class ExecuteScript
extends AbstractSessionFactoryProcessor
implements Searchable

Field Summary

Fields

Modifier and Type	Field and Description
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
(package private) ScriptingComponentHelper	scriptingComponentHelper
private String	scriptToRun

Constructor Summary

Constructors

Constructor and Description
ExecuteScript()

Method Summary

Modifier and Type	Method and Description
void	added()
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
Set<Relationship>	getRelationships() Returns the valid relationships for this processor.
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName) Returns a PropertyDescriptor for the given name.
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors() Returns a list of property descriptors supported by this processor.
void	onTrigger(ProcessContext context, ProcessSessionFactory sessionFactory) Evaluates the given script body (or file) using the current session, context, and flowfile.
Collection<SearchResult>	search(SearchContext context)
void	setup(ProcessContext context) Performs setup operations when the processor is scheduled to run.
void	stop()

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

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

scriptToRun

private volatile String scriptToRun

scriptingComponentHelper

volatile ScriptingComponentHelper scriptingComponentHelper

Constructor Detail

ExecuteScript

public ExecuteScript()

Method Detail

getRelationships

public Set<Relationship> getRelationships()

Returns the valid relationships for this processor.

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

Returns:

a Set of Relationships supported by this processor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Returns a list of property descriptors supported by this processor. The list always includes properties such as script engine name, script file name, script body name, script arguments, and an external module path. If the scripted processor also defines supported properties, those are added to the list as well.

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

Returns:

a List of PropertyDescriptor objects supported by this processor

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Returns a PropertyDescriptor for the given name. This is for the user to be able to define their own properties which will be available as variables in the script

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

Parameters:

propertyDescriptorName - used to lookup if any property descriptors exist for that name

Returns:

a PropertyDescriptor object corresponding to the specified dynamic property name

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

setup

@OnScheduled
public void setup(ProcessContext context)

Performs setup operations when the processor is scheduled to run. This includes evaluating the processor's properties, as well as reloading the script (from file or the "Script Body" property)

Parameters:

context - the context in which to perform the setup operations

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSessionFactory sessionFactory)
               throws ProcessException

Evaluates the given script body (or file) using the current session, context, and flowfile. The script evaluation expects a FlowFile to be returned, in which case it will route the FlowFile to success. If a script error occurs, the original FlowFile will be routed to failure. If the script succeeds but does not return a FlowFile, the original FlowFile will be routed to no-flowfile

Specified by:

onTrigger in interface Processor

Parameters:

context - the current process context

sessionFactory - provides access to a ProcessSessionFactory, which can be used for accessing FlowFiles, etc.

Throws:

ProcessException - if the scripted processor's onTrigger() method throws an exception

stop

@OnStopped
public void stop()

added

@OnAdded
public void added()

search

public Collection<SearchResult> search(SearchContext context)

Specified by:

search in interface Searchable