org.apache.nifi.script

Class AbstractScriptedControllerService

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.script.AbstractScriptedControllerService

All Implemented Interfaces:

ConfigurableComponent, ControllerService

Direct Known Subclasses:

AbstractScriptedRecordFactory, BaseScriptedLookupService, ScriptedActionHandler, ScriptedRecordSink, ScriptedRulesEngine

public abstract class AbstractScriptedControllerService
extends AbstractControllerService

An abstract class with common methods and variables for reuse among Controller Services

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigurationContext	configurationContext
protected ScriptEngine	scriptEngine
protected ScriptingComponentHelper	scriptingComponentHelper
protected AtomicBoolean	scriptNeedsReload
protected AtomicReference<Collection<ValidationResult>>	validationResults

Constructor Summary

Constructors

Constructor and Description
AbstractScriptedControllerService()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
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 record reader.
void	onEnabled(ConfigurationContext context)
void	onPropertyModified(PropertyDescriptor descriptor, String oldValue, String newValue) Handles changes to this processor's properties.
protected abstract boolean	reloadScript(String scriptBody)
protected boolean	reloadScriptBody(String scriptBody) Reloads the script defined by the given string
protected boolean	reloadScriptFile(String scriptPath) Reloads the script located at the given path
abstract void	setup()

Methods inherited from class org.apache.nifi.controller.AbstractControllerService

abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getConfigurationContext, getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, getProperty, getStateManager, init, initialize, isEnabled

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, hashCode, toString, 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

validationResults

protected final AtomicReference<Collection<ValidationResult>> validationResults

scriptNeedsReload

protected final AtomicBoolean scriptNeedsReload

scriptEngine

protected volatile ScriptEngine scriptEngine

scriptingComponentHelper

protected volatile ScriptingComponentHelper scriptingComponentHelper

configurationContext

protected volatile ConfigurationContext configurationContext

Constructor Detail

AbstractScriptedControllerService

public AbstractScriptedControllerService()

Method Detail

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Returns a list of property descriptors supported by this record reader. The list always includes properties such as script engine name, script file name, script body name, script arguments, and an external module path.

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

onPropertyModified

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

Handles changes to this processor's properties. If changes are made to script- or engine-related properties, the script will be reloaded.

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

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

onEnabled

public void onEnabled(ConfigurationContext context)

setup

public abstract void setup()

reloadScriptFile

protected boolean reloadScriptFile(String scriptPath)

Reloads the script located at the given path

Parameters:

scriptPath - the path to the script file to be loaded

Returns:

true if the script was loaded successfully; false otherwise

reloadScriptBody

protected boolean reloadScriptBody(String scriptBody)

Reloads the script defined by the given string

Parameters:

scriptBody - the contents of the script to be loaded

Returns:

true if the script was loaded successfully; false otherwise

reloadScript

protected abstract boolean reloadScript(String scriptBody)