Package org.apache.camel.builder.endpoint.dsl

Interface ExecEndpointBuilderFactory.ExecEndpointBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    Enclosing interface:
    ExecEndpointBuilderFactory
    public static interface ExecEndpointBuilderFactory.ExecEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint for the Exec component.

    • Method Detail

      • args

        default ExecEndpointBuilderFactory.ExecEndpointBuilder args​(String args)
        The arguments may be one or many whitespace-separated tokens. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        args - the value to set
        Returns:
        the dsl builder

      • binding

        default ExecEndpointBuilderFactory.ExecEndpointBuilder binding​(Object binding)
        A reference to a org.apache.commons.exec.ExecBinding in the Registry. The option is a: <code>org.apache.camel.component.exec.ExecBinding</code> type. Group: producer
        Parameters:
        binding - the value to set
        Returns:
        the dsl builder

      • binding

        default ExecEndpointBuilderFactory.ExecEndpointBuilder binding​(String binding)
        A reference to a org.apache.commons.exec.ExecBinding in the Registry. The option will be converted to a <code>org.apache.camel.component.exec.ExecBinding</code> type. Group: producer
        Parameters:
        binding - the value to set
        Returns:
        the dsl builder

      • commandExecutor

        default ExecEndpointBuilderFactory.ExecEndpointBuilder commandExecutor​(Object 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. The option is a: <code>org.apache.camel.component.exec.ExecCommandExecutor</code> type. Group: producer
        Parameters:
        commandExecutor - the value to set
        Returns:
        the dsl builder

      • commandExecutor

        default ExecEndpointBuilderFactory.ExecEndpointBuilder commandExecutor​(String 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. The option will be converted to a <code>org.apache.camel.component.exec.ExecCommandExecutor</code> type. Group: producer
        Parameters:
        commandExecutor - the value to set
        Returns:
        the dsl builder

      • commandLogLevel

        default ExecEndpointBuilderFactory.ExecEndpointBuilder commandLogLevel​(org.apache.camel.LoggingLevel commandLogLevel)
        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). The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: DEBUG Group: producer
        Parameters:
        commandLogLevel - the value to set
        Returns:
        the dsl builder

      • commandLogLevel

        default ExecEndpointBuilderFactory.ExecEndpointBuilder commandLogLevel​(String commandLogLevel)
        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). The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: DEBUG Group: producer
        Parameters:
        commandLogLevel - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default ExecEndpointBuilderFactory.ExecEndpointBuilder 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

      • lazyStartProducer

        default ExecEndpointBuilderFactory.ExecEndpointBuilder lazyStartProducer​(String 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 will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • outFile

        default ExecEndpointBuilderFactory.ExecEndpointBuilder outFile​(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. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        outFile - the value to set
        Returns:
        the dsl builder

      • timeout

        default ExecEndpointBuilderFactory.ExecEndpointBuilder 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

      • timeout

        default ExecEndpointBuilderFactory.ExecEndpointBuilder timeout​(String 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 will be converted to a <code>long</code> type. Group: producer
        Parameters:
        timeout - the value to set
        Returns:
        the dsl builder

      • useStderrOnEmptyStdout

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

      • useStderrOnEmptyStdout

        default ExecEndpointBuilderFactory.ExecEndpointBuilder useStderrOnEmptyStdout​(String 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. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        useStderrOnEmptyStdout - the value to set
        Returns:
        the dsl builder

      • workingDir

        default ExecEndpointBuilderFactory.ExecEndpointBuilder 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