org.apache.nifi.record.script

Class ScriptedRecordSetWriter

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.script.AbstractScriptedControllerService

org.apache.nifi.record.script.AbstractScriptedRecordFactory<RecordSetWriterFactory>

org.apache.nifi.record.script.ScriptedRecordSetWriter

All Implemented Interfaces:

ConfigurableComponent, ControllerService, RecordSetWriterFactory

@Tags(value={"record","writer","script","invoke","groovy","python","jython","jruby","ruby","javascript","js","lua","luaj"})
 @CapabilityDescription(value="Allows the user to provide a scripted RecordSetWriterFactory instance in order to write records to an outgoing flow file.")
 @Restricted(restrictions=@Restriction(requiredPermission=EXECUTE_CODE,explanation="Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has."))
public class ScriptedRecordSetWriter
extends AbstractScriptedRecordFactory<RecordSetWriterFactory>
implements RecordSetWriterFactory

A RecordSetWriter implementation that allows the user to script the RecordWriter instance

Field Summary

Fields inherited from class org.apache.nifi.record.script.AbstractScriptedRecordFactory

recordFactory

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

configurationContext, scriptEngine, scriptingComponentHelper, scriptNeedsReload, validationResults

Constructor Summary

Constructors

Constructor and Description
ScriptedRecordSetWriter()

Method Summary

Modifier and Type	Method and Description
RecordSetWriter	createWriter(ComponentLog logger, RecordSchema schema, OutputStream out, Map<String,String> variables)
RecordSchema	getSchema(Map<String,String> variables, RecordSchema readSchema)
void	onEnabled(ConfigurationContext context)
protected boolean	reloadScript(String scriptBody) Reloads the script RecordSetWriterFactory.

Methods inherited from class org.apache.nifi.record.script.AbstractScriptedRecordFactory

setup

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

customValidate, getSupportedDynamicPropertyDescriptor, getSupportedPropertyDescriptors, 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.serialization.RecordSetWriterFactory

createWriter, createWriter

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Constructor Detail

ScriptedRecordSetWriter

public ScriptedRecordSetWriter()

Method Detail

onEnabled

@OnEnabled
public void onEnabled(ConfigurationContext context)

Overrides:

onEnabled in class AbstractScriptedControllerService

createWriter

public RecordSetWriter createWriter(ComponentLog logger,
                                    RecordSchema schema,
                                    OutputStream out,
                                    Map<String,String> variables)
                             throws SchemaNotFoundException,
                                    IOException

Specified by:

createWriter in interface RecordSetWriterFactory

Throws:

SchemaNotFoundException

IOException

reloadScript

protected boolean reloadScript(String scriptBody)

Reloads the script RecordSetWriterFactory. 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

getSchema

public RecordSchema getSchema(Map<String,String> variables,
                              RecordSchema readSchema)
                       throws SchemaNotFoundException,
                              IOException

Specified by:

getSchema in interface RecordSetWriterFactory

Throws:

SchemaNotFoundException

IOException