Since we're on a major migration process of this website, some component documents here are out of sync right now. In the meantime you may want to look at the early version of the new website
https://camel.apache.org/staging/
We would very much like to receive any feedback on the new site, please join the discussion on the Camel user mailing list.

Jsch

The camel-jsch component supports the SCP protocol using the Client API of the Jsch project. Jsch is already used in camel by the FTP component for the sftp: protocol.

Maven users will need to add the following dependency to their pom.xml for this component:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-jsch</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

URI format

scp://host[:port]/destination[?options]

You can append query options to the URI in the following format, ?option=value&option=value&...

The file name can be specified either in the <path> part of the URI or as a "CamelFileName" header on the message (Exchange.FILE_NAME if used in code).

Options

 

Name

Description

Default Value

username

Specifies the username to use to log in to the remote file system.

null

password

Specifies the password to use to log in to the remote file system.

null

knownHostsFile

Sets the known_hosts file, so that the scp endpoint can do host key verification.

null

strictHostKeyChecking

Sets whether to use strict host key checking. Possible values are: no, yes

no

chmod

Allows you to set chmod on the stored file. For example chmod=664.

null

useUserKnownHostsFileCamel 2.15: If knownHostFile has not been explicit configured, then use the host file from
System.getProperty("user.home") + "/.ssh/known_hosts"		true

Component Options

The JschComponent supports the following options

Name

Description

Default Value

verboseLogging

Camel 2.15: JSCH is verbose logging out of the box. Therefore we turn the logging down to DEBUG logging by default.

true

Limitations

Currently camel-jsch only supports a Producer (i.e. copy files to another host). 

See Also
© 2004-2015 The Apache Software Foundation.
Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
Graphic Design By Hiram