...
Exec
...
component
...
Available
...
in
...
Camel
...
2.3
The exec
component can be used to execute system commands.
Dependencies
Maven users need to add the following dependency to their pom.xml
Code Block | ||||
---|---|---|---|---|
| ||||
* The {{exec}} component can be used to execute a system command. h3. Dependencies Maven users need to add the following dependency to their {{pom.xml}} {code:xml} <dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-exec</artifactId> <version>${camel-version}</version> </dependency> {code} where {{$\ |
where ${camel-version
...
}
...
must
...
be
...
replaced
...
by
...
the
...
actual
...
version
...
of
...
Camel
...
(2.3.0
...
or
...
higher).
URI format
Code Block | ||||
---|---|---|---|---|
| ||||
h3. URI format {code:xml} exec://executable[?options] {code} where {{executable}} is the name, or file path, of the system command that will be executed. If executable name is used |
where executable
is the name, or file path, of the system command that will be executed. If executable name is used (e.g.
...
exec:java
...
),
...
the
...
executable
...
must
...
in
...
the
...
system
...
path.
...
URI
...
options
Div | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||
=confluenceTableSmall}
|| Name || Default value || Description ||
| {{args}} | {{null}} | The arguments of the executable. The arguments may be one or many
whitespace-separated tokens, that can be quoted with {{"}}, e.g. {{args="arg 1" arg2}} will use two arguments {{arg 1}} and {{arg2}}. To include the quotes use {{""}}, e.g. {{args=""arg 1"" arg2}} will use the arguments {{"arg 1"}} and {{arg2}}.|
| {{workingDir}} | {{null}} |The directory in which the command should be executed. If {{null}}, the working directory of the current process will be used.|
| {{timeout}} | {{Long.MAX_VALUE}}|The timeout, in milliseconds, after which the executable should be terminated. If the executable has has not finished within the timeout, the component will send a termination request.|
| {{outFile}} | {{null}} |The name of a file, created by the executable, that should be considered as output of the executable. If no {{outFile}} is set, the standard output (stdout) of the executable will be considered as output. |
| {{binding}} | a {{DefaultExecBinding}} instance | A reference to a {{
|
Message headers
The supported headers are defined in org.apache.camel.component.exec.ExecBinding
...
.
Div | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||
=confluenceTableSmall}
||Name||Type||Message ||Description||
|{{
|
Message body
If the Exec
component receives an in
message body that is convertible to java.io.InputStream
, it is used to feed input to the executable via its stdin. After execution, the message body is the result of the execution,- that is, an org.apache.camel.components.exec.ExecResult
...
instance
...
containing
...
the
...
stdout,
...
stderr,
...
exit
...
value
...
, and
...
out
...
file.
...
This component
...
supports
...
the
...
following
...
ExecResult
...
...
...
for
...
convenience:
Div | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
=confluenceTableSmall}
||From||To||
|{{ExecResult}} | {{
If an out file is specified (in the endpoint via ), converters will return the content of the out file. If no out file is used, then this component will convert the stdout of the process to the target type. For more details, please refer to the usage examples below. |
Anchor | ||||
---|---|---|---|---|
|
Usage examples
Executing word count (Linux)
The example below executes wc
(word count, Linux) to count the words in file /usr/share/dict/words
...
.
...
The
...
word
...
count
...
(output)
...
is
...
written to the standard output stream of wc
.
Code Block | ||||
---|---|---|---|---|
| ||||
in the standart output stream of {{wc}}. {code:java} from("direct:exec") .to("exec:wc?args=--words /usr/share/dict/words") .process(new Processor() { public void process(Exchange exchange) throws Exception { // By default, the body is ExecResult instance assertIsInstanceOf(ExecResult.class, exchange.getIn().getBody()); // Use the Camel Exec String type converter to convert the ExecResult to String // In this case, the stdout is considered as output String wordCountOutput = exchange.getIn().getBody(String.class); // do something with the word count } }); {code} h4. Executing java The example below executes {{java}} with 2 arguments: {{-server}} and {{-version}}, provided that {{java}} is in the system path. {code} |
Executing java
The example below executes java
with 2 arguments: -server
and -version
, provided that java
is in the system path.
Code Block |
---|
from("direct:exec")
.to("exec:java?args=-server -version")
{code}
|
The
...
example
...
below
...
executes
...
java
...
in
...
c:
...
\temp
...
with
...
3
...
arguments:
...
-server
...
,
...
-version
...
and
...
the
...
sytem
...
property
...
user.name
...
.
Code Block |
---|
} from("direct:exec") .to("exec:c:/program files/jdk/bin/java?args=-server -version -Duser.name=Camel&workingDir=c:/temp") {code} h4. Executing Ant scripts The following example executes [Apache Ant|http://ant.apache.org/] (Windows only) with the build file {{CamelExecBuildFile.xml}}, provided that {{ant.bat}} is in the system path, and that {{CamelExecBuildFile.xml}} is in the current directory. {code} |
Executing Ant scripts
The following example executes Apache Ant (Windows only) with the build file CamelExecBuildFile.xml
, provided that ant.bat
is in the system path, and that CamelExecBuildFile.xml
is in the current directory.
Code Block |
---|
from("direct:exec") .to("exec:ant.bat?args=-f CamelExecBuildFile.xml") {code} |
In
...
the
...
next
...
example,
...
the
...
ant.bat
...
command
...
redirects its output to CamelExecOutFile.txt
...
with
...
-l
...
.
...
The
...
file
...
CamelExecOutFile.txt
...
is
...
used
...
as
...
the out
...
file
...
with
...
outFile=CamelExecOutFile.txt
...
.
...
The
...
example
...
assumes
...
that
...
ant.bat
...
is
...
in
...
the
...
system
...
path,
...
and
...
that
...
CamelExecBuildFile.xml
...
is
...
in
...
the
...
current
...
directory.
Code Block | ||||
---|---|---|---|---|
| ||||
{code:java} from("direct:exec") .to("exec:ant.bat?args=-f CamelExecBuildFile.xml -l CamelExecOutFile.txt&outFile=CamelExecOutFile.txt") .process(new Processor() { public void process(Exchange exchange) throws Exception { InputStream outFile = exchange.getIn().getBody(InputStream.class); assertIsInstanceOf(InputStream.class, outFile); // do something with the out file here } }); {code} {include:Endpoint See Also} |
Executing echo
(Windows)
Commands such as echo
and dir
can be executed only with the command interpreter of the operating system. This example shows how to execute such a command - echo
- in Windows.
Code Block | ||||
---|---|---|---|---|
| ||||
from("direct:exec").to("exec:cmd?args=/C echo echoString")
|
Include Page | ||||
---|---|---|---|---|
|