org.apache.camel.builder.endpoint.dsl

Interface SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

SshEndpointBuilderFactory.AdvancedSshEndpointBuilder

Enclosing interface:

SshEndpointBuilderFactory

public static interface SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Advanced builder for endpoint consumers for the SSH component.

Method Summary

Modifier and Type	Method and Description
default SshEndpointBuilderFactory.SshEndpointConsumerBuilder	basic()
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder	basicPropertyBinding(boolean basicPropertyBinding) Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder	basicPropertyBinding(String basicPropertyBinding) Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder	channelType(String channelType) Sets the channel type to pass to the Channel as part of command execution.
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder	exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler) To let the consumer use a custom ExceptionHandler.
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder	exceptionHandler(String exceptionHandler) To let the consumer use a custom ExceptionHandler.
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder	exchangePattern(org.apache.camel.ExchangePattern exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder	exchangePattern(String exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder	pollStrategy(org.apache.camel.spi.PollingConsumerPollStrategy pollStrategy) A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder	pollStrategy(String pollStrategy) A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder	shellPrompt(String shellPrompt) Sets the shellPrompt to be dropped when response is read after command execution.
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder	sleepForShellPrompt(long sleepForShellPrompt) Sets the sleep period in milliseconds to wait reading response from shell prompt.
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder	sleepForShellPrompt(String sleepForShellPrompt) Sets the sleep period in milliseconds to wait reading response from shell prompt.
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder	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.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

basic

default SshEndpointBuilderFactory.SshEndpointConsumerBuilder basic()

exceptionHandler

default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)

exceptionHandler

default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder exceptionHandler(String exceptionHandler)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)

exchangePattern

default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)

Sets the exchange pattern when the consumer creates an exchange. The option is a: org.apache.camel.ExchangePattern type. Group: consumer (advanced)

exchangePattern

default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder exchangePattern(String exchangePattern)

Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a org.apache.camel.ExchangePattern type. Group: consumer (advanced)

pollStrategy

default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder pollStrategy(org.apache.camel.spi.PollingConsumerPollStrategy pollStrategy)

A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option is a: org.apache.camel.spi.PollingConsumerPollStrategy type. Group: consumer (advanced)

pollStrategy

default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder pollStrategy(String pollStrategy)

A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option will be converted to a org.apache.camel.spi.PollingConsumerPollStrategy type. Group: consumer (advanced)

basicPropertyBinding

default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder basicPropertyBinding(boolean basicPropertyBinding)

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced

basicPropertyBinding

default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder basicPropertyBinding(String basicPropertyBinding)

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option will be converted to a boolean type. Default: false Group: advanced

channelType

default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder channelType(String channelType)

Sets the channel type to pass to the Channel as part of command execution. Defaults to exec. The option is a: java.lang.String type. Default: exec Group: advanced

shellPrompt

default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder shellPrompt(String shellPrompt)

Sets the shellPrompt to be dropped when response is read after command execution. The option is a: java.lang.String type. Group: advanced

sleepForShellPrompt

default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder sleepForShellPrompt(long sleepForShellPrompt)

Sets the sleep period in milliseconds to wait reading response from shell prompt. Defaults to 100 milliseconds. The option is a: long type. Default: 100 Group: advanced

sleepForShellPrompt

default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder 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 long type. Default: 100 Group: advanced

synchronous

default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder 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: boolean type. Default: false Group: advanced

synchronous

default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder 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 boolean type. Default: false Group: advanced