| {"component":{"kind":"component","name":"exec","title":"Exec","description":"Execute commands on the underlying operating system.","deprecated":false,"firstVersion":"2.3.0","label":"system","javaType":"org.apache.camel.component.exec.ExecComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-exec","version":"3.18.1","scheme":"exec","extendsScheme":"","syntax":"exec:executable","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelExecCommandExecutable":{"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the system command that will be executed. Overrides executable in the URI.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_EXECUTABLE"},"CamelExecCommandArgs":{"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"java.util.List<String> or String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Command-line argument(s) to pass to the executed process. The argument(s) is/are used literally - no quoting is applied. Overrides any existing args in the URI.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_ARGS"},"CamelExecCommandOutFile":{"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of a file, created by the executable, that should be considered as its output. Overrides any existing outFile in the URI.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_OUT_FILE"},"CamelExecCommandWorkingDir":{"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The directory in which the command should be executed. Overrides any existing workingDir in the URI.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_WORKING_DIR"},"CamelExecCommandTimeout":{"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timeout, in milliseconds, after which the executable should be terminated. Overrides any existing timeout in the URI.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_TIMEOUT"},"CamelExecExitValues":{"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The exit values for successful execution of the process. Overrides any existing exitValues in the URI.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_EXIT_VALUES"},"CamelExecStderr":{"kind":"header","displayName":"","group":"out","label":"out","required":false,"javaType":"java.io.InputStream","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of this header points to the standard error stream (stderr) of the executable. If no stderr is written, the value is null.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_STDERR"},"CamelExecExitValue":{"kind":"header","displayName":"","group":"out","label":"out","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of this header is the _exit value_ of the executable. Non-zero exit values typically indicate abnormal termination. Note that the exit value is OS-dependent.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_EXIT_VALUE"},"CamelExecUseStderrOnEmptyStdout":{"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Indicates that when stdout is empty, this component will populate the Camel Message Body with stderr. This behavior is disabled (false) by default.","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_USE_STDERR_ON_EMPTY_STDOUT"},"CamelExecCommandLogLevel":{"kind":"header","displayName":"","group":"in","label":"in","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Logging level to be used for commands during execution. The default value is DEBUG. Possible values are TRACE, DEBUG, INFO, WARN, ERROR or OFF (Values of LoggingLevel enum)","constantName":"org.apache.camel.component.exec.ExecBinding#EXEC_COMMAND_LOG_LEVEL"}},"properties":{"executable":{"kind":"path","displayName":"Executable","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sets the executable to be executed. The executable must not be empty or null."},"args":{"kind":"parameter","displayName":"Args","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The arguments may be one or many whitespace-separated tokens."},"binding":{"kind":"parameter","displayName":"Binding","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.exec.ExecBinding","deprecated":false,"autowired":false,"secret":false,"description":"A reference to a org.apache.commons.exec.ExecBinding in the Registry."},"commandExecutor":{"kind":"parameter","displayName":"Command Executor","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.exec.ExecCommandExecutor","deprecated":false,"autowired":false,"secret":false,"description":"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."},"commandLogLevel":{"kind":"parameter","displayName":"Command Log Level","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEBUG","description":"Logging level to be used for commands during execution. The default value is DEBUG. Possible values are TRACE, DEBUG, INFO, WARN, ERROR or OFF. (Values of ExecCommandLogLevelType enum)"},"exitValues":{"kind":"parameter","displayName":"Exit Values","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The exit values of successful executions. If the process exits with another value, an exception is raised. Comma-separated list of exit values. And empty list (the default) sets no expected exit values and disables the check."},"outFile":{"kind":"parameter","displayName":"Out File","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"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."},"timeout":{"kind":"parameter","displayName":"Timeout","group":"producer","label":"","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"description":"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."},"useStderrOnEmptyStdout":{"kind":"parameter","displayName":"Use Stderr On Empty Stdout","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."},"workingDir":{"kind":"parameter","displayName":"Working Dir","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"The directory in which the command should be executed. If null, the working directory of the current process will be used."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."}}} |