org.apache.camel.component.exec

Class ExecEndpoint

java.lang.Object

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultEndpoint

org.apache.camel.component.exec.ExecEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(firstVersion="2.3.0",
             scheme="exec",
             title="Exec",
             syntax="exec:executable",
             producerOnly=true,
             label="system")
public class ExecEndpoint
extends org.apache.camel.support.DefaultEndpoint

The exec component can be used to execute OS system commands.

Field Summary

Fields

Modifier and Type	Field and Description
static long	NO_TIMEOUT Indicates that no timeout is used.

Fields inherited from class org.apache.camel.support.service.ServiceSupport

FAILED, INITIALIZED, lock, log, NEW, SHUTDOWN, SHUTTINGDOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor and Description
ExecEndpoint(String uri, ExecComponent component)

Method Summary

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Producer	createProducer()
String	getArgs()
ExecBinding	getBinding()
ExecCommandExecutor	getCommandExecutor()
String	getExecutable()
String	getOutFile()
long	getTimeout()
String	getWorkingDir()
boolean	isSingleton()
boolean	isUseStderrOnEmptyStdout()
void	setArgs(String args) The arguments may be one or many whitespace-separated tokens.
void	setBinding(ExecBinding binding) A reference to a org.apache.commons.exec.ExecBinding in the Registry.
void	setCommandExecutor(ExecCommandExecutor commandExecutor) A reference to a org.apache.commons.exec.ExecCommandExecutor in the Registry that customizes the command execution.
void	setExecutable(String executable) Sets the executable to be executed.
void	setOutFile(String outFile) The name of a file, created by the executable, that should be considered as its output.
void	setTimeout(long timeout) The timeout, in milliseconds, after which the executable should be terminated.
void	setUseStderrOnEmptyStdout(boolean useStderrOnEmptyStdout) A boolean indicating that when stdout is empty, this component will populate the Camel Message Body with stderr.
void	setWorkingDir(String dir) The directory in which the command should be executed.

Methods inherited from class org.apache.camel.support.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doStart, doStop, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.service.ServiceSupport

doInit, doResume, doShutdown, doSuspend, getStatus, init, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

init, start, stop

Methods inherited from interface org.apache.camel.CamelContextAware

trySetCamelContext

Field Detail

NO_TIMEOUT

public static final long NO_TIMEOUT

Indicates that no timeout is used.

See Also:

Constant Field Values

Constructor Detail

ExecEndpoint

public ExecEndpoint(String uri,
                    ExecComponent component)

Method Detail

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Throws:

Exception

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Throws:

Exception

isSingleton

public boolean isSingleton()

getExecutable

public String getExecutable()

setExecutable

public void setExecutable(String executable)

Sets the executable to be executed. The executable must not be empty or null.

getArgs

public String getArgs()

setArgs

public void setArgs(String args)

The arguments may be one or many whitespace-separated tokens.

getWorkingDir

public String getWorkingDir()

setWorkingDir

public void setWorkingDir(String dir)

The directory in which the command should be executed. If null, the working directory of the current process will be used.

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

The timeout, in milliseconds, after which the executable should be terminated. If execution has not completed within the timeout, the component will send a termination request.

getOutFile

public String getOutFile()

setOutFile

public void setOutFile(String outFile)

The name of a file, created by the executable, that should be considered as its output. If no outFile is set, the standard output (stdout) of the executable will be used instead.

getCommandExecutor

public ExecCommandExecutor getCommandExecutor()

setCommandExecutor

public void setCommandExecutor(ExecCommandExecutor commandExecutor)

A reference to a org.apache.commons.exec.ExecCommandExecutor in the Registry that customizes the command execution. The default command executor utilizes the commons-exec library, which adds a shutdown hook for every executed command.

getBinding

public ExecBinding getBinding()

setBinding

public void setBinding(ExecBinding binding)

A reference to a org.apache.commons.exec.ExecBinding in the Registry.

isUseStderrOnEmptyStdout

public boolean isUseStderrOnEmptyStdout()

setUseStderrOnEmptyStdout

public void setUseStderrOnEmptyStdout(boolean useStderrOnEmptyStdout)

A boolean indicating that when stdout is empty, this component will populate the Camel Message Body with stderr. This behavior is disabled (false) by default.