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

Interface SshEndpointBuilderFactory.AdvancedSshEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder, SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder

Enclosing interface:

SshEndpointBuilderFactory

public static interface SshEndpointBuilderFactory.AdvancedSshEndpointBuilder
extends SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder, SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder

Advanced builder for endpoint for the SSH component.

Method Summary

Modifier and Type	Method	Description
default SshEndpointBuilderFactory.SshEndpointBuilder	basic()
default SshEndpointBuilderFactory.AdvancedSshEndpointBuilder	channelType(String channelType)	Sets the channel type to pass to the Channel as part of command execution.
default SshEndpointBuilderFactory.AdvancedSshEndpointBuilder	clientBuilder(String clientBuilder)	Instance of ClientBuilder used by the producer or consumer to create a new SshClient.
default SshEndpointBuilderFactory.AdvancedSshEndpointBuilder	clientBuilder(org.apache.sshd.client.ClientBuilder clientBuilder)	Instance of ClientBuilder used by the producer or consumer to create a new SshClient.
default SshEndpointBuilderFactory.AdvancedSshEndpointBuilder	compressions(String compressions)	Whether to use compression, and if so which.
default SshEndpointBuilderFactory.AdvancedSshEndpointBuilder	shellPrompt(String shellPrompt)	Sets the shellPrompt to be dropped when response is read after command execution.
default SshEndpointBuilderFactory.AdvancedSshEndpointBuilder	sleepForShellPrompt(long sleepForShellPrompt)	Sets the sleep period in milliseconds to wait reading response from shell prompt.
default SshEndpointBuilderFactory.AdvancedSshEndpointBuilder	sleepForShellPrompt(String sleepForShellPrompt)	Sets the sleep period in milliseconds to wait reading response from shell prompt.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder

bridgeErrorHandler, bridgeErrorHandler, exceptionHandler, exceptionHandler, exchangePattern, exchangePattern, pollStrategy, pollStrategy

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder

lazyStartProducer, lazyStartProducer

Method Details

basic

default SshEndpointBuilderFactory.SshEndpointBuilder basic()

Specified by:

basic in interface SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder

Specified by:

basic in interface SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder

channelType

default SshEndpointBuilderFactory.AdvancedSshEndpointBuilder 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

Specified by:

channelType in interface SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder

Specified by:

channelType in interface SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder

Parameters:

channelType - the value to set

Returns:

the dsl builder

clientBuilder

default SshEndpointBuilderFactory.AdvancedSshEndpointBuilder clientBuilder(org.apache.sshd.client.ClientBuilder clientBuilder)

Instance of ClientBuilder used by the producer or consumer to create a new SshClient. The option is a: <code>org.apache.sshd.client.ClientBuilder</code> type. Group: advanced

Specified by:

clientBuilder in interface SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder

Specified by:

clientBuilder in interface SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder

Parameters:

clientBuilder - the value to set

Returns:

the dsl builder

clientBuilder

default SshEndpointBuilderFactory.AdvancedSshEndpointBuilder clientBuilder(String clientBuilder)

Instance of ClientBuilder used by the producer or consumer to create a new SshClient. The option will be converted to a <code>org.apache.sshd.client.ClientBuilder</code> type. Group: advanced

Specified by:

clientBuilder in interface SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder

Specified by:

clientBuilder in interface SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder

Parameters:

clientBuilder - the value to set

Returns:

the dsl builder

compressions

default SshEndpointBuilderFactory.AdvancedSshEndpointBuilder compressions(String compressions)

Whether to use compression, and if so which. The option is a: <code>java.lang.String</code> type. Group: advanced

Specified by:

compressions in interface SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder

Specified by:

compressions in interface SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder

Parameters:

compressions - the value to set

Returns:

the dsl builder

shellPrompt

default SshEndpointBuilderFactory.AdvancedSshEndpointBuilder 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

Specified by:

shellPrompt in interface SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder

Specified by:

shellPrompt in interface SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder

Parameters:

shellPrompt - the value to set

Returns:

the dsl builder

sleepForShellPrompt

default SshEndpointBuilderFactory.AdvancedSshEndpointBuilder 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

Specified by:

sleepForShellPrompt in interface SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder

Specified by:

sleepForShellPrompt in interface SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder

Parameters:

sleepForShellPrompt - the value to set

Returns:

the dsl builder

sleepForShellPrompt

default SshEndpointBuilderFactory.AdvancedSshEndpointBuilder 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

Specified by:

sleepForShellPrompt in interface SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder

Specified by:

sleepForShellPrompt in interface SshEndpointBuilderFactory.AdvancedSshEndpointProducerBuilder

Parameters:

sleepForShellPrompt - the value to set

Returns:

the dsl builder