Package com.sshtools.ssh

This package contains a set of general interface contracts for SSH communication.

See: Description

Interface Summary

Interface	Description
ChannelEventListener	An event interface that provides notifications of SshChannel events.
Client
ForwardingRequestListener	This interface is required when a request for remote port forwarding is made.
HostKeyVerification	This interface provides a callback method so that the user can verify the identity of the server (by checking the public key) during the initial protocol negotiation.
SocketTimeoutSupport	This interface adds timeout support to the SocketTransport interface.
SshAuthentication	The base interface for all SSH authentication mechanisms and authentication result constants.
SshChannel	The base interface for all SSH channels.
SshClient	This interface defines the general contract for an SSH client that is compatible for both the SSH1 and SSH2 protocols.
SshContext	This interface defines the general configuration items available to both SSH1 and SSH2.
SshIO	Base interface for all SSH related IO interfaces.
SshSession	Base interface for SSH sessions supporting all the features common to both SSH1 and SSH2.
SshTransport	Simple interface wrapper for transport layer communication.
SshTunnel	Interface defining the contract for SSH forwarding channels.

Class Summary

Class	Description
ChannelAdapter	An adapter for the ChannelEventListener.
CommandExecutor	Deprecated
Packet	A utility class that provides the SSH layers with the ability to dynamically write an SSH packet.
PasswordAuthentication	Basic password authentication class used for SSH password authentication.
PseudoTerminalModes	When a client requests a pseudo terminal it informs the server of any terminal modes that it knows of.
PublicKeyAuthentication	Public key based authentication implementation.
SshConnector	This utility class establishes a connection with an SSH server, determines which SSH protocol versions are supported and creates an initialized connection ready for authentication.
SshKeyFingerprint	Utility methods to generate an SSH public key fingerprint.
SubsystemChannel	This class provides useful methods for implementing an SSH2 subsystem.

Exception Summary

Exception	Description
ChannelOpenException	Exception thrown when a channel cannot be opened, the reason for which should be specified in with any of the constants defined here.
SshException	Generic exception for J2SSH Maverick exception handling.
SshIOException	This class is provided so that when a channel InputStream/OutputStream interface has to throw an IOException; the real SshException cause can be retrieved.

Package com.sshtools.ssh Description

This package contains a set of general interface contracts for SSH communication. To connect to an SSH server you need to use SshConnector to get a reference to an SshClient. Once a client instance is obtained you can proceed to authenticate the user and start a session.