Package com.maverick.ssh

This package contains a set of general interface contracts for SSH communication that provide the core set of functionality available in both the SSH1 and SSH2 protocol specifications.

See: Description

Interface Summary

Interface	Description
ChannelEventListener	An event interface that provides notifications of SshChannel events.
Client
ExecutorOperationListener
ExecutorServiceProvider
ForwardingRequestListener	This interface is required when a request for remote port forwarding is made.
HostKeyUpdater
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.
SecureComponent
SecurityPolicy
ShellMatcher
ShellReader
ShellStartupTrigger
ShellWriter
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.
SshClientConnector
SshClientListener
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
AdaptiveConfiguration
AdaptiveSecurityPolicy
ChannelAdapter	An adapter for the ChannelEventListener.
ConfigurationCollector
DefaultSecurityPolicy
ExecutorOperationSupport<T extends ExecutorServiceProvider>
IncompatibleAlgorithm
LicenseManager	Add your license using the static method provided by this class.
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.
Shell
ShellController
ShellDefaultMatcher
ShellProcess
ShellProcessController
ShellStartupPasswordTrigger
SshClientAdapter
SshCompatibilityUtils
SshConnector	Connecting to an SSH server STARTS HERE!.
SshDiagnostics
SshKeyFingerprint	Utility methods to generate an SSH public key fingerprint.
SshKeyUtils
SshReporter
SshTests
SubsystemChannel	This class provides useful methods for implementing an SSH2 subsystem.

Enum Summary

Enum	Description
IncompatibleAlgorithm.ComponentType
SecurityLevel
ShellMatcher.Continue
SshKeyFingerprint.Encoding

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.
ShellTimeoutException	Exception thrown when an operation times out.
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.maverick.ssh Description

This package contains a set of general interface contracts for SSH communication that provide the core set of functionality available in both the SSH1 and SSH2 protocol specifications. To connect to an SSH server you need to use SshConnector to get a reference to an SshClient which will either be an instance of Ssh2Client or Ssh2Client. Once a client instance is obtained you can proceed to authenticate the user and start a session. Features specific to a single protocol are not accessible through these interfaces, to use the these features you can check the instance at runtime and cast into the implementation class.