org.apache.nifi.processors.groovyx

Class ExecuteGroovyScript

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.groovyx.ExecuteGroovyScript

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @InputRequirement(value=INPUT_ALLOWED)
 @Tags(value={"script","groovy","groovyx"})
 @CapabilityDescription(value="Experimental Extended Groovy script processor. 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.")
 @Restricted(restrictions=@Restriction(requiredPermission=EXECUTE_CODE,explanation="Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has."))
 @SeeAlso(classNames="org.apache.nifi.processors.script.ExecuteScript")
 @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. Use `CTL.` to access any controller services, `SQL.` to access any DBCPServices, `RecordReader.` to access RecordReaderFactory instances, or `RecordWriter.` to access any RecordSetWriterFactory instances.")
public class ExecuteGroovyScript
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ExecuteGroovyScript.AccessMap simple HashMap with exception on access of non-existent key

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	ADD_CLASSPATH
(package private) String	addClasspath
(package private) Class<groovy.lang.Script>	compiled
private List<PropertyDescriptor>	descriptors
static PropertyDescriptor	FAIL_STRATEGY
static String	GROOVY_CLASSPATH
(package private) String	groovyClasspath
private static String	PRELOADS
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships
static PropertyDescriptor	SCRIPT_BODY
static PropertyDescriptor	SCRIPT_FILE
(package private) String	scriptBody
(package private) File	scriptFile
(package private) long	scriptLastModified
(package private) groovy.lang.GroovyShell	shell
static String[]	VALID_FAIL_STRATEGY

Constructor Summary

Constructors

Constructor and Description
ExecuteGroovyScript()

Method Summary

Modifier and Type	Method and Description
private File	asFile(String f)
private void	callScriptStatic(String method, ProcessContext context)
protected Collection<ValidationResult>	customValidate(ValidationContext context) Let's do validation by script compile at this point.
(package private) groovy.lang.Script	getGroovyScript()
Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName) Returns a PropertyDescriptor for the given name.
List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
private void	onCommitSQL(Map<String,Object> SQL) before commit SQL services
private void	onFailSQL(Map<String,Object> SQL) exception SQL services
private void	onFinitSQL(Map<String,Object> SQL) finalize SQL services.
private void	onInitSQL(Map<String,Object> SQL) init SQL variables from DBCP services
void	onPropertyModified(PropertyDescriptor descriptor, String oldValue, String newValue) Hook method allowing subclasses to eagerly react to a configuration change for the given property descriptor.
void	onScheduled(ProcessContext context) Performs setup operations when the processor is scheduled to run.
void	onStopped(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession _session)
void	onUnscheduled(ProcessContext context)

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.processor.Processor

isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, validate

Field Detail

GROOVY_CLASSPATH

public static final String GROOVY_CLASSPATH

See Also:

Constant Field Values

PRELOADS

private static final String PRELOADS

See Also:

Constant Field Values

SCRIPT_FILE

public static final PropertyDescriptor SCRIPT_FILE

SCRIPT_BODY

public static final PropertyDescriptor SCRIPT_BODY

VALID_FAIL_STRATEGY

public static String[] VALID_FAIL_STRATEGY

FAIL_STRATEGY

public static final PropertyDescriptor FAIL_STRATEGY

ADD_CLASSPATH

public static final PropertyDescriptor ADD_CLASSPATH

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

descriptors

private List<PropertyDescriptor> descriptors

relationships

private Set<Relationship> relationships

scriptFile

File scriptFile

scriptBody

String scriptBody

addClasspath

String addClasspath

groovyClasspath

String groovyClasspath

shell

volatile groovy.lang.GroovyShell shell

compiled

volatile Class<groovy.lang.Script> compiled

scriptLastModified

volatile long scriptLastModified

Constructor Detail

ExecuteGroovyScript

public ExecuteGroovyScript()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

public final List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

asFile

private File asFile(String f)

callScriptStatic

private void callScriptStatic(String method,
                              ProcessContext context)
                       throws IllegalAccessException,
                              InvocationTargetException

Throws:

IllegalAccessException

InvocationTargetException

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext context)

Let's do validation by script compile at this point.

Overrides:

customValidate in class AbstractConfigurableComponent

Parameters:

context - provides a mechanism for obtaining externally managed values, such as property values and supplies convenience methods for operating on those values

Returns:

Collection of ValidationResult objects that will be added to any other validation findings - may be null

onPropertyModified

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

Hook method allowing subclasses to eagerly react to a configuration change for the given property descriptor. As an alternative to using this method a processor may simply get the latest value whenever it needs it and if necessary lazily evaluate it.

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractConfigurableComponent

Parameters:

descriptor - of the modified property

oldValue - non-null property value (previous)

newValue - the new property value or if null indicates the property was removed

onScheduled

@OnScheduled
public void onScheduled(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

onUnscheduled

@OnUnscheduled
public void onUnscheduled(ProcessContext context)

onStopped

@OnStopped
public void onStopped(ProcessContext context)

getGroovyScript

groovy.lang.Script getGroovyScript()
                            throws Throwable

Throws:

Throwable

onInitSQL

private void onInitSQL(Map<String,Object> SQL)
                throws SQLException

init SQL variables from DBCP services

Throws:

SQLException

onCommitSQL

private void onCommitSQL(Map<String,Object> SQL)
                  throws SQLException

before commit SQL services

Throws:

SQLException

onFinitSQL

private void onFinitSQL(Map<String,Object> SQL)

finalize SQL services. no exceptions should be thrown.

onFailSQL

private void onFailSQL(Map<String,Object> SQL)

exception SQL services

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

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