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","restricted"})
 @CapabilityDescription(value="Allows the user to provide a scripted RecordSetWriterFactory instance in order to write records to an outgoing flow file.")
 @Restricted(value="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, java.io.OutputStream out) Creates a new RecordSetWriter that is capable of writing record contents to an OutputStream.
RecordSchema	getSchema(java.util.Map<java.lang.String,java.lang.String> variables, RecordSchema readSchema) Returns the Schema that will be used for writing Records.
void	onEnabled(ConfigurationContext context)
protected boolean	reloadScript(java.lang.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, 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

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,
                                    java.io.OutputStream out)
                             throws SchemaNotFoundException,
                                    java.io.IOException

Description copied from interface: RecordSetWriterFactory

Creates a new RecordSetWriter that is capable of writing record contents to an OutputStream.

Specified by:

createWriter in interface RecordSetWriterFactory

Parameters:

logger - the logger to use when logging information. This is passed in, rather than using the logger of the Controller Service because it allows messages to be logged for the component that is calling this Controller Service.

schema - the schema that will be used for writing records

out - the OutputStream to write to

Returns:

a RecordSetWriter that can write record sets to an OutputStream

Throws:

java.io.IOException - if unable to read from the given InputStream

SchemaNotFoundException

reloadScript

protected boolean reloadScript(java.lang.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(java.util.Map<java.lang.String,java.lang.String> variables,
                              RecordSchema readSchema)
                       throws SchemaNotFoundException,
                              java.io.IOException

Description copied from interface: RecordSetWriterFactory

Returns the Schema that will be used for writing Records. The given variables are intended to be used for determining the schema that should be used when writing records.

Specified by:

getSchema in interface RecordSetWriterFactory

Parameters:

variables - the variables which is used to resolve Record Schema via Expression Language, can be null or empty

readSchema - the schema that was read from the incoming FlowFile, or null if there is no input schema

Returns:

the Schema that should be used for writing Records

Throws:

SchemaNotFoundException - if unable to find the schema

java.io.IOException