Represents an SSH endpoint.
Name | Kind | Type | Required | Deprecated | Default Value | Enum Values | Description |
---|---|---|---|---|---|---|---|
host | path | java.lang.String | true | false | Sets the hostname of the remote SSH server. @param host String representing hostname of SSH server. | ||
port | path | int | false | Sets the port number for the remote SSH server. @param port int representing port number on remote host. Defaults to 22. | |||
username | parameter | java.lang.String | false | Sets the username to use in logging into the remote SSH server. @param username String representing login username. | |||
password | parameter | java.lang.String | false | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null. @param password String representing password for username at remote host. | |||
pollCommand | parameter | java.lang.String | false | 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://...") @param pollCommand String representing the command to send. | |||
keyType | parameter | java.lang.String | false | ssh-rsa | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to "ssh-rsa". @param keyType String defining the type of KeyPair to use for authentication. @see KeyPairProvider | ||
certResource | parameter | java.lang.String | false | Sets the resource path of the certificate to use for Authentication. Will use {@link ResourceHelperKeyPairProvider} to resolve file based certificate, and depends on keyType setting. @param certResource String file, classpath, or http url for the certificate | |||
timeout | parameter | long | false | 30000 | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. @param timeout long milliseconds to wait. | ||
startScheduler | parameter | boolean | false | true | Whether the scheduler should be auto started. | ||
initialDelay | parameter | long | false | 1000 | Milliseconds before the first poll starts. | ||
delay | parameter | long | false | 500 | Milliseconds before the next poll. | ||
timeUnit | parameter | java.util.concurrent.TimeUnit | false | MILLISECONDS | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS |
Time unit for initialDelay and delay options. | |
useFixedDelay | parameter | boolean | false | true | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | ||
pollStrategy | parameter | org.apache.camel.spi.PollingConsumerPollStrategy | false | 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. | |||
runLoggingLevel | parameter | org.apache.camel.LoggingLevel | false | TRACE | DEBUG ERROR INFO TRACE WARN OFF |
The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | |
sendEmptyMessageWhenIdle | parameter | boolean | false | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | |||
greedy | parameter | boolean | false | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | |||
scheduler | parameter | org.apache.camel.spi.ScheduledPollConsumerScheduler | false | spring quartz2 |
To use a cron scheduler from either camel-spring or camel-quartz2 component | ||
schedulerProperties | parameter | java.util.Map |
false | To configure additional properties when using a custom scheduler or any of the Quartz2, Spring based scheduler. | |||
scheduledExecutorService | parameter | java.util.concurrent.ScheduledExecutorService | false | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | |||
backoffMultiplier | parameter | int | false | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | |||
backoffIdleThreshold | parameter | int | false | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | |||
backoffErrorThreshold | parameter | int | false | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | |||
exchangePattern | parameter | org.apache.camel.ExchangePattern | false | InOnly | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the default exchange pattern when creating an exchange | |
synchronous | parameter | boolean | false | false | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). |