SshComponentBuilderFactory.SshComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.ssh.SshComponent>

All Known Implementing Classes:

SshComponentBuilderFactory.SshComponentBuilderImpl

Enclosing interface:

SshComponentBuilderFactory
```
public static interface SshComponentBuilderFactory.SshComponentBuilder
extends ComponentBuilder<org.apache.camel.component.ssh.SshComponent>
```
Builder for the SSH component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default SshComponentBuilderFactory.SshComponentBuilder`	`basicPropertyBinding(boolean basicPropertyBinding)` Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default SshComponentBuilderFactory.SshComponentBuilder`	`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 SshComponentBuilderFactory.SshComponentBuilder`	`certResource(String certResource)` Sets the resource path of the certificate to use for Authentication.
`default SshComponentBuilderFactory.SshComponentBuilder`	`certResourcePassword(String certResourcePassword)` Sets the password to use in loading certResource, if certResource is an encrypted key.
`default SshComponentBuilderFactory.SshComponentBuilder`	`channelType(String channelType)` Sets the channel type to pass to the Channel as part of command execution.
`default SshComponentBuilderFactory.SshComponentBuilder`	`configuration(org.apache.camel.component.ssh.SshConfiguration configuration)` Component configuration.
`default SshComponentBuilderFactory.SshComponentBuilder`	`failOnUnknownHost(boolean failOnUnknownHost)` Specifies whether a connection to an unknown host should fail or not.
`default SshComponentBuilderFactory.SshComponentBuilder`	`keyPairProvider(org.apache.sshd.common.keyprovider.KeyPairProvider keyPairProvider)` Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server.
`default SshComponentBuilderFactory.SshComponentBuilder`	`keyType(String keyType)` Sets the key type to pass to the KeyPairProvider as part of authentication.
`default SshComponentBuilderFactory.SshComponentBuilder`	`knownHostsResource(String knownHostsResource)` Sets the resource path for a known_hosts file.
`default SshComponentBuilderFactory.SshComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default SshComponentBuilderFactory.SshComponentBuilder`	`password(String password)` Sets the password to use in connecting to remote SSH server.
`default SshComponentBuilderFactory.SshComponentBuilder`	`pollCommand(String pollCommand)` Sets the command string to send to the remote SSH server during every poll cycle.
`default SshComponentBuilderFactory.SshComponentBuilder`	`shellPrompt(String shellPrompt)` Sets the shellPrompt to be dropped when response is read after command execution.
`default SshComponentBuilderFactory.SshComponentBuilder`	`sleepForShellPrompt(long sleepForShellPrompt)` Sets the sleep period in milliseconds to wait reading response from shell prompt.
`default SshComponentBuilderFactory.SshComponentBuilder`	`timeout(long timeout)` Sets the timeout in milliseconds to wait in establishing the remote SSH server connection.
`default SshComponentBuilderFactory.SshComponentBuilder`	`username(String username)` Sets the username to use in logging into the remote SSH server.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - failOnUnknownHost
```
default SshComponentBuilderFactory.SshComponentBuilder failOnUnknownHost(boolean failOnUnknownHost)
```
    Specifies whether a connection to an unknown host should fail or not. This value is only checked when the property knownHosts is set. The option is a: boolean type. Default: false Group: common
  - knownHostsResource
```
default SshComponentBuilderFactory.SshComponentBuilder knownHostsResource(String knownHostsResource)
```
    Sets the resource path for a known_hosts file. The option is a: java.lang.String type. Group: common
  - timeout
```
default SshComponentBuilderFactory.SshComponentBuilder timeout(long timeout)
```
    Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. The option is a: long type. Default: 30000 Group: common
  - bridgeErrorHandler
```
default SshComponentBuilderFactory.SshComponentBuilder 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: boolean type. Default: false Group: consumer
  - pollCommand
```
default SshComponentBuilderFactory.SshComponentBuilder pollCommand(String pollCommand)
```
    Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer, i.e. from(ssh://...) You may need to end your command with a newline, and that must be URL encoded %0A. The option is a: java.lang.String type. Group: consumer
  - lazyStartProducer
```
default SshComponentBuilderFactory.SshComponentBuilder 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: boolean type. Default: false Group: producer
  - basicPropertyBinding
```
default SshComponentBuilderFactory.SshComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)
```
    Whether the component 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
  - channelType
```
default SshComponentBuilderFactory.SshComponentBuilder 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
  - configuration
```
default SshComponentBuilderFactory.SshComponentBuilder configuration(org.apache.camel.component.ssh.SshConfiguration configuration)
```
    Component configuration. The option is a: org.apache.camel.component.ssh.SshConfiguration type. Group: advanced
  - shellPrompt
```
default SshComponentBuilderFactory.SshComponentBuilder 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 SshComponentBuilderFactory.SshComponentBuilder 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
  - certResource
```
default SshComponentBuilderFactory.SshComponentBuilder certResource(String certResource)
```
    Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate, and depends on keyType setting. The option is a: java.lang.String type. Group: security
  - certResourcePassword
```
default SshComponentBuilderFactory.SshComponentBuilder certResourcePassword(String certResourcePassword)
```
    Sets the password to use in loading certResource, if certResource is an encrypted key. The option is a: java.lang.String type. Group: security
  - keyPairProvider
```
default SshComponentBuilderFactory.SshComponentBuilder keyPairProvider(org.apache.sshd.common.keyprovider.KeyPairProvider keyPairProvider)
```
    Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server. The option is a: org.apache.sshd.common.keyprovider.KeyPairProvider type. Group: security
  - keyType
```
default SshComponentBuilderFactory.SshComponentBuilder keyType(String keyType)
```
    Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. From Camel 3.0.0 / 2.25.0, by default Camel will select the first available KeyPair that is loaded. Prior to this, a KeyType of 'ssh-rsa' was enforced by default. The option is a: java.lang.String type. Group: security
  - password
```
default SshComponentBuilderFactory.SshComponentBuilder password(String password)
```
    Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null. The option is a: java.lang.String type. Group: security
  - username
```
default SshComponentBuilderFactory.SshComponentBuilder username(String username)
```
    Sets the username to use in logging into the remote SSH server. The option is a: java.lang.String type. Group: security

Interface SshComponentBuilderFactory.SshComponentBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

Method Detail

failOnUnknownHost

knownHostsResource

timeout

bridgeErrorHandler

pollCommand

lazyStartProducer

basicPropertyBinding

channelType

configuration

shellPrompt

sleepForShellPrompt

certResource

certResourcePassword

keyPairProvider

keyType

password

username