org.apache.camel.component.exec
Interface ExecBinding

All Known Implementing Classes:
DefaultExecBinding

public interface ExecBinding

Represents the binding of input and output types of a ExecCommandExecutor to an Exchange. The input of the executor is an ExecCommand and the output is an ExecResult.


Field Summary
static String EXEC_COMMAND_ARGS
          The header value overrides the existing command arguments in the ExecEndpoint URI.
static String EXEC_COMMAND_EXECUTABLE
          The header value overrides the executable of the command, configured in the exec endpoint URI.
static String EXEC_COMMAND_OUT_FILE
          Specifies the file name of a file, created by the executable, that should be considered as output of the executable, e.g.
static String EXEC_COMMAND_TIMEOUT
          Specifies the amount of time, in milliseconds, after which the process of the executable should be terminated.
static String EXEC_COMMAND_WORKING_DIR
          Sets the working directory of the EXEC_COMMAND_EXECUTABLE.
static String EXEC_EXIT_VALUE
          The value of this header is the exit value that is returned, after the execution.
static String EXEC_STDERR
          The value of this header is a InputStream with the standard error stream of the executable.
static String EXEC_USE_STDERR_ON_EMPTY_STDOUT
          The value of this header is a boolean which indicates whether or not to fallback and use stderr when stdout is empty.
 
Method Summary
 ExecCommand readInput(Exchange exchange, ExecEndpoint endpoint)
          Creates a ExecCommand from the headers in the exchange and the settings of the endpoint.
 void writeOutput(Exchange exchange, ExecResult result)
          Populates the exchange form the ExecResult.
 

Field Detail

EXEC_COMMAND_EXECUTABLE

static final String EXEC_COMMAND_EXECUTABLE
The header value overrides the executable of the command, configured in the exec endpoint URI. As executable is considered the remaining of the ExecEndpoint URI;

e.g. in the URI exec:C:/Program Files/jdk/java.exe , C:/Program Files/jdk/java.exe is the executable.

See Also:
Constant Field Values

EXEC_COMMAND_ARGS

static final String EXEC_COMMAND_ARGS
The header value overrides the existing command arguments in the ExecEndpoint URI. The arguments may be a List. In this case no parsing of the arguments is necessary.

See Also:
#EXEC_COMMAND_EXECUTABLE}, Constant Field Values

EXEC_COMMAND_OUT_FILE

static final String EXEC_COMMAND_OUT_FILE
Specifies the file name of a file, created by the executable, that should be considered as output of the executable, e.g. a log file.

See Also:
ExecResultConverter.toInputStream(ExecResult), Constant Field Values

EXEC_COMMAND_WORKING_DIR

static final String EXEC_COMMAND_WORKING_DIR
Sets the working directory of the EXEC_COMMAND_EXECUTABLE. The header value overrides any existing command in the endpoint URI. If this is not configured, the working directory of the current process will be used.

See Also:
Constant Field Values

EXEC_COMMAND_TIMEOUT

static final String EXEC_COMMAND_TIMEOUT
Specifies the amount of time, in milliseconds, after which the process of the executable should be terminated. The default value is Long.MAX_VALUE.

See Also:
Constant Field Values

EXEC_STDERR

static final String EXEC_STDERR
The value of this header is a InputStream with the standard error stream of the executable.

See Also:
Constant Field Values

EXEC_EXIT_VALUE

static final String EXEC_EXIT_VALUE
The value of this header is the exit value that is returned, after the execution. By convention a non-zero status exit value indicates abnormal termination.
Note that the exit value is OS dependent.

See Also:
Constant Field Values

EXEC_USE_STDERR_ON_EMPTY_STDOUT

static final String EXEC_USE_STDERR_ON_EMPTY_STDOUT
The value of this header is a boolean which indicates whether or not to fallback and use stderr when stdout is empty.

See Also:
Constant Field Values
Method Detail

readInput

ExecCommand readInput(Exchange exchange,
                      ExecEndpoint endpoint)
Creates a ExecCommand from the headers in the exchange and the settings of the endpoint.

Parameters:
exchange - a Camel Exchange
endpoint - an ExecEndpoint instance
Returns:
an ExecCommand object
See Also:
ExecCommandExecutor

writeOutput

void writeOutput(Exchange exchange,
                 ExecResult result)
Populates the exchange form the ExecResult.

Parameters:
exchange - a Camel Exchange, in which to write the result
result - the result of a command execution
See Also:
ExecCommandExecutor


Copyright © 2007-2010 IONA Open Source Community. All Rights Reserved.