Package com.jcraft.jsch

Java Secure Channel - main package.

See: Description

Interface Summary

Interface	Description
ChannelSftp.LsEntrySelector	Objects implementing this interface can be passed as an argument for ChannelSftp's ChannelSftp.ls(java.lang.String) method.
ConfigRepository	A repository for host-specific configuration settings, retrievable by host name (or an alias).
ConfigRepository.Config	A configuration for connections to a remote host name (or alias).
ForwardedTCPIPDaemon	A local deamon process executed when a host connects to to a forwarded port at the remote side.
HostKeyRepository	A repository for known host keys.
Identity	A user identity for public-key authentication.
IdentityRepository	A repository for identities (basically key pairs usable for authentication to a server).
Logger	Provides logging abilities to the library.
Proxy	Allows routing connections through some proxy.
Random	A random number generator.
ServerSocketFactory	A factory for ServerSockets.
SftpProgressMonitor	A callback to get information about the progress of a file transfer operation.
SocketFactory	A factory for (client) sockets.
UIKeyboardInteractive	Provides a way to prompt the user for keyboard-interactive authentication.
UserInfo	Allows user interaction.

Class Summary

Class	Description
Channel	The abstract base class for the different types of channel which may be associated with a Session.
ChannelDirectTCPIP	A Channel which allows forwarding a pair of local streams to/from a TCP-connection to a server on the remote side.
ChannelExec	A channel connected to a remotely executing program.
ChannelForwardedTCPIP	A Channel created when a forwarded port at the remote side is connected.
ChannelSftp	A Channel connected to an sftp server (as a subsystem of the ssh server).
ChannelShell	A channel connected to a remote shell.
ChannelSubsystem	A channel connected to a subsystem of the server process.
HostKey	The public key of a SSH server.
IdentityRepository.Wrapper	JSch will accept ciphered keys, but some implementations of IdentityRepository can not.
JSch	This class serves as a central configuration point, and as a factory for Session objects configured with these settings.
ProxyHTTP	A Proxy implementation using a HTTP proxy.
ProxySOCKS4	A Proxy implementation using a SOCKS V5 proxy.
ProxySOCKS5	A Proxy implementation using a SOCKS V5 proxy.
Session	A Session represents a connection to a SSH server.
SftpATTRS	Attributes of a (remote) file manipulated via Sftp.

Exception Summary

Exception	Description
JSchException	Will be thrown if anything goes wrong with the SSH protocol.
SftpException	This exception will be thrown if anything goes wrong while using the SFTP protocol.

Package com.jcraft.jsch Description

Java Secure Channel - main package. This package contains all types applications using the library have to know (and lots they don't have to know).

Here is an overview about the most important ones:

JSch

The starting point, used to create sessions and manage identities.

Session

A connection to a SSH server. Used to configure settings, port forwardings and to open channels.

Channel

and its subclasses ChannelExec, ChannelShell, ChannelSubsystem for remote command execution.

ChannelSftp

for secure file transfer. You might then also need SftpATTRS and implement SftpProgressMonitor.

UserInfo and UIKeyboardInteractive

should be implemented to allow feedback to the user and/or password or keyboard-interactive authentication.

Most other classes are either for internal use (see next paragraph) or for special uses, and not necessary for a normal application.

The string Usually not to be used by applications. at the beginning of a class or interface description means that this type is used internally by the library, and normally there is no need for an application to directly use (or implement/extend) this type. It may be needed if you need to extend functionality, then you normally will also have to change some configuration options.