org.apache.nifi.processors.standard

Class ExecuteStreamCommand

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.ExecuteStreamCommand

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SupportsBatching
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"command execution","command","stream","execute"})
 @CapabilityDescription(value="The ExecuteStreamCommand processor provides a flexible way to integrate external commands and scripts into NiFi data flows. ExecuteStreamCommand can pass the incoming FlowFile\'s content to the command that it executes similarly how piping works.")
 @SupportsSensitiveDynamicProperties
 @DynamicProperty(name="An environment variable name",value="An environment variable value",description="These environment variables are passed to the process spawned by this Processor") @DynamicProperty(name="command.argument.<commandIndex>",value="Argument to be supplied to the command",description="These arguments are supplied to the process spawned by this Processor when using the Command Arguments Strategy : Dynamic Property Arguments. <commandIndex> is a number and it will determine the order.")
 @WritesAttribute(attribute="execution.command",description="The name of the command executed") @WritesAttribute(attribute="execution.command.args",description="The semi-colon delimited list of arguments. Sensitive properties will be masked") @WritesAttribute(attribute="execution.status",description="The exit status code returned from executing the command") @WritesAttribute(attribute="execution.error",description="Any error messages returned from executing the command")
 @Restricted(restrictions=@Restriction(requiredPermission=EXECUTE_CODE,explanation="Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has."))
public class ExecuteStreamCommand
extends AbstractProcessor

This processor executes an external command on the contents of a flow file, and creates a new flow file with the results of the command.

Properties:

• Command Path
  • Specifies the command to be executed; if just the name of an executable is provided, it must be in the user's environment PATH.
  • Default value: none
  • Supports expression language: true
• Arguments Strategy
  • Selects the strategy to use for arguments to the executable
  • Command Arguments Property: Use the delimited list of arguments from the Command Arguments Property. Does not support quotations in parameters.
  • Dynamic Property Arguments: Use Dynamic Properties, with each property a separate argument. Does support quotes.
• Command Arguments
  • The arguments to supply to the executable delimited by the ';' character. Each argument may be an Expression Language statement.
  • Default value: none
  • Supports expression language: true
• Working Directory
  • The directory to use as the current working directory when executing the command
  • Default value: none (which means whatever NiFi's current working directory is...probably the root of the NiFi installation directory.)
  • Supports expression language: true
• Ignore STDIN
  • Indicates whether or not the flowfile's contents should be streamed as part of STDIN
  • Default value: false (this means that the contents of a flowfile will be sent as STDIN to your command
  • Supports expression language: false

Relationships:

• original
  • The destination path for the original incoming flow file
• output-stream
  • The destination path for the flow file created from the command's output, if the exit code is zero
• nonzero-status
  • The destination path for the flow file created from the command's output, if the exit code is non-zero

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	ExecuteStreamCommand.ProcessStreamWriterCallback

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static PropertyDescriptor	ARG_DELIMITER
(package private) static PropertyDescriptor	ARGUMENTS_STRATEGY
private static Validator	ATTRIBUTE_EXPRESSION_LANGUAGE_VALIDATOR
private static Set<Relationship>	ATTRIBUTE_RELATIONSHIP_SET
private static Pattern	COMMAND_ARGUMENT_PATTERN
(package private) static AllowableValue	COMMAND_ARGUMENTS_PROPERTY_STRATEGY
(package private) static AllowableValue	DYNAMIC_PROPERTY_ARGUMENTS_STRATEGY
(package private) static PropertyDescriptor	EXECUTION_ARGUMENTS
(package private) static PropertyDescriptor	EXECUTION_COMMAND
(package private) static PropertyDescriptor	IGNORE_STDIN
private ComponentLog	logger
private static String	MASKED_ARGUMENT
static Relationship	NONZERO_STATUS_RELATIONSHIP
static Relationship	ORIGINAL_RELATIONSHIP
static Relationship	OUTPUT_STREAM_RELATIONSHIP
private static Set<Relationship>	OUTPUT_STREAM_RELATIONSHIP_SET
private static List<PropertyDescriptor>	PROPERTIES
(package private) static PropertyDescriptor	PUT_ATTRIBUTE_MAX_LENGTH
(package private) static PropertyDescriptor	PUT_OUTPUT_IN_ATTRIBUTE
private AtomicReference<Set<Relationship>>	relationships
(package private) static PropertyDescriptor	WORKING_DIR

Constructor Summary

Constructors

Constructor and Description
ExecuteStreamCommand()

Method Summary

Modifier and Type	Method and Description
Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
void	onPropertyModified(PropertyDescriptor descriptor, String oldValue, String newValue)
void	onTrigger(ProcessContext context, ProcessSession session)
private static void	readStdoutReadable(boolean ignoreStdin, OutputStream stdinWritable, ComponentLog logger, InputStream incomingFlowFileIS)

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

onTrigger

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

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

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

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

Field Detail

ORIGINAL_RELATIONSHIP

public static final Relationship ORIGINAL_RELATIONSHIP

OUTPUT_STREAM_RELATIONSHIP

public static final Relationship OUTPUT_STREAM_RELATIONSHIP

NONZERO_STATUS_RELATIONSHIP

public static final Relationship NONZERO_STATUS_RELATIONSHIP

relationships

private final AtomicReference<Set<Relationship>> relationships

OUTPUT_STREAM_RELATIONSHIP_SET

private static final Set<Relationship> OUTPUT_STREAM_RELATIONSHIP_SET

ATTRIBUTE_RELATIONSHIP_SET

private static final Set<Relationship> ATTRIBUTE_RELATIONSHIP_SET

COMMAND_ARGUMENT_PATTERN

private static final Pattern COMMAND_ARGUMENT_PATTERN

COMMAND_ARGUMENTS_PROPERTY_STRATEGY

static final AllowableValue COMMAND_ARGUMENTS_PROPERTY_STRATEGY

DYNAMIC_PROPERTY_ARGUMENTS_STRATEGY

static final AllowableValue DYNAMIC_PROPERTY_ARGUMENTS_STRATEGY

WORKING_DIR

static final PropertyDescriptor WORKING_DIR

ATTRIBUTE_EXPRESSION_LANGUAGE_VALIDATOR

private static final Validator ATTRIBUTE_EXPRESSION_LANGUAGE_VALIDATOR

EXECUTION_COMMAND

static final PropertyDescriptor EXECUTION_COMMAND

ARGUMENTS_STRATEGY

static final PropertyDescriptor ARGUMENTS_STRATEGY

EXECUTION_ARGUMENTS

static final PropertyDescriptor EXECUTION_ARGUMENTS

ARG_DELIMITER

static final PropertyDescriptor ARG_DELIMITER

IGNORE_STDIN

static final PropertyDescriptor IGNORE_STDIN

PUT_OUTPUT_IN_ATTRIBUTE

static final PropertyDescriptor PUT_OUTPUT_IN_ATTRIBUTE

PUT_ATTRIBUTE_MAX_LENGTH

static final PropertyDescriptor PUT_ATTRIBUTE_MAX_LENGTH

PROPERTIES

private static final List<PropertyDescriptor> PROPERTIES

MASKED_ARGUMENT

private static final String MASKED_ARGUMENT

See Also:

Constant Field Values

logger

private ComponentLog logger

Constructor Detail

ExecuteStreamCommand

public ExecuteStreamCommand()

Method Detail

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

onPropertyModified

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

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractConfigurableComponent

getSupportedPropertyDescriptors

public List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

readStdoutReadable

private static void readStdoutReadable(boolean ignoreStdin,
                                       OutputStream stdinWritable,
                                       ComponentLog logger,
                                       InputStream incomingFlowFileIS)