SCP

SCP

Scheme: scp
Syntax: scp:host:port/directoryName
Description: To copy files using the secure copy protocol (SCP).
Deprecated:false
Maven: org.apache.camel/camel-jsch/2.17.0.redhat-630416

To copy files using the secure copy protocol (SCP).

Name Kind Group Required Default Type Enum Description
host path producer true java.lang.String
port path producer int
directoryName path producer java.lang.String
bridgeErrorHandler parameter consumer boolean 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/ERROR level and ignored.
delete parameter consumer boolean
moveFailed parameter consumer java.lang.String
noop parameter consumer boolean
preMove parameter consumer java.lang.String
recursive parameter consumer boolean
sendEmptyMessageWhenIdle parameter consumer boolean If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
streamDownload parameter consumer boolean
directoryMustExist parameter consumer (advanced) boolean
exceptionHandler parameter consumer (advanced) org.apache.camel.spi.ExceptionHandler To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored.
ignoreFileNotFoundOrPermissionError parameter consumer (advanced) boolean
inProgressRepository parameter consumer (advanced) org.apache.camel.spi.IdempotentRepository
localWorkDirectory parameter consumer (advanced) java.lang.String
onCompletionExceptionHandler parameter consumer (advanced) org.apache.camel.spi.ExceptionHandler
pollStrategy parameter consumer (advanced) org.apache.camel.spi.PollingConsumerPollStrategy 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.
processStrategy parameter consumer (advanced) org.apache.camel.component.file.GenericFileProcessStrategy
receiveBufferSize parameter consumer (advanced) 32768 int
startingDirectoryMustExist parameter consumer (advanced) boolean
useList parameter consumer (advanced) true boolean
binary parameter producer boolean
charset parameter producer java.lang.String
chmod parameter producer 664 java.lang.String Allows you to set chmod on the stored file. For example chmod=664.
ciphers parameter producer java.lang.String Set a comma separated list of ciphers that will be used in order of preference. Possible cipher names are defined by JCraft JSCH. Some examples include: aes128-ctr,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,aes192-cbc,aes256-cbc. If not specified the default list from JSCH will be used.
disconnect parameter producer boolean
doneFileName parameter producer java.lang.String
download parameter producer boolean
fastExistsCheck parameter producer boolean
fileExist parameter producer Override org.apache.camel.component.file.GenericFileExist Override
Append
Fail
Ignore
Move
TryRename
fileName parameter producer java.lang.String
flatten parameter producer boolean
knownHostsFile parameter producer java.lang.String Sets the known_hosts file, so that the jsch endpoint can do host key verification.
maximumReconnectAttempts parameter producer int
moveExisting parameter producer java.lang.String
passiveMode parameter producer boolean
privateKeyBytes parameter producer byte[] Set the private key bytes to that the endpoint can do private key verification. This must be used only if privateKeyFile wasn't set. Otherwise the file will have the priority.
privateKeyFile parameter producer java.lang.String Set the private key file to that the SFTP endpoint can do private key verification.
privateKeyFilePassphrase parameter producer java.lang.String Set the private key file passphrase to that the SFTP endpoint can do private key verification.
reconnectDelay parameter producer long
separator parameter producer UNIX org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator
strictHostKeyChecking parameter producer no java.lang.String no
yes
Sets whether to use strict host key checking. Possible values are: no, yes
tempFileName parameter producer java.lang.String
tempPrefix parameter producer java.lang.String
useUserKnownHostsFile parameter producer true boolean If knownHostFile has not been explicit configured, then use the host file from System.getProperty("user.home") + "/.ssh/known_hosts"
allowNullBody parameter producer (advanced) boolean
eagerDeleteTargetFile parameter producer (advanced) true boolean
keepLastModified parameter producer (advanced) boolean
sendNoop parameter producer (advanced) true boolean
autoCreate parameter advanced true boolean
bufferSize parameter advanced 131072 int
connectTimeout parameter advanced 10000 int
exchangePattern parameter advanced InOnly org.apache.camel.ExchangePattern InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange
siteCommand parameter advanced java.lang.String
soTimeout parameter advanced 300000 int
stepwise parameter advanced true boolean
synchronous parameter advanced false boolean Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
throwExceptionOnConnectFailed parameter advanced boolean
timeout parameter advanced 30000 int
antExclude parameter filter java.lang.String
antFilterCaseSensitive parameter filter true boolean
antInclude parameter filter java.lang.String
eagerMaxMessagesPerPoll parameter filter true boolean
exclude parameter filter java.lang.String
filter parameter filter org.apache.camel.component.file.GenericFileFilter
idempotent parameter filter false java.lang.Boolean
idempotentKey parameter filter java.lang.String
idempotentRepository parameter filter org.apache.camel.spi.IdempotentRepository
include parameter filter java.lang.String
maxDepth parameter filter 2147483647 int
maxMessagesPerPoll parameter filter int
minDepth parameter filter int
move parameter filter java.lang.String
exclusiveReadLockStrategy parameter lock org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy
readLock parameter lock java.lang.String none
markerFile
fileLock
rename
changed
idempotent
readLockCheckInterval parameter lock 1000 long
readLockDeleteOrphanLockFiles parameter lock true boolean
readLockLoggingLevel parameter lock WARN org.apache.camel.LoggingLevel TRACE
DEBUG
INFO
WARN
ERROR
OFF
readLockMarkerFile parameter lock true boolean
readLockMinAge parameter lock 0 long
readLockMinLength parameter lock 1 long
readLockRemoveOnCommit parameter lock boolean
readLockRemoveOnRollback parameter lock true boolean
readLockTimeout parameter lock 10000 long
backoffErrorThreshold parameter scheduler int The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
backoffIdleThreshold parameter scheduler int The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
backoffMultiplier parameter scheduler int 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.
delay parameter scheduler 500 long Milliseconds before the next poll.
greedy parameter scheduler boolean If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
initialDelay parameter scheduler 1000 long Milliseconds before the first poll starts.
runLoggingLevel parameter scheduler TRACE org.apache.camel.LoggingLevel TRACE
DEBUG
INFO
WARN
ERROR
OFF
The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
scheduledExecutorService parameter scheduler java.util.concurrent.ScheduledExecutorService Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
scheduler parameter scheduler none org.apache.camel.spi.ScheduledPollConsumerScheduler none
spring
quartz2
To use a cron scheduler from either camel-spring or camel-quartz2 component
schedulerProperties parameter scheduler java.util.Map To configure additional properties when using a custom scheduler or any of the Quartz2, Spring based scheduler.
startScheduler parameter scheduler true boolean Whether the scheduler should be auto started.
timeUnit parameter scheduler MILLISECONDS java.util.concurrent.TimeUnit NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS
Time unit for initialDelay and delay options.
useFixedDelay parameter scheduler true boolean Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
shuffle parameter sort boolean
sortBy parameter sort java.lang.String
sorter parameter sort java.util.Comparator>
password parameter security java.lang.String
username parameter security java.lang.String