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
All Methods Instance Methods Default Methods Modifier and Type Method Description default SshEndpointBuilderFactory.SshEndpointConsumerBuilder
basic()
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder
bridgeErrorHandler(boolean bridgeErrorHandler)
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder
bridgeErrorHandler(String bridgeErrorHandler)
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder
channelType(String channelType)
Sets the channel type to pass to the Channel as part of command execution.default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder
exceptionHandler(String exceptionHandler)
To let the consumer use a custom ExceptionHandler.default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder
exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)
To let the consumer use a custom ExceptionHandler.default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder
exchangePattern(String exchangePattern)
Sets the exchange pattern when the consumer creates an exchange.default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder
exchangePattern(org.apache.camel.ExchangePattern exchangePattern)
Sets the exchange pattern when the consumer creates an exchange.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
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
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.
-
-
-
Method Detail
-
basic
default SshEndpointBuilderFactory.SshEndpointConsumerBuilder basic()
-
bridgeErrorHandler
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)- Parameters:
bridgeErrorHandler
- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)- Parameters:
bridgeErrorHandler
- the value to set- Returns:
- the dsl builder
-
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: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)- Parameters:
exceptionHandler
- the value to set- Returns:
- the dsl builder
-
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 <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)- Parameters:
exceptionHandler
- the value to set- Returns:
- the dsl builder
-
exchangePattern
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)
Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)- Parameters:
exchangePattern
- the value to set- Returns:
- the dsl builder
-
exchangePattern
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder exchangePattern(String exchangePattern)
Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)- Parameters:
exchangePattern
- the value to set- Returns:
- the dsl builder
-
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: <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type. Group: consumer (advanced)- Parameters:
pollStrategy
- the value to set- Returns:
- the dsl builder
-
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 <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type. Group: consumer (advanced)- Parameters:
pollStrategy
- the value to set- Returns:
- the dsl builder
-
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: <code>java.lang.String</code> type. Default: exec Group: advanced- Parameters:
channelType
- the value to set- Returns:
- the dsl builder
-
shellPrompt
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder 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.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: <code>long</code> type. Default: 100 Group: advanced- Parameters:
sleepForShellPrompt
- the value to set- Returns:
- the dsl builder
-
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 <code>long</code> type. Default: 100 Group: advanced- Parameters:
sleepForShellPrompt
- the value to set- Returns:
- the dsl builder
-
-