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 Summary

Modifier and Type	Method and Description
default SshEndpointBuilderFactory.SshEndpointProducerBuilder	basic()
default SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder	channelType(String channelType) Sets the channel type to pass to the Channel as part of command execution.
default SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder	shellPrompt(String shellPrompt) Sets the shellPrompt to be dropped when response is read after command execution.
default SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder	sleepForShellPrompt(long sleepForShellPrompt) Sets the sleep period in milliseconds to wait reading response from shell prompt.
default SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder	sleepForShellPrompt(String sleepForShellPrompt) Sets the sleep period in milliseconds to wait reading response from shell prompt.
default SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
default SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder	synchronous(String synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

basic

default SshEndpointBuilderFactory.SshEndpointProducerBuilder basic()

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

synchronous

default SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder synchronous(boolean synchronous)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

synchronous - the value to set

Returns:

the dsl builder

synchronous

default SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder synchronous(String synchronous)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

synchronous - the value to set

Returns:

the dsl builder