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

Interface SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    SshEndpointBuilderFactory.AdvancedSshEndpointBuilder
    Enclosing interface:
    SshEndpointBuilderFactory
    public static interface SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Advanced builder for endpoint producers for the SSH component.

    • Method Detail

      • lazyStartProducer

        default SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder 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 (advanced)
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder 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 (advanced)
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • channelType

        default SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder channelType​(String channelType)
        Sets the channel type to pass to the Channel as part of command execution. Defaults to exec. The option is a: <code>java.lang.String</code> type. Default: exec Group: advanced
        Parameters:
        channelType - the value to set
        Returns:
        the dsl builder

      • shellPrompt

        default SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder shellPrompt​(String shellPrompt)
        Sets the shellPrompt to be dropped when response is read after command execution. The option is a: <code>java.lang.String</code> type. Group: advanced
        Parameters:
        shellPrompt - the value to set
        Returns:
        the dsl builder

      • sleepForShellPrompt

        default SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder sleepForShellPrompt​(long sleepForShellPrompt)
        Sets the sleep period in milliseconds to wait reading response from shell prompt. Defaults to 100 milliseconds. The option is a: <code>long</code> type. Default: 100 Group: advanced
        Parameters:
        sleepForShellPrompt - the value to set
        Returns:
        the dsl builder

      • sleepForShellPrompt

        default SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder sleepForShellPrompt​(String sleepForShellPrompt)
        Sets the sleep period in milliseconds to wait reading response from shell prompt. Defaults to 100 milliseconds. The option will be converted to a <code>long</code> type. Default: 100 Group: advanced
        Parameters:
        sleepForShellPrompt - the value to set
        Returns:
        the dsl builder