org.apache.nifi.processors.standard

Class ExecuteProcess

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.ExecuteProcess

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_FORBIDDEN)
 @Tags(value={"command","process","source","external","invoke","script"})
 @CapabilityDescription(value="Runs an operating system command specified by the user and writes the output of that command to a FlowFile. If the command is expected to be long-running, the Processor can output the partial data on a specified interval. When this option is used, the output is expected to be in textual format, as it typically does not make sense to split binary data on arbitrary time-based intervals.")
 @DynamicProperty(name="An environment variable name",
                 value="An environment variable value",
                 description="These environment variables are passed to the process spawned by this Processor")
 @Restricted(restrictions=@Restriction(requiredPermission=EXECUTE_CODE,explanation="Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has."))
 @WritesAttribute(attribute="command",description="Executed command") @WritesAttribute(attribute="command.arguments",description="Arguments of the command")
public class ExecuteProcess
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ExecuteProcess.ProxyOutputStream Output stream that is used to wrap another output stream in a way that the underlying output stream can be swapped out for a different one when needed

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static PropertyDescriptor	ARG_DELIMITER
(package private) static String	ATTRIBUTE_COMMAND
(package private) static String	ATTRIBUTE_COMMAND_ARGS
static PropertyDescriptor	BATCH_DURATION
private static Validator	characterValidator
static PropertyDescriptor	COMMAND
static PropertyDescriptor	COMMAND_ARGUMENTS
private ExecutorService	executor
private Process	externalProcess
private AtomicBoolean	failure
private Future<?>	longRunningProcess
private ExecuteProcess.ProxyOutputStream	proxyOut
static PropertyDescriptor	REDIRECT_ERROR_STREAM
static Relationship	REL_SUCCESS
static PropertyDescriptor	WORKING_DIR

Constructor Summary

Constructors

Constructor and Description
ExecuteProcess()

Method Summary

Modifier and Type	Method and Description
protected List<String>	createCommandStrings(ProcessContext context, String command, String arguments)
Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected Future<?>	launchProcess(ProcessContext context, List<String> commandStrings, Long batchNanos, ExecuteProcess.ProxyOutputStream proxyOut)
void	onTrigger(ProcessContext context, ProcessSession session)
void	setupExecutor(ProcessContext context)
void	shutdownExecutor()

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

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

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, hashCode, onPropertyModified, 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, onPropertyModified, validate

Field Detail

ATTRIBUTE_COMMAND

static final String ATTRIBUTE_COMMAND

See Also:

Constant Field Values

ATTRIBUTE_COMMAND_ARGS

static final String ATTRIBUTE_COMMAND_ARGS

See Also:

Constant Field Values

COMMAND

public static final PropertyDescriptor COMMAND

COMMAND_ARGUMENTS

public static final PropertyDescriptor COMMAND_ARGUMENTS

WORKING_DIR

public static final PropertyDescriptor WORKING_DIR

BATCH_DURATION

public static final PropertyDescriptor BATCH_DURATION

REDIRECT_ERROR_STREAM

public static final PropertyDescriptor REDIRECT_ERROR_STREAM

characterValidator

private static final Validator characterValidator

ARG_DELIMITER

static final PropertyDescriptor ARG_DELIMITER

REL_SUCCESS

public static final Relationship REL_SUCCESS

externalProcess

private volatile Process externalProcess

executor

private volatile ExecutorService executor

longRunningProcess

private Future<?> longRunningProcess

failure

private AtomicBoolean failure

proxyOut

private volatile ExecuteProcess.ProxyOutputStream proxyOut

Constructor Detail

ExecuteProcess

public ExecuteProcess()

Method Detail

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

setupExecutor

@OnScheduled
public void setupExecutor(ProcessContext context)

shutdownExecutor

@OnUnscheduled
public void shutdownExecutor()

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

createCommandStrings

protected List<String> createCommandStrings(ProcessContext context,
                                            String command,
                                            String arguments)

launchProcess

protected Future<?> launchProcess(ProcessContext context,
                                  List<String> commandStrings,
                                  Long batchNanos,
                                  ExecuteProcess.ProxyOutputStream proxyOut)
                           throws IOException

Throws:

IOException