Interface ExecComponentBuilderFactory.ExecComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.exec.ExecComponent>
All Known Implementing Classes:
ExecComponentBuilderFactory.ExecComponentBuilderImpl
Enclosing interface:
ExecComponentBuilderFactory
public static interface ExecComponentBuilderFactory.ExecComponentBuilder extends ComponentBuilder<org.apache.camel.component.exec.ExecComponent>
Builder for the Exec component.

  • Method Details

    • lazyStartProducer

      default ExecComponentBuilderFactory.ExecComponentBuilder lazyStartProducer(boolean lazyStartProducer)
      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. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • timeout

      default ExecComponentBuilderFactory.ExecComponentBuilder timeout(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. The option is a: <code>long</code> type. Group: producer
      Parameters:
      timeout - the value to set
      Returns:
      the dsl builder

    • workingDir

      default ExecComponentBuilderFactory.ExecComponentBuilder workingDir(String workingDir)
      The directory in which the command should be executed. If null, the working directory of the current process will be used. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      workingDir - the value to set
      Returns:
      the dsl builder

    • allowControlHeaders

      default ExecComponentBuilderFactory.ExecComponentBuilder allowControlHeaders(boolean allowControlHeaders)
      Whether to allow to use Camel headers or not (default false). Enabling this allows to specify dynamic command line arguments via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care. The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      allowControlHeaders - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default ExecComponentBuilderFactory.ExecComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • binding

      default ExecComponentBuilderFactory.ExecComponentBuilder binding(org.apache.camel.component.exec.ExecBinding binding)
      To use a custom org.apache.commons.exec.ExecBinding for advanced use-cases. The option is a: <code>org.apache.camel.component.exec.ExecBinding</code> type. Group: advanced
      Parameters:
      binding - the value to set
      Returns:
      the dsl builder

    • commandExecutor

      default ExecComponentBuilderFactory.ExecComponentBuilder commandExecutor(org.apache.camel.component.exec.ExecCommandExecutor commandExecutor)
      To use a custom org.apache.commons.exec.ExecCommandExecutor that customizes the command execution. The default command executor utilizes the commons-exec library, which adds a shutdown hook for every executed command. The option is a: <code>org.apache.camel.component.exec.ExecCommandExecutor</code> type. Group: advanced
      Parameters:
      commandExecutor - the value to set
      Returns:
      the dsl builder