org.apache.nifi.record.sink.script

Class ScriptedRecordSink

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.script.AbstractScriptedControllerService

org.apache.nifi.record.sink.script.ScriptedRecordSink

All Implemented Interfaces:

ConfigurableComponent, ControllerService, RecordSinkService

@Tags(value={"record","record sink","script","invoke","groovy","python","jython","jruby","ruby","javascript","js","lua","luaj"})
 @CapabilityDescription(value="Allows the user to provide a scripted RecordSinkService instance in order to transmit records to the desired target. The script must set a variable \'recordSink\' to an implementation of RecordSinkService.")
 @Restricted(restrictions=@Restriction(requiredPermission=EXECUTE_CODE,explanation="Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has."))
public class ScriptedRecordSink
extends AbstractScriptedControllerService
implements RecordSinkService

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicReference<RecordSinkService>	recordSink

Fields inherited from class org.apache.nifi.script.AbstractScriptedControllerService

configurationContext, scriptEngine, scriptingComponentHelper, scriptNeedsReload, validationResults

Fields inherited from interface org.apache.nifi.record.sink.RecordSinkService

RECORD_WRITER_FACTORY

Constructor Summary

Constructors

Constructor and Description
ScriptedRecordSink()

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 processor.
void	onEnabled(ConfigurationContext context)
protected boolean	reloadScript(String scriptBody) Reloads the script RecordSinkService.
void	reset()
WriteResult	sendData(RecordSet recordSet, Map<String,String> attributes, boolean sendZeroResults)
void	setup()

Methods inherited from class org.apache.nifi.script.AbstractScriptedControllerService

onPropertyModified, reloadScriptBody, reloadScriptFile

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.controller.ControllerService

initialize

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

recordSink

protected final AtomicReference<RecordSinkService> recordSink

Constructor Detail

ScriptedRecordSink

public ScriptedRecordSink()

Method Detail

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 AbstractScriptedControllerService

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 AbstractScriptedControllerService

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 AbstractScriptedControllerService

setup

public void setup()

Specified by:

setup in class AbstractScriptedControllerService

reloadScript

protected boolean reloadScript(String scriptBody)

Reloads the script RecordSinkService. This must be called within the lock.

Specified by:

reloadScript in class AbstractScriptedControllerService

Parameters:

scriptBody - An input stream associated with the script content

Returns:

Whether the script was successfully reloaded

onEnabled

@OnEnabled
public void onEnabled(ConfigurationContext context)

Overrides:

onEnabled in class AbstractScriptedControllerService

sendData

public WriteResult sendData(RecordSet recordSet,
                            Map<String,String> attributes,
                            boolean sendZeroResults)
                     throws IOException

Specified by:

sendData in interface RecordSinkService

Throws:

IOException

reset

public void reset()

Specified by:

reset in interface RecordSinkService