A B C D E F G H I K L M O P Q R S T U V W X _

A

ADMINISTRATIVIVELY_PROHIBITED - Static variable in class com.maverick.ssh2.ChannelOpenException
The administrator does not permit this channel to be opened
AES128Cbc - class com.sshtools.cipher.AES128Cbc.
This cipher can optionally be added to the J2SSH Maverick API.
AES128Cbc() - Constructor for class com.sshtools.cipher.AES128Cbc
 
AES128_CBC - Static variable in class com.sshtools.cipher.AES128Cbc
 
AES192Cbc - class com.sshtools.cipher.AES192Cbc.
This cipher can optionally be added to the J2SSH Maverick API.
AES192Cbc() - Constructor for class com.sshtools.cipher.AES192Cbc
 
AES192_CBC - Static variable in class com.sshtools.cipher.AES192Cbc
 
AES256Cbc - class com.sshtools.cipher.AES256Cbc.
This cipher can optionally be added to the J2SSH Maverick API.
AES256Cbc() - Constructor for class com.sshtools.cipher.AES256Cbc
 
AES256_CBC - Static variable in class com.sshtools.cipher.AES256Cbc
 
AESEngine - class com.sshtools.cipher.AESEngine.
An implementation of the AES (Rijndael), from FIPS-197.
AESEngine() - Constructor for class com.sshtools.cipher.AESEngine
 
AbstractComponentFactory - class com.maverick.ssh2.AbstractComponentFactory.
An abstract utility class used to store the available transport components and provide delimited listing as required in the key exchange initialization process.
AbstractComponentFactory(Class) - Constructor for class com.maverick.ssh2.AbstractComponentFactory
Create a component factory with the base class supplied.
AbstractKnownHostsKeyVerification - class com.sshtools.publickey.AbstractKnownHostsKeyVerification.
An abstract HostKeyVerification class implementation providing validation against the known_hosts format.
AbstractKnownHostsKeyVerification() - Constructor for class com.sshtools.publickey.AbstractKnownHostsKeyVerification
Construct a known_hosts database based on the default path of ~/.ssh/known_hosts.
AbstractKnownHostsKeyVerification(String) - Constructor for class com.sshtools.publickey.AbstractKnownHostsKeyVerification
Constructs a known_hosts database based on the path provided.
add(String, Class) - Method in class com.maverick.ssh2.AbstractComponentFactory
Add a new component type to the factory.
addChannelEventListener(ChannelEventListener) - Method in interface com.maverick.ssh.SshChannel
Provides an event listening mechanism.
addChannelEventListener(ChannelEventListener) - Method in class com.maverick.ssh2.Ssh2Channel
 
addChannelFactory(ChannelFactory) - Method in class com.maverick.ssh2.Ssh2Client
Installs a custom channel factory so that the client may respond to channel open requests.
addDirectoryOperation(DirectoryOperation, File) - Method in class com.sshtools.sftp.DirectoryOperation
Add the contents of another directory operation.
addDirectoryOperation(DirectoryOperation, String) - Method in class com.sshtools.sftp.DirectoryOperation
Add the contents of another directory operation.
addLicense(String) - Static method in class com.maverick.ssh.LicenseManager
 
addListener(ForwardingClientListener) - Method in class com.sshtools.net.ForwardingClient
Add a ForwardingClientListener to receive forwarding events.
addRequestHandler(GlobalRequestHandler) - Method in class com.maverick.ssh2.Ssh2Client
Installs a global request handler so that the client may respond to global requests.
allowHost(String, SshPublicKey, boolean) - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification
Allows a host key, optionally recording the key to the known_hosts file.
allowX11Forwarding(String, String) - Method in class com.sshtools.net.ForwardingClient
Configure the fowarding client to manage X11 connections.
allowX11Forwarding(String) - Method in class com.sshtools.net.ForwardingClient
Configure the fowarding client to manage X11 connections.
allowX11Forwarding(String, File) - Method in class com.sshtools.net.ForwardingClient
Configure the fowarding client to manage X11 connections.
allowedHosts() - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification
Returns a Map of the allowed hosts.
authenticate(SshAuthentication) - Method in interface com.maverick.ssh.SshClient
Authenticate the user.
authenticate(SshAuthentication) - Method in class com.maverick.ssh1.Ssh1Client
 
authenticate(AuthenticationProtocol, String) - Method in class com.maverick.ssh2.KBIAuthentication
 
authenticate(SshAuthentication) - Method in class com.maverick.ssh2.Ssh2Client
 
authenticate(AuthenticationProtocol, String) - Method in class com.maverick.ssh2.Ssh2PasswordAuthentication
Implementaion of the authentication method.
authenticate(AuthenticationProtocol, String) - Method in class com.maverick.ssh2.Ssh2PublicKeyAuthentication
 

B

BLOCK_SIZE - Static variable in class com.sshtools.cipher.CAST5Engine
 
BannerDisplay - interface com.maverick.ssh2.BannerDisplay.
Callback interface to display authentication banner messages.
Bits32ToBytes(int, byte[], int) - Method in class com.sshtools.cipher.CAST5Engine
 
Bits32ToInts(int, int[], int) - Method in class com.sshtools.cipher.CAST5Engine
 
BlowfishCbc - class com.maverick.ssh2.BlowfishCbc.
Blowfish cipher for SSH2.
BlowfishCbc() - Constructor for class com.maverick.ssh2.BlowfishCbc
 
BytesTo32bits(byte[], int) - Method in class com.sshtools.cipher.CAST5Engine
 
buffer - Variable in class com.maverick.scp.ScpClientIO.ScpEngineIO
 

C

CANCELLED - Static variable in interface com.maverick.ssh.SshAuthentication
The authentication was cancelled by the user
CAST128Cbc - class com.sshtools.cipher.CAST128Cbc.
This cipher can optionally be added to the J2SSH Maverick API.
CAST128Cbc() - Constructor for class com.sshtools.cipher.CAST128Cbc
 
CAST128_CBC - Static variable in class com.sshtools.cipher.CAST128Cbc
 
CAST5Engine - class com.sshtools.cipher.CAST5Engine.
A class that provides CAST key encryption operations, such as encoding data and generating keys.
CAST5Engine() - Constructor for class com.sshtools.cipher.CAST5Engine
 
CAST_Decipher(int, int, int[]) - Method in class com.sshtools.cipher.CAST5Engine
 
CAST_Encipher(int, int, int[]) - Method in class com.sshtools.cipher.CAST5Engine
 
CIPHER_3DES - Static variable in class com.maverick.ssh1.Ssh1Context
Currently the one and only cipher type supported
CIPHER_BLOWFISH_CBC - Static variable in class com.maverick.ssh2.Ssh2Context
The Blowfish CBC cipher
CIPHER_DES - Static variable in class com.maverick.ssh1.Ssh1Context
 
CIPHER_TRIPLEDES_CBC - Static variable in class com.maverick.ssh2.Ssh2Context
The 3DES CBC cipher
COMPLETE - Static variable in interface com.maverick.ssh.SshAuthentication
The authentication completed
COMPRESSION_NONE - Static variable in class com.maverick.ssh2.Ssh2Context
Compression off
COMPRESSION_ZLIB - Static variable in class com.maverick.ssh2.Ssh2Context
Optional zlib compression (requires sshtools-zlib.jar in classpath)
CONNECT_FAILED - Static variable in class com.maverick.ssh2.ChannelOpenException
The connection could not be established
ChannelAdapter - class com.maverick.ssh.ChannelAdapter.
An adapter for the ChannelEventListener.
ChannelAdapter() - Constructor for class com.maverick.ssh.ChannelAdapter
 
ChannelEventListener - interface com.maverick.ssh.ChannelEventListener.
An event interface that provides notifications of SshChannel events.
ChannelFactory - interface com.maverick.ssh2.ChannelFactory.
The SSH2 protocol supports many different channel types including sesisons, port forwarding and x11 forwarding; most channels are requested by the client and created by the server however it is possible for the server to request any type of channel from the client, this interface defines the contract for supporting a standard and custom channel creation.
ChannelOpenException - exception com.maverick.ssh2.ChannelOpenException.
Exception thrown when a channel cannot be opened, the reason for which should be specified in with any of the constants defined here.
ChannelOpenException(String, int) - Constructor for class com.maverick.ssh2.ChannelOpenException
 
ConsoleKnownHostsKeyVerification - class com.sshtools.publickey.ConsoleKnownHostsKeyVerification.
Implements the AbstractKnownHostsKeyVerification to provide host key verification through the console.
ConsoleKnownHostsKeyVerification() - Constructor for class com.sshtools.publickey.ConsoleKnownHostsKeyVerification
Constructs the verification instance with the default known_hosts file from $HOME/.ssh/known_hosts.
ConsoleKnownHostsKeyVerification(String) - Constructor for class com.sshtools.publickey.ConsoleKnownHostsKeyVerification
Constructs the verification instance with the specified known_hosts file.
canRead() - Method in class com.maverick.sftp.SftpFile
Determine whether the user has read access to the file.
canWrite() - Method in class com.maverick.sftp.SftpFile
Determine whether the user has write access to the file.
cancelAllRemoteForwarding() - Method in class com.sshtools.net.ForwardingClient
Stop all remote forwarding
cancelRemoteForwarding(String, int) - Method in interface com.maverick.ssh.SshClient
Cancel a forwarding request.
cancelRemoteForwarding(String, int) - Method in class com.maverick.ssh1.Ssh1Client
The bindAddress is ignored since the SSH1 protocol does not support setting of the bind address.
cancelRemoteForwarding(String, int) - Method in class com.maverick.ssh2.Ssh2Client
 
cancelRemoteForwarding(String, int) - Method in class com.sshtools.net.ForwardingClient
Requests that the remote side stop listening for socket connections.
cd(String) - Method in class com.sshtools.sftp.SftpClient
Changes the working directory on the remote server.
changePassphrase(String, String) - Method in interface com.sshtools.publickey.SshPrivateKeyFile
Change the passphrase of the key file.
changePermissions(SftpFile, int) - Method in class com.maverick.sftp.SftpSubsystemChannel
Change the permissions of a file.
changePermissions(String, int) - Method in class com.maverick.sftp.SftpSubsystemChannel
Change the permissions of a file.
changePermissions(String, String) - Method in class com.maverick.sftp.SftpSubsystemChannel
Change the permissions of a file.
changeTerminalDimensions(int, int, int, int) - Method in interface com.maverick.ssh.SshSession
Change the dimensions of the terminal window.
changeTerminalDimensions(int, int, int, int) - Method in class com.maverick.ssh2.Ssh2Session
 
channelClosed(SshChannel) - Method in class com.maverick.ssh.ChannelAdapter
 
channelClosed(SshChannel) - Method in interface com.maverick.ssh.ChannelEventListener
A channel is closed.
channelClosed(int, String, SshTunnel) - Method in interface com.sshtools.net.ForwardingClientListener
A forwarding channel has been closed.
channelClosing(SshChannel) - Method in class com.maverick.ssh.ChannelAdapter
 
channelClosing(SshChannel) - Method in interface com.maverick.ssh.ChannelEventListener
A channel is closing.
channelEOF() - Method in class com.maverick.ssh2.Ssh2Channel
Called when the remote side data stream is EOF, by default this method does nothing
channelOpened(SshChannel) - Method in class com.maverick.ssh.ChannelAdapter
 
channelOpened(SshChannel) - Method in interface com.maverick.ssh.ChannelEventListener
A channel has been opened.
channelOpened(int, String, SshTunnel) - Method in interface com.sshtools.net.ForwardingClientListener
A forwarding channel has been opened.
channelRequest(String, boolean, byte[]) - Method in class com.maverick.ssh2.Ssh2Channel
Called when a channel request is received, by default this method sends a failure message if the remote side requests a reply.
channelRequest(String, boolean, byte[]) - Method in class com.maverick.ssh2.Ssh2Session
This overidden method handles the "exit-status", "exit-signal" and "xon-xoff" channel requests.
chgrp(int, String) - Method in class com.sshtools.sftp.SftpClient
Sets the group ID for the file or directory.
chmod(int, String) - Method in class com.sshtools.sftp.SftpClient
Changes the access permissions or modes of the specified file or directory.
chown(int, String) - Method in class com.sshtools.sftp.SftpClient
Sets the user ID to owner for the file or directory.
close() - Method in class com.maverick.scp.ScpClientIO.ScpEngineIO
Close the SCP engine and underlying session.
close() - Method in class com.maverick.sftp.SftpFile
Close the file.
close() - Method in class com.maverick.sftp.SftpFileInputStream
Closes the SFTP file handle.
close() - Method in class com.maverick.sftp.SftpFileOutputStream
Closes the file's handle
close() - Method in interface com.maverick.ssh.SshChannel
Close the channel.
close() - Method in interface com.maverick.ssh.SshSession
Close the session.
close() - Method in interface com.maverick.ssh.SshTransport
Close the transport.
close() - Method in class com.maverick.ssh.SubsystemChannel
 
close() - Method in class com.maverick.ssh2.Ssh2Channel
Closes the channel.
close() - Method in class com.sshtools.net.SocketWrapper
 
closeFile(SftpFile) - Method in class com.maverick.sftp.SftpSubsystemChannel
Close a file or directory.
cmd - Variable in class com.maverick.scp.ScpClientIO.ScpEngineIO
 
com.maverick.scp - package com.maverick.scp
This package contains a Secure Copy (SCP) engine suitable for the lightweight J2SSH Maverick API.
com.maverick.sftp - package com.maverick.sftp
The base implementation of the SFTP protocol enabling SFTP to be operated over both SSH1 and SSH2 connections.
com.maverick.ssh - 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.
com.maverick.ssh1 - package com.maverick.ssh1
This package contains an SSH1 implementation of the com.maverick.ssh interfaces.
com.maverick.ssh2 - package com.maverick.ssh2
This package contains an SSH2 implementation of the com.maverick.ssh interfaces.
com.sshtools.cipher - package com.sshtools.cipher
This package contains additional cipher algorithms for use with the J2SSH Maverick API.
com.sshtools.net - package com.sshtools.net
This package contains a set of network utilities for the J2SSH Maverick API.
com.sshtools.publickey - package com.sshtools.publickey
This package contains utility classes for loading/storing public/private keys and is based on the SSHTools key format architecture.
com.sshtools.scp - package com.sshtools.scp
This package contains the SSHTools SCP implementation converted to use the J2SSH Maverick API's SCP engine.
com.sshtools.sftp - package com.sshtools.sftp
This package contains the SSHTools SFTP client converted for use with the J2SSH Maverick API.
completed() - Method in interface com.maverick.sftp.FileTransferProgress
The transfer has completed.
connect(SshTransport, SshContext, SshConnector, String, String, String) - Method in interface com.maverick.ssh.SshClient
Connect to an SSH server.
connect(SshTransport, String) - Method in class com.maverick.ssh.SshConnector
Create a new connection to an SSH server over the specified transport.
connect(SshTransport, String, SshContext) - Method in class com.maverick.ssh.SshConnector
 
connect(SshTransport, SshContext, SshConnector, String, String, String) - Method in class com.maverick.ssh1.Ssh1Client
 
connect(SshTransport, SshContext, SshConnector, String, String, String) - Method in class com.maverick.ssh2.Ssh2Client
 
connectViaProxy(String, int, String, int, String, String, String) - Static method in class com.sshtools.net.HttpProxyTransport
Connect the socket to a HTTP proxy and request forwarding to our remote host.
connectViaSocks4Proxy(String, int, String, int, String) - Static method in class com.sshtools.net.SocksProxyTransport
Connect the socket to a SOCKS 4 proxy and request forwarding to our remote host.
connectViaSocks5Proxy(String, int, String, int, boolean, String, String) - Static method in class com.sshtools.net.SocksProxyTransport
Connect the socket to a SOCKS 5 proxy and request forwarding to our remote host.
connectViaSocks5Proxy(String, int, String, int, String, String) - Static method in class com.sshtools.net.SocksProxyTransport
 
contains(String) - Method in class com.maverick.ssh2.AbstractComponentFactory
Determine whether the factory supports a given component type.
containsFile(File) - Method in class com.sshtools.sftp.DirectoryOperation
Determine whether the operation contains a file.
containsFile(SftpFile) - Method in class com.sshtools.sftp.DirectoryOperation
Determine whether the directory operation contains an SftpFile
copyLocalDirectory(String, String, boolean, boolean, boolean, FileTransferProgress) - Method in class com.sshtools.sftp.SftpClient
Copy the contents of a local directory into a remote remote directory.
copyRemoteDirectory(String, String, boolean, boolean, boolean, FileTransferProgress) - Method in class com.sshtools.sftp.SftpClient
Copy the contents of a remote directory to a local directory
create() - Method in class com.maverick.ssh2.Ssh2Channel
Called after the channel has been created by the create(SshKeyPair, String, String, int) - Static method in class com.sshtools.publickey.SshPrivateKeyFileFactory
 
create(SshPublicKey, String, int) - Static method in class com.sshtools.publickey.SshPublicKeyFileFactory
Create a file representation from an existing public key.
createChannel(String, byte[]) - Method in interface com.maverick.ssh2.ChannelFactory
Create an instance of an SSH channel.
createConnection(String, int) - Method in interface com.maverick.ssh.ForwardingRequestListener
Create a connection to the specified host.
createExtendedDataStream() - Method in class com.maverick.ssh2.Ssh2Channel
Currently reserved.
createInstance(String, Class) - Method in class com.maverick.ssh2.AbstractComponentFactory
Overide this method to create an instance of the component.
createSymbolicLink(String, String) - Method in class com.maverick.sftp.SftpSubsystemChannel
Create a symbolic link.

D

DirectoryOperation - class com.sshtools.sftp.DirectoryOperation.
This class provides a list of operations that have been/or will be completed by the SftpClient's copyRemoteDirectory/copyLocalDirectory methods.
DirectoryOperation() - Constructor for class com.sshtools.sftp.DirectoryOperation
Construct a new directory operation object
dataReceived(SshChannel, byte[], int, int) - Method in class com.maverick.ssh.ChannelAdapter
 
dataReceived(SshChannel, byte[], int, int) - Method in interface com.maverick.ssh.ChannelEventListener
A block of data has been received by the channel.
dataSent(SshChannel, byte[], int, int) - Method in class com.maverick.ssh.ChannelAdapter
 
dataSent(SshChannel, byte[], int, int) - Method in interface com.maverick.ssh.ChannelEventListener
A block of data has been sent by the channel.
decodeSSH2PublicKey(byte[]) - Static method in class com.sshtools.publickey.SshPublicKeyFileFactory
Decode an SSH2 encoded public key as specified in the SSH2 transport protocol.
decrypt(byte[], int, byte[], int, int) - Method in class com.maverick.ssh1.SshDes
 
decryptBlock(byte[], int, byte[], int) - Method in class com.sshtools.cipher.CAST5Engine
 
delete() - Method in class com.maverick.sftp.SftpFile
Delete this file/directory from the remote server.
determineVersion(SshTransport) - Method in class com.maverick.ssh.SshConnector
Determine the version of the server connected to the SshTransport.
disconnect() - Method in interface com.maverick.ssh.SshClient
Disconnect from the remote computer.
disconnect() - Method in class com.maverick.ssh1.Ssh1Client
 
disconnect() - Method in class com.maverick.ssh2.Ssh2Client
 
displayBanner(String) - Method in interface com.maverick.ssh2.BannerDisplay
Called when a banner message is received.
duplicate() - Method in interface com.maverick.ssh.SshClient
Create an identical version of an SshClient using cached authentication information and the SshTransport duplicate method.
duplicate() - Method in interface com.maverick.ssh.SshTransport
Create a new copy of this transport and connect to the same host:port combination.
duplicate() - Method in class com.maverick.ssh1.Ssh1Client
 
duplicate() - Method in class com.maverick.ssh2.Ssh2Client
 
duplicate() - Method in class com.sshtools.net.HttpProxyTransport
 
duplicate() - Method in class com.sshtools.net.SocketTransport
 
duplicate() - Method in class com.sshtools.net.SocketWrapper
 
duplicate() - Method in class com.sshtools.net.SocksProxyTransport
 

E

EXITCODE_NOT_RECEIVED - Static variable in interface com.maverick.ssh.SshSession
Returned from exitCode() when the remote process is still active.
echo() - Method in class com.maverick.ssh2.KBIPrompt
true if the user response should be echo'd to the display, otherwise false.
encrypt(byte[], int, byte[], int, int) - Method in class com.maverick.ssh1.SshDes
 
encryptBlock(byte[], int, byte[], int) - Method in class com.sshtools.cipher.CAST5Engine
 
equals(Object) - Method in class com.maverick.sftp.SftpFile
Compares the Object to this instance and returns true if they point to the same file.
equals(Object) - Method in class com.maverick.ssh1.Ssh1RsaPublicKey
 
equals(Object) - Method in class com.maverick.ssh2.Ssh2Channel
This channel is equal to another channel if the channel id's are equal.
equals(Object) - Method in class com.maverick.ssh2.Ssh2RsaPublicKey
 
executeCommand(String) - Method in interface com.maverick.ssh.SshSession
Execute a command.
executeCommand(String) - Method in class com.maverick.ssh2.Ssh2Session
 
exitCode() - Method in interface com.maverick.ssh.SshSession
Return the exit code of the process once complete.
exitCode() - Method in class com.maverick.ssh2.Ssh2Session
 

F

F1(int, int, int) - Method in class com.sshtools.cipher.CAST5Engine
 
F2(int, int, int) - Method in class com.sshtools.cipher.CAST5Engine
 
F3(int, int, int) - Method in class com.sshtools.cipher.CAST5Engine
 
FAILED - Static variable in interface com.maverick.ssh.SshAuthentication
The authentication failed
FURTHER_AUTHENTICATION_REQUIRED - Static variable in interface com.maverick.ssh.SshAuthentication
The authentication succeeded by further authentication is required
FileTransferProgress - interface com.maverick.sftp.FileTransferProgress.
Interface for monitoring the state of a file transfer
ForwardingClient - class com.sshtools.net.ForwardingClient.
Provides management of port forwarding connections and active tunnels.
ForwardingClient(SshClient) - Constructor for class com.sshtools.net.ForwardingClient
Create an forwarding client.
ForwardingClient.ActiveTunnel - class com.sshtools.net.ForwardingClient.ActiveTunnel.
This class represents an active tunnel.
ForwardingClientListener - interface com.sshtools.net.ForwardingClientListener.
An event listener for receiving notification of forwarding events.
ForwardingRequestListener - interface com.maverick.ssh.ForwardingRequestListener.
This interface is required when a request for remote port forwarding is made.
forceKeyExchange() - Method in class com.maverick.ssh2.Ssh2Client
The SSH transport protocol exchanges keys at the beginning of the session; the specification recommends that these keys be re-exchanged after each gigabyte of transmitted data or after each hour of connection time, whichever comes sooner.
formatLongname(SftpFile) - Static method in class com.sshtools.sftp.SftpClient
Format a String with the details of the file.
formatLongname(SftpFileAttributes, String) - Static method in class com.sshtools.sftp.SftpClient
Format a String with the details of the file.
forwardingStarted(int, String, String, int) - Method in interface com.sshtools.net.ForwardingClientListener
The forwarding has been started and any connections made to the listening address (which is specified by the key in the format 'ipaddress:port') will be forwarded over the connection to the host and port specified.
forwardingStopped(int, String) - Method in interface com.sshtools.net.ForwardingClientListener
The forwarding identifed by the key has been stopped.

G

GlobalRequest - class com.maverick.ssh2.GlobalRequest.
This class represents a global request.
GlobalRequest(String, byte[]) - Constructor for class com.maverick.ssh2.GlobalRequest
Contstruct a request.
GlobalRequestHandler - interface com.maverick.ssh2.GlobalRequestHandler.
There are several kinds of requests that affect the state of the remote end "globally", independent of any channels, this interface defines the contract for handling such global requests.
generate(long, byte[], int, int, byte[], int) - Method in class com.maverick.ssh2.SshHmac
Generate a MAC from the data supplied.
generateKeyPair(String, int) - Static method in class com.sshtools.publickey.SshKeyPairGenerator
Generates a new key pair.
get(String) - Method in class com.maverick.scp.ScpClientIO
Gets a remote file as an java.io.InputStream.
get(String, String[], boolean) - Method in class com.sshtools.scp.ScpClient
Downloads an array of remote files to the local computer.
get(String, String, boolean) - Method in class com.sshtools.scp.ScpClient
Downloads a remote file onto the local computer.
get(String, FileTransferProgress) - Method in class com.sshtools.sftp.SftpClient
Download the remote file to the local computer.
get(String) - Method in class com.sshtools.sftp.SftpClient
Download the remote file to the local computer
get(String, String, FileTransferProgress) - Method in class com.sshtools.sftp.SftpClient
Download the remote file to the local computer.
get(String, String) - Method in class com.sshtools.sftp.SftpClient
Download the remote file into the local file.
get(String, OutputStream, FileTransferProgress) - Method in class com.sshtools.sftp.SftpClient
Download the remote file writing it to the specified OutputStream.
get(String, OutputStream) - Method in class com.sshtools.sftp.SftpClient
Download the remote file into an OutputStream.
getAbsolutePath() - Method in class com.maverick.sftp.SftpFile
Get the absolute path
getAbsolutePath(SftpFile) - Method in class com.maverick.sftp.SftpSubsystemChannel
Get the absolute path of a file.
getAbsolutePath(String) - Method in class com.maverick.sftp.SftpSubsystemChannel
Get the absolute path of a file.
getAbsolutePath(String) - Method in class com.sshtools.sftp.SftpClient
Get the absolute path for a file.
getAccessedTime() - Method in class com.maverick.sftp.SftpFileAttributes
Get the last accessed time.
getAlgorithm() - Method in interface com.maverick.ssh.SshPublicKey
Get the algorithm name for the public key.
getAlgorithm() - Method in class com.maverick.ssh1.Ssh1RsaPublicKey
The algorithm name "rsa1"
getAlgorithm() - Method in class com.maverick.ssh1.SshDes
 
getAlgorithm() - Method in class com.maverick.ssh1.SshDes3
 
getAlgorithm() - Method in class com.maverick.ssh2.BlowfishCbc
 
getAlgorithm() - Method in class com.maverick.ssh2.Ssh2DsaPublicKey
The algorithm name is "ssh-dss"
getAlgorithm() - Method in class com.maverick.ssh2.Ssh2RsaPublicKey
 
getAlgorithm() - Method in class com.maverick.ssh2.SshHmac
Get the algorithm name
getAlgorithm() - Method in class com.maverick.ssh2.TripleDesCbc
Get the algorithm name
getAlgorithmName() - Method in class com.sshtools.cipher.CAST5Engine
 
getAlgorithmName() - Method in class com.sshtools.cipher.TwofishEngine
 
getAttributes() - Method in class com.maverick.sftp.SftpFile
Get the files attributes.
getAttributes(String) - Method in class com.maverick.sftp.SftpSubsystemChannel
Get the attributes of a file.
getAttributes(SftpFile) - Method in class com.maverick.sftp.SftpSubsystemChannel
Get the attributes of a file.
getAuthenticationMethods(String) - Method in class com.maverick.ssh2.Ssh2Client
Get a list of authentication methods for the user.
getBannerDisplay() - Method in class com.maverick.ssh2.Ssh2Context
Get the contexts banner display
getBitLength() - Method in interface com.maverick.ssh.SshPublicKey
Get the bit length of the public key
getBlockSize() - Method in class com.maverick.ssh1.SshDes
 
getBlockSize() - Method in class com.maverick.ssh1.SshDes3
 
getBlockSize() - Method in class com.sshtools.cipher.AESEngine
 
getBlockSize() - Method in class com.sshtools.cipher.CAST5Engine
 
getBlockSize() - Method in class com.sshtools.cipher.TwofishEngine
 
getChannelCount() - Method in interface com.maverick.ssh.SshClient
Get the number of active channels.
getChannelCount() - Method in class com.maverick.ssh1.Ssh1Client
 
getChannelCount() - Method in class com.maverick.ssh2.Ssh2Client
 
getChannelId() - Method in interface com.maverick.ssh.SshChannel
Get the id of this channel.
getChannelLimit() - Method in interface com.maverick.ssh.SshContext
Get the maximum number of channels that are allowed open at any one time.
getChannelLimit() - Method in class com.maverick.ssh1.Ssh1Context
 
getChannelLimit() - Method in class com.maverick.ssh2.Ssh2Context
 
getCharsetEncoding() - Method in class com.maverick.sftp.SftpSubsystemChannel
Get the current encoding being used for filename Strings.
getCipherType(int) - Method in class com.maverick.ssh1.Ssh1Context
Get the cipher type for this configuration context.
getClient() - Method in interface com.maverick.ssh.SshSession
Get the client that created this session.
getClient() - Method in class com.maverick.ssh2.Ssh2Session
 
getComment() - Method in interface com.sshtools.publickey.SshPublicKeyFile
Get the comment applied to the key file.
getContext() - Method in interface com.maverick.ssh.SshClient
Get the context that created this client.
getContext(int) - Method in class com.maverick.ssh.SshConnector
Get the configuration context for a specific SSH version.
getContext() - Method in class com.maverick.ssh1.Ssh1Client
 
getContext() - Method in class com.maverick.ssh2.Ssh2Client
 
getData() - Method in class com.maverick.ssh2.GlobalRequest
Get the request data, if the request has been sent and processed, this will return the response data (which can be null).
getDefaultDirectory() - Method in class com.maverick.sftp.SftpSubsystemChannel
Gets the users default directory.
getDeletedFiles() - Method in class com.sshtools.sftp.DirectoryOperation
When synchronizing directories, this method will return a list of files that will be deleted becasue they no longer exist at the source location.
getEncoded() - Method in interface com.maverick.ssh.SshPublicKey
Encode the public key into a blob of binary data, the encoded result will be passed into init to recreate the key.
getEncoded() - Method in class com.maverick.ssh1.Ssh1RsaPublicKey
Get the encoded format required by SSH1
getEncoded() - Method in class com.maverick.ssh2.Ssh2DsaPublicKey
Returns the key encoded into a byte array as defined in the SSH Transport Protocol.
getEncoded() - Method in class com.maverick.ssh2.Ssh2RsaPublicKey
 
getExitSignalInfo() - Method in class com.maverick.ssh2.Ssh2Session
Get the exit signal information, may be an empty string.
getFileCount() - Method in class com.sshtools.sftp.DirectoryOperation
Get the total number of new and changed files to transfer
getFilename() - Method in class com.maverick.sftp.SftpFile
Get the filename.
getFingerprint() - Method in interface com.maverick.ssh.SshPublicKey
Return an SSH fingerprint of the public key
getFormattedKey() - Method in interface com.sshtools.publickey.SshPrivateKeyFile
Get the formatted key
getFormattedKey() - Method in interface com.sshtools.publickey.SshPublicKeyFile
Get the formatted key.
getGID() - Method in class com.maverick.sftp.SftpFileAttributes
Get the GID of this file.
getHandle() - Method in class com.maverick.sftp.SftpFile
Get the open file handle
getHost() - Method in interface com.maverick.ssh.SshTransport
Get the name of the connected host.
getHost() - Method in class com.sshtools.net.HttpProxyTransport
 
getHost() - Method in class com.sshtools.net.SocketTransport
Get the hostname of the connected host.
getHost() - Method in class com.sshtools.net.SocketWrapper
 
getHost() - Method in class com.sshtools.net.SocksProxyTransport
 
getHostKeyVerification() - Method in interface com.maverick.ssh.SshContext
Get the host key verification implementation.
getHostKeyVerification() - Method in class com.maverick.ssh1.Ssh1Context
 
getHostKeyVerification() - Method in class com.maverick.ssh2.Ssh2Context
Get the host key verification implementation
getInputStream() - Method in interface com.maverick.ssh.SshChannel
Get an InputStream to read incoming channel data.
getInputStream() - Method in interface com.maverick.ssh.SshSession
Get an InputStream to read the process stdout.
getInputStream() - Method in interface com.maverick.ssh.SshTransport
Get the transport's InputStream.
getInputStream() - Method in class com.maverick.ssh2.Ssh2Channel
 
getInputStream() - Method in class com.sshtools.net.SocketWrapper
 
getInputStream(String) - Method in class com.sshtools.sftp.SftpClient
Create an InputStream for reading a remote file.
getInstance() - Static method in class com.maverick.ssh.SshConnector
Returns an instance of the SshConnector.
getInstance(String) - Method in class com.maverick.ssh2.AbstractComponentFactory
Get a new instance of a supported component.
getKeyPair(SshPrivateKey, SshPublicKey) - Static method in class com.sshtools.publickey.SshKeyPair
Wraps a public/private key pair into an SshKeyPair instance.
getListeningAddress() - Method in interface com.maverick.ssh.SshTunnel
The source ip address of the connection that is being forwarded.
getListeningPort() - Method in interface com.maverick.ssh.SshTunnel
The source port of the connection being forwarded.
getLocalForwardingTunnels(String) - Method in class com.sshtools.net.ForwardingClient
Get the active tunnels for a local forwarding listener.
getLocalForwardingTunnels(String, int) - Method in class com.sshtools.net.ForwardingClient
Get the active tunnels for a local forwarding listener.
getLocalForwardings() - Method in class com.sshtools.net.ForwardingClient
Return the currently active local forwarding listeners.
getMacLength() - Method in class com.maverick.ssh2.SshHmac
Get the length of the MAC.
getMaskString() - Method in class com.maverick.sftp.SftpFileAttributes
Return the UNIX style mode mask
getMessageStore() - Method in class com.maverick.ssh2.Ssh2Channel
 
getMethodName() - Method in class com.maverick.ssh2.KBIAuthentication
 
getModifiedTime() - Method in class com.maverick.sftp.SftpFileAttributes
Get the last modified time.
getName() - Method in class com.maverick.ssh2.GlobalRequest
Get the name of the request.
getName() - Method in class com.maverick.ssh2.Ssh2Channel
Get the name of the channel.
getNewFiles() - Method in class com.sshtools.sftp.DirectoryOperation
Returns a list of new files that will be transfered in the directory operation
getOKRequestStatus(UnsignedInteger32) - Method in class com.maverick.sftp.SftpSubsystemChannel
Verify that an OK status has been returned for a request id.
getOriginatingHost() - Method in interface com.maverick.ssh.SshTunnel
The host that made the initial connection to the listening address.
getOriginatingPort() - Method in interface com.maverick.ssh.SshTunnel
The port of the initial connection.
getOutputStream() - Method in interface com.maverick.ssh.SshChannel
Get an OutputStream to write outgoing channel data.
getOutputStream() - Method in interface com.maverick.ssh.SshSession
Get an OutputStream to write to the process stdin.
getOutputStream() - Method in interface com.maverick.ssh.SshTransport
Get the transport's OutputStream.
getOutputStream() - Method in class com.maverick.ssh2.Ssh2Channel
 
getOutputStream() - Method in class com.sshtools.net.SocketWrapper
 
getOutputStream(String) - Method in class com.sshtools.sftp.SftpClient
Create an OutputStream for writing to a remote file.
getPassword() - Method in class com.maverick.ssh.PasswordAuthentication
Get the password.
getPermissions() - Method in class com.maverick.sftp.SftpFileAttributes
Get the current permissions value.
getPermissionsString() - Method in class com.maverick.sftp.SftpFileAttributes
Returns a formatted permissions string.
getPort() - Method in interface com.maverick.ssh.SshTunnel
The port to which the data is being forwarded.
getPreferredCipherCS() - Method in class com.maverick.ssh2.Ssh2Context
Get the currently preferred cipher for the Client->Server stream.
getPreferredCipherSC() - Method in class com.maverick.ssh2.Ssh2Context
Get the currently preferred cipher for the Server->Client stream.
getPreferredCompressionCS() - Method in class com.maverick.ssh2.Ssh2Context
Get the currently preferred compression for the Client->Server stream.
getPreferredCompressionSC() - Method in class com.maverick.ssh2.Ssh2Context
Get the currently preferred compression for the Server->Client stream.
getPreferredKeyExchange() - Method in class com.maverick.ssh2.Ssh2Context
Get the currently preferred key exchange method.
getPreferredMacCS() - Method in class com.maverick.ssh2.Ssh2Context
Get the currently preferred mac for the Client->Server stream.
getPreferredMacSC() - Method in class com.maverick.ssh2.Ssh2Context
Get the currently supported mac for the Server-Client stream.
getPreferredPublicKey() - Method in class com.maverick.ssh2.Ssh2Context
Get the currently preferred public key algorithm.
getPrivateKey() - Method in class com.maverick.ssh.PublicKeyAuthentication
Get the private key for this authentication.
getPrivateKey() - Method in class com.sshtools.publickey.SshKeyPair
Get the private key.
getPrompt() - Method in class com.maverick.ssh2.KBIPrompt
Get the prompt message to display to the user
getPublicKey() - Method in class com.maverick.ssh.PublicKeyAuthentication
Get the public key for this authentication.
getPublicKey() - Method in class com.sshtools.publickey.SshKeyPair
Get the public key.
getReason() - Method in class com.maverick.ssh2.ChannelOpenException
 
getRemoteForwardingTunnels(String) - Method in class com.sshtools.net.ForwardingClient
Get the active tunnels for a remote forwarding listener.
getRemoteForwardingTunnels(String, int) - Method in class com.sshtools.net.ForwardingClient
Get the active tunnels for a remote forwarding listener.
getRemoteForwardings() - Method in class com.sshtools.net.ForwardingClient
Returns the currently active remote forwarding listeners.
getRemoteIdentification() - Method in interface com.maverick.ssh.SshClient
Returns the identification string supplied by the server during protocol negotiation.
getRemoteIdentification() - Method in class com.maverick.ssh1.Ssh1Client
 
getRemoteIdentification() - Method in class com.maverick.ssh2.Ssh2Client
 
getResponse() - Method in class com.maverick.ssh2.KBIPrompt
Get the user's response for this prompt.
getSFTPChannel() - Method in class com.maverick.sftp.SftpFile
Get the SFTP subsystem channel that created this file object.
getSFTPProvider() - Method in interface com.maverick.ssh.SshContext
Get the path to the SFTP provider.
getSFTPProvider() - Method in class com.maverick.ssh1.Ssh1Context
 
getSFTPProvider() - Method in class com.maverick.ssh2.Ssh2Context
 
getSize() - Method in class com.maverick.sftp.SftpFileAttributes
Get the size of the file.
getStatus() - Method in class com.maverick.sftp.SftpStatusException
Get the status
getStderrInputStream() - Method in interface com.maverick.ssh.SshSession
Get an InputStream to read the process stderr.
getStderrInputStream() - Method in class com.maverick.ssh2.Ssh2Session
 
getSubsystemChannel() - Method in class com.sshtools.sftp.SftpClient
Returns the instance of the SftpSubsystemChannel used by this class
getSupportedVersions() - Method in class com.maverick.ssh.SshConnector
Returns the supported protocol flags.
getSymbolicLinkTarget(String) - Method in class com.maverick.sftp.SftpSubsystemChannel
Get the target path of a symbolic link.
getTransferSize() - Method in class com.sshtools.sftp.DirectoryOperation
Get the total number of bytes that this operation will transfer
getTransport() - Method in interface com.maverick.ssh.SshTunnel
The connection being forwarded (local forwarding) or the destination of the forwarding (remote forwarding).
getUID() - Method in class com.maverick.sftp.SftpFileAttributes
Get the UID of the owner.
getUnchangedFiles() - Method in class com.sshtools.sftp.DirectoryOperation
Returns the list of files that will not be changed during the directory operation
getUpdatedFiles() - Method in class com.sshtools.sftp.DirectoryOperation
Returns a list of files that will be updated in the directory operation
getUsername() - Method in class com.maverick.ssh.PasswordAuthentication
Get the username.
getUsername() - Method in class com.maverick.ssh.PublicKeyAuthentication
 
getUsername() - Method in interface com.maverick.ssh.SshAuthentication
Get the username for this authentication attempt.
getUsername() - Method in interface com.maverick.ssh.SshClient
Return the username used for this connection
getUsername() - Method in class com.maverick.ssh1.Ssh1Client
 
getUsername() - Method in class com.maverick.ssh2.KBIAuthentication
 
getUsername() - Method in class com.maverick.ssh2.Ssh2Client
 
getVersion() - Method in class com.maverick.sftp.SftpSubsystemChannel
When called after the initialize method this will return the version in operation for this sftp session.
getX11AuthenticationCookie() - Method in interface com.maverick.ssh.SshContext
Get a fake random cookie for X11 authentication
getX11AuthenticationCookie() - Method in class com.maverick.ssh1.Ssh1Context
 
getX11AuthenticationCookie() - Method in class com.maverick.ssh2.Ssh2Context
 
getX11Display() - Method in interface com.maverick.ssh.SshContext
Get the currently configured XDisplay setting which will be null if no display is currently set.
getX11Display() - Method in class com.maverick.ssh1.Ssh1Context
 
getX11Display() - Method in class com.maverick.ssh2.Ssh2Context
 
getX11ForwardingTunnels() - Method in class com.sshtools.net.ForwardingClient
Get the active X11 forwarding channels.
getX11RealCookie() - Method in interface com.maverick.ssh.SshContext
Get the real X11 authentication cookie, if not cookie has been set the fake cookie will be returned.
getX11RealCookie() - Method in class com.maverick.ssh1.Ssh1Context
 
getX11RealCookie() - Method in class com.maverick.ssh2.Ssh2Context
 
getX11RequestListener() - Method in interface com.maverick.ssh.SshContext
Get the X11 forwarding request listener.
getX11RequestListener() - Method in class com.maverick.ssh1.Ssh1Context
 
getX11RequestListener() - Method in class com.maverick.ssh2.Ssh2Context
 

H

HMAC_MD5 - Static variable in class com.maverick.ssh2.Ssh2Context
MD5 message authentication
HMAC_SHA1 - Static variable in class com.maverick.ssh2.Ssh2Context
SHA1 message authentication
HostKeyVerification - interface com.maverick.ssh.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.
HttpProxyTransport - class com.sshtools.net.HttpProxyTransport.
Provides an SshTransport implementation that can route the connection through a HTTP proxy.
hasExitSignal() - Method in class com.maverick.ssh2.Ssh2Session
Determine whether the remote process was signalled.
hashCode() - Method in class com.maverick.sftp.SftpFile
 

I

IntsTo32bits(int[], int) - Method in class com.sshtools.cipher.CAST5Engine
 
in - Variable in class com.maverick.scp.ScpClientIO.ScpEngineIO
 
init(byte[], int, int) - Method in interface com.maverick.ssh.SshPublicKey
Initialize the public key from a blob of binary data.
init(byte[], int, int) - Method in class com.maverick.ssh1.Ssh1RsaPublicKey
Initiate the key from an encoded bte array.
init(int, byte[], byte[]) - Method in class com.maverick.ssh1.SshDes
 
init(int, byte[], byte[]) - Method in class com.maverick.ssh1.SshDes3
 
init(byte[], int, int) - Method in class com.maverick.ssh2.Ssh2DsaPublicKey
Initialize the public key from an SSH2 key blob
init(byte[], int, int) - Method in class com.maverick.ssh2.Ssh2RsaPublicKey
 
init(byte[]) - Method in class com.maverick.ssh2.SshHmac
Initialize the MAC
init(boolean, byte[]) - Method in class com.sshtools.cipher.AESEngine
 
init(boolean, byte[]) - Method in class com.sshtools.cipher.CAST5Engine
 
init(boolean, byte[]) - Method in class com.sshtools.cipher.TwofishEngine
 
initialize() - Method in class com.maverick.sftp.SftpSubsystemChannel
Initializes the sftp subsystem and negotiates a version with the server.
initializeTunnel(SshTunnel) - Method in interface com.maverick.ssh.ForwardingRequestListener
Called once a connection has been established and a forwarding channel is about to be opened.
isAuthenticated() - Method in interface com.maverick.ssh.SshClient
Evaluate whether the user has been authenticated.
isAuthenticated() - Method in class com.maverick.ssh1.Ssh1Client
 
isAuthenticated() - Method in class com.maverick.ssh2.Ssh2Client
 
isAuthenticating() - Method in class com.maverick.ssh.PublicKeyAuthentication
Is the authentication attempt actually going to perform an authentication or are we simply just checking the suitability of a public key.
isBlock() - Method in class com.maverick.sftp.SftpFile
Determine whether the file is pointing to a block special file.
isBlock() - Method in class com.maverick.sftp.SftpFileAttributes
Determine whether these attributes refer to a block special file.
isCancelled() - Method in interface com.maverick.sftp.FileTransferProgress
The transfer is cancelled.
isCharacter() - Method in class com.maverick.sftp.SftpFile
Determine whether the file is pointing to a character mode device.
isCharacter() - Method in class com.maverick.sftp.SftpFileAttributes
Determine whether these attributes refer to a character device.
isClosed() - Method in interface com.maverick.ssh.SshChannel
Evaluate whether the channel is closed.
isClosed() - Method in interface com.maverick.ssh.SshSession
Evaluate whether the channel is closed.
isClosed() - Method in class com.maverick.ssh.SubsystemChannel
 
isClosed() - Method in class com.sshtools.sftp.SftpClient
Returns the state of the SFTP client.
isConnected() - Method in interface com.maverick.ssh.SshClient
Evaluate whether the connection is still alive.
isConnected() - Method in class com.maverick.ssh1.Ssh1Client
 
isConnected() - Method in class com.maverick.ssh2.Ssh2Client
 
isDirectory() - Method in class com.maverick.sftp.SftpFile
Determine whether the file object is pointing to a directory.
isDirectory() - Method in class com.maverick.sftp.SftpFileAttributes
Determine whether these attributes refer to a directory
isFifo() - Method in class com.maverick.sftp.SftpFile
Determine whether the file is pointing to a pipe.
isFifo() - Method in class com.maverick.sftp.SftpFileAttributes
Determine whether these attributes refer to a pipe.
isFile() - Method in class com.maverick.sftp.SftpFile
Determine whether the file object is pointing to a file.
isFile() - Method in class com.maverick.sftp.SftpFileAttributes
Determine whether these attributes refer to a file.
isFlagSet(int) - Method in class com.maverick.sftp.SftpFileAttributes
Determine if a permissions flag is set.
isFlowControlEnabled() - Method in class com.maverick.ssh2.Ssh2Session
On many systems it is possible to determine whether a pseudo-terminal is using control-S/ control-Q flow control.
isHostFileWriteable() - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification
Determines whether the host file is writable.
isLicensed() - Method in class com.maverick.ssh.SshConnector
 
isLink() - Method in class com.maverick.sftp.SftpFile
Determine whether the file object is a symbolic link.
isLink() - Method in class com.maverick.sftp.SftpFileAttributes
Determine whether these attributes refer to a symbolic link.
isLocal() - Method in interface com.maverick.ssh.SshTunnel
Determines the type of forwarding channel.
isOpen() - Method in class com.maverick.sftp.SftpFile
Determine whether the file is open.
isPassphraseProtected() - Method in interface com.sshtools.publickey.SshPrivateKeyFile
Determine if the private key file is protected by a passphrase.
isSocket() - Method in class com.maverick.sftp.SftpFile
Determine whether the file is pointing to a socket.
isSocket() - Method in class com.maverick.sftp.SftpFileAttributes
Determine whether these attributes refer to a socket.
isX11() - Method in interface com.maverick.ssh.SshTunnel
Determine if this channel is an X11 forwarding channel.
isXForwarding() - Method in class com.sshtools.net.ForwardingClient
Is X forwarding currently active?

K

KBIAuthentication - class com.maverick.ssh2.KBIAuthentication.
keyboard-interactive authentication implementation as specified in draft-ietf-secsh-auth-kbdinteract-04.txt.
KBIAuthentication() - Constructor for class com.maverick.ssh2.KBIAuthentication
 
KBIPrompt - class com.maverick.ssh2.KBIPrompt.
Represents a single prompt in the keyboard-interactive authentication process
KBIPrompt(String, boolean) - Constructor for class com.maverick.ssh2.KBIPrompt
Creates a new KBIPrompt object.
KBIRequestHandler - interface com.maverick.ssh2.KBIRequestHandler.
Callback interface used by the KBIAuthentication authentication mechanism.
KEX_DIFFIE_HELLMAN_GROUP1_SHA1 - Static variable in class com.maverick.ssh2.Ssh2Context
Currently the one and only key exchange mechanism

L

LOCAL_FORWARDING - Static variable in interface com.sshtools.net.ForwardingClientListener
Constant used to specify whether the event relates to a local forwarding
LicenseManager - class com.maverick.ssh.LicenseManager.
Add your license using the static method provided by this class.
LicenseManager() - Constructor for class com.maverick.ssh.LicenseManager
 
lcd(String) - Method in class com.sshtools.sftp.SftpClient
Changes the local working directory.
license - Static variable in class com.maverick.ssh.SshConnector
 
list(String) - Method in class com.maverick.ssh2.AbstractComponentFactory
List the types of components supported by this factory.
listChildren(SftpFile, Vector) - Method in class com.maverick.sftp.SftpSubsystemChannel
List the children of a directory.
lpwd() - Method in class com.sshtools.sftp.SftpClient
Returns the absolute path to the local working directory.
ls() - Method in class com.sshtools.sftp.SftpClient
List the contents of the current remote working directory.
ls(String) - Method in class com.sshtools.sftp.SftpClient
List the contents remote directory.

M

M32 - Static variable in class com.sshtools.cipher.CAST5Engine
 
MAX_ROUNDS - Static variable in class com.sshtools.cipher.CAST5Engine
 
main(String[]) - Static method in class com.sshtools.cipher.TwofishEngine
 
main(String[]) - Static method in class com.sshtools.publickey.SshKeyPairGenerator
 
makeDirectory(String) - Method in class com.maverick.sftp.SftpSubsystemChannel
Make a directory.
makeDirectory(String, SftpFileAttributes) - Method in class com.maverick.sftp.SftpSubsystemChannel
Make a directory.
mkdir(String) - Method in class com.sshtools.sftp.SftpClient
Creates a new directory on the remote server.
mkdirs(String) - Method in class com.sshtools.sftp.SftpClient
Create a directory or set of directories.

O

OPENSSH_FORMAT - Static variable in class com.sshtools.publickey.SshPrivateKeyFileFactory
 
OPENSSH_FORMAT - Static variable in class com.sshtools.publickey.SshPublicKeyFileFactory
 
OPEN_APPEND - Static variable in class com.maverick.sftp.SftpSubsystemChannel
File open flag, forces all writes to append data at the end of the file.
OPEN_CREATE - Static variable in class com.maverick.sftp.SftpSubsystemChannel
File open flag, if specified a new file will be created if one does not already exist.
OPEN_EXCLUSIVE - Static variable in class com.maverick.sftp.SftpSubsystemChannel
File open flag, causes an open request to fail if the named file already exists.
OPEN_READ - Static variable in class com.maverick.sftp.SftpSubsystemChannel
File open flag, opens the file for reading.
OPEN_TRUNCATE - Static variable in class com.maverick.sftp.SftpSubsystemChannel
File open flag, forces an existing file with the same name to be truncated to zero length when creating a file by specifying OPEN_CREATE.
OPEN_WRITE - Static variable in class com.maverick.sftp.SftpSubsystemChannel
File open flag, opens the file for writing.
onHostKeyMismatch(String, SshPublicKey, SshPublicKey) - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification
Called by the verifyHost method when the host key supplied by the host does not match the current key recording in the known hosts file.
onHostKeyMismatch(String, SshPublicKey, SshPublicKey) - Method in class com.sshtools.publickey.ConsoleKnownHostsKeyVerification
Prompts the user through the console to verify the host key.
onUnknownHost(String, SshPublicKey) - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification
Called by the verifyHost method when the host key supplied is not recorded in the known_hosts file.
onUnknownHost(String, SshPublicKey) - Method in class com.sshtools.publickey.ConsoleKnownHostsKeyVerification
Prompts the user through the console to verify the host key.
open(int, int, int) - Method in class com.maverick.ssh2.Ssh2Channel
Called once an SSH_MSG_CHANNEL_OPEN_CONFIRMATION has been sent.
open(int, int, int, byte[]) - Method in class com.maverick.ssh2.Ssh2Channel
Once a SSH_MSG_CHANNEL_OPEN_CONFIRMATION message is received the framework calls this method to complete the channel open operation.
openChannel(Ssh2Channel, byte[]) - Method in class com.maverick.ssh2.Ssh2Client
Additional method to open a custom SSH2 channel.
openChannel(SshAbstractChannel) - Method in class com.maverick.ssh2.Ssh2Client
Additional method to open a custom SSH2 channel.
openDirectory(String) - Method in class com.maverick.sftp.SftpSubsystemChannel
Open a directory.
openFile(String, int) - Method in class com.maverick.sftp.SftpSubsystemChannel
Open a file.
openFile(String, int, SftpFileAttributes) - Method in class com.maverick.sftp.SftpSubsystemChannel
Open a file.
openForwardingChannel(String, int, String, int, String, int, SshTransport, ChannelEventListener) - Method in interface com.maverick.ssh.SshClient
Open a TCPIP forwarding channel to the remote computer.
openForwardingChannel(String, int, String, int, String, int, SshTransport, ChannelEventListener) - Method in class com.maverick.ssh1.Ssh1Client
 
openForwardingChannel(String, int, String, int, String, int, SshTransport, ChannelEventListener) - Method in class com.maverick.ssh2.Ssh2Client
 
openSessionChannel() - Method in interface com.maverick.ssh.SshClient
Open a session on the remote computer.
openSessionChannel(ChannelEventListener) - Method in interface com.maverick.ssh.SshClient
Open a session on the remote computer.
openSessionChannel() - Method in class com.maverick.ssh1.Ssh1Client
Opens the one and only session channel available on an SSH1 connection, calling this method multiple times on the same client instance will return the same session instance.
openSessionChannel(ChannelEventListener) - Method in class com.maverick.ssh1.Ssh1Client
 
openSessionChannel() - Method in class com.maverick.ssh2.Ssh2Client
 
openSessionChannel(ChannelEventListener) - Method in class com.maverick.ssh2.Ssh2Client
 
openSessionChannel(int, int, ChannelEventListener) - Method in class com.maverick.ssh2.Ssh2Client
Addtional method to open a session with SSH2 specific features.
out - Variable in class com.maverick.scp.ScpClientIO.ScpEngineIO
 

P

PUBLIC_KEY_ACCEPTABLE - Static variable in interface com.maverick.ssh.SshAuthentication
The public key provided is acceptable for authentication
PUBLIC_KEY_SSHDSS - Static variable in class com.maverick.ssh2.Ssh2Context
SSH2 DSA Public Key
PUBLIC_KEY_SSHRSA - Static variable in class com.maverick.ssh2.Ssh2Context
SSH2 RSA Public Key
PasswordAuthentication - class com.maverick.ssh.PasswordAuthentication.
Basic password authentication class used for SSH password authentication.
PasswordAuthentication() - Constructor for class com.maverick.ssh.PasswordAuthentication
 
PublicKeyAuthentication - class com.maverick.ssh.PublicKeyAuthentication.
Public key based authentication implementation.
PublicKeyAuthentication() - Constructor for class com.maverick.ssh.PublicKeyAuthentication
 
parse(byte[]) - Static method in class com.sshtools.publickey.SshPrivateKeyFileFactory
Parse formatted data and return a suitable SshPrivateKeyFile implemenation.
parse(InputStream) - Static method in class com.sshtools.publickey.SshPrivateKeyFileFactory
Parse an InputStrewam and return a suitable SshPrivateKeyFile implementation.
parse(byte[]) - Static method in class com.sshtools.publickey.SshPublicKeyFileFactory
Parse a formatted public key and return a file representation.
parse(InputStream) - Static method in class com.sshtools.publickey.SshPublicKeyFileFactory
Parse a formatted key from an InputStream and return a file representation.
parseCommand(String, String[]) - Method in class com.maverick.scp.ScpClientIO.ScpEngineIO
Parse an SCP command
performOptimizedRead(byte[], long, int, OutputStream, int, FileTransferProgress) - Method in class com.maverick.sftp.SftpSubsystemChannel
Performs an optimized read of a file through use of asynchronous messages.
performOptimizedWrite(byte[], int, int, InputStream, int, FileTransferProgress) - Method in class com.maverick.sftp.SftpSubsystemChannel
Performs an optimized write of a file through asynchronous messaging and through buffering the local file into memory.
postWriteRequest(byte[], UnsignedInteger64, byte[], int, int) - Method in class com.maverick.sftp.SftpSubsystemChannel
Send a write request for an open file but do not wait for the response from the server.
processBlock(byte[], int, byte[], int) - Method in class com.sshtools.cipher.AESEngine
 
processBlock(byte[], int, byte[], int) - Method in class com.sshtools.cipher.CAST5Engine
 
processBlock(byte[], int, byte[], int) - Method in class com.sshtools.cipher.TwofishEngine
 
processChannelMessage(SshChannelMessage) - Method in class com.maverick.ssh2.Ssh2Channel
Processes channel request messages by passing the request through to channelRequest().
processExtendedData(int, byte[], int, int) - Method in class com.maverick.ssh2.Ssh2Channel
Called when extended data arrives, by default this method does nothing
processExtendedData(int, byte[], int, int) - Method in class com.maverick.ssh2.Ssh2Session
 
processGlobalRequest(GlobalRequest) - Method in interface com.maverick.ssh2.GlobalRequestHandler
Called when a supported global request has been recieved.
processStandardData(byte[], int, int) - Method in class com.maverick.ssh2.Ssh2Channel
Called when channel data arrives, by default this method makes the data available in the channels InputStream.
progressed(long) - Method in interface com.maverick.sftp.FileTransferProgress
The transfer has progressed
put(InputStream, long, String, String) - Method in class com.maverick.scp.ScpClientIO
Uploads a java.io.InputStream to a remove server as file.
put(String, String, boolean) - Method in class com.sshtools.scp.ScpClient
Uploads a local file onto the remote server.
put(String[], String, boolean) - Method in class com.sshtools.scp.ScpClient
Uploads an array of local files onto the remote server.
put(String, FileTransferProgress) - Method in class com.sshtools.sftp.SftpClient
Upload a file to the remote computer.
put(String) - Method in class com.sshtools.sftp.SftpClient
Upload a file to the remote computer
put(String, String, FileTransferProgress) - Method in class com.sshtools.sftp.SftpClient
Upload a file to the remote computer.
put(String, String) - Method in class com.sshtools.sftp.SftpClient
Upload a file to the remote computer
put(InputStream, String, FileTransferProgress) - Method in class com.sshtools.sftp.SftpClient
Upload a file to the remote computer reading from the specified InputStream.
put(InputStream, String) - Method in class com.sshtools.sftp.SftpClient
Upload the contents of an InputStream to the remote computer.
pwd() - Method in class com.sshtools.sftp.SftpClient
Returns the absolute path name of the current remote working directory.

Q

quit() - Method in class com.sshtools.sftp.SftpClient
Close the SFTP client.

R

RED_ROUNDS - Static variable in class com.sshtools.cipher.CAST5Engine
 
REMOTE_FORWARDING - Static variable in interface com.sshtools.net.ForwardingClientListener
Constant used to specify whether the event relates to a remote forwarding
RESOURCE_SHORTAGE - Static variable in class com.maverick.ssh2.ChannelOpenException
There are no more resources available to open the channel
read(byte[], int, int) - Method in class com.maverick.sftp.SftpFileInputStream
 
read() - Method in class com.maverick.sftp.SftpFileInputStream
 
readCompleteFile(OutputStream, long) - Method in class com.maverick.scp.ScpClientIO.ScpEngineIO
 
readFile(byte[], UnsignedInteger64, byte[], int, int) - Method in class com.maverick.sftp.SftpSubsystemChannel
Read a block of data from an open file.
readMessage() - Method in class com.maverick.ssh.SubsystemChannel
Read a subsystem message from the channel inputstream.
readStreamFromRemote() - Method in class com.maverick.scp.ScpClientIO.ScpEngineIO
Open an InputStream.
readString() - Method in class com.maverick.scp.ScpClientIO.ScpEngineIO
 
recurseMakeDirectory(String) - Method in class com.maverick.sftp.SftpSubsystemChannel
Recurse through a hierarchy of directories creating them as necersary.
remove(String) - Method in class com.maverick.ssh2.AbstractComponentFactory
Remove a supported component
removeAllowedHost(String) - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification
Removes an allowed host.
removeDirectory(String) - Method in class com.maverick.sftp.SftpSubsystemChannel
Remove an empty directory.
removeFile(String) - Method in class com.maverick.sftp.SftpSubsystemChannel
Remove a file.
removeListener(ForwardingClientListener) - Method in class com.sshtools.net.ForwardingClient
Remove a ForwardingClientListener from the list receiving forwarding events.
rename(String) - Method in class com.maverick.sftp.SftpFile
Rename a file on the remote server.
rename(String, String) - Method in class com.sshtools.sftp.SftpClient
Rename a file on the remote computer.
renameFile(String, String) - Method in class com.maverick.sftp.SftpSubsystemChannel
Rename an existing file.
requestPseudoTerminal(String, int, int, int, int, byte[]) - Method in interface com.maverick.ssh.SshSession
The remote process may require a pseudo terminal.
requestPseudoTerminal(String, int, int, int, int) - Method in interface com.maverick.ssh.SshSession
The remote process may require a pseudo terminal.
requestPseudoTerminal(String, int, int, int, int) - Method in class com.maverick.ssh2.Ssh2Session
 
requestPseudoTerminal(String, int, int, int, int, byte[]) - Method in class com.maverick.ssh2.Ssh2Session
 
requestRemoteForwarding(String, int, String, int, ForwardingRequestListener) - Method in interface com.maverick.ssh.SshClient
Requests that the remote computer accepts socket connections and forward them to the local computer.
requestRemoteForwarding(String, int, String, int, ForwardingRequestListener) - Method in class com.maverick.ssh1.Ssh1Client
The bindAddress is ignored since the SSH1 protocol does not support setting of the bind address.
requestRemoteForwarding(String, int, String, int, ForwardingRequestListener) - Method in class com.maverick.ssh2.Ssh2Client
 
requestRemoteForwarding(String, int, String, int) - Method in class com.sshtools.net.ForwardingClient
Requests that the remote side start listening for socket connections so that they may be forwarded to to the local destination.
requestXForwarding(String, ForwardingRequestListener) - Method in class com.maverick.ssh1.Ssh1Client
 
requiresPasswordChange() - Method in class com.maverick.ssh2.Ssh2PasswordAuthentication
Indicates whether the users password requires changing.
reset() - Method in class com.sshtools.cipher.AESEngine
 
reset() - Method in class com.sshtools.cipher.CAST5Engine
 
reset() - Method in class com.sshtools.cipher.TwofishEngine
 
rm(String) - Method in class com.sshtools.sftp.SftpClient
Remove a file or directory from the remote computer.
rm(String, boolean, boolean) - Method in class com.sshtools.sftp.SftpClient
Remove a file or directory on the remote computer with options to force deletion of existig files and recursion.

S

S1 - Static variable in class com.sshtools.cipher.CAST5Engine
 
S2 - Static variable in class com.sshtools.cipher.CAST5Engine
 
S3 - Static variable in class com.sshtools.cipher.CAST5Engine
 
S4 - Static variable in class com.sshtools.cipher.CAST5Engine
 
S5 - Static variable in class com.sshtools.cipher.CAST5Engine
 
S6 - Static variable in class com.sshtools.cipher.CAST5Engine
 
S7 - Static variable in class com.sshtools.cipher.CAST5Engine
 
S8 - Static variable in class com.sshtools.cipher.CAST5Engine
 
SECSH_FORMAT - Static variable in class com.sshtools.publickey.SshPublicKeyFileFactory
 
SESSION_CHANNEL - Static variable in class com.maverick.ssh2.Ssh2Channel
 
SOCKS4 - Static variable in class com.sshtools.net.SocksProxyTransport
 
SOCKS5 - Static variable in class com.sshtools.net.SocksProxyTransport
 
SSH1 - Static variable in class com.maverick.ssh.SshConnector
Constant for the SSH protocol version 1
SSH1_FORMAT - Static variable in class com.sshtools.publickey.SshPrivateKeyFileFactory
 
SSH1_FORMAT - Static variable in class com.sshtools.publickey.SshPublicKeyFileFactory
 
SSH1_RSA - Static variable in class com.sshtools.publickey.SshKeyPairGenerator
 
SSH2 - Static variable in class com.maverick.ssh.SshConnector
Constant for the SSH protocol version 2
SSH2_DSA - Static variable in class com.sshtools.publickey.SshKeyPairGenerator
 
SSH2_RSA - Static variable in class com.sshtools.publickey.SshKeyPairGenerator
 
SSHTOOLS_FORMAT - Static variable in class com.sshtools.publickey.SshPrivateKeyFileFactory
 
SSH_FX_BAD_MESSAGE - Static variable in class com.maverick.sftp.SftpStatusException
The client sent a bad protocol message
SSH_FX_CONNECTION_LOST - Static variable in class com.maverick.sftp.SftpStatusException
The file system connection was lost
SSH_FX_EOF - Static variable in class com.maverick.sftp.SftpStatusException
The file or listing is EOF
SSH_FX_FAILURE - Static variable in class com.maverick.sftp.SftpStatusException
Generic failure code
SSH_FX_NO_CONNECTION - Static variable in class com.maverick.sftp.SftpStatusException
There is no connection to the file system
SSH_FX_NO_SUCH_FILE - Static variable in class com.maverick.sftp.SftpStatusException
No such file was found
SSH_FX_OK - Static variable in class com.maverick.sftp.SftpStatusException
Everything performed correctly
SSH_FX_OP_UNSUPPORTED - Static variable in class com.maverick.sftp.SftpStatusException
The operation requested is not supported
SSH_FX_PERMISSION_DENIED - Static variable in class com.maverick.sftp.SftpStatusException
The user does not have permission
S_IFBLK - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Identifies the file as a block special file
S_IFCHR - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Identifies the file as a character device
S_IFDIR - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Identifies the file as a directory
S_IFIFO - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Identifies the file as a pipe
S_IFLNK - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Identifies the file as a symbolic link
S_IFMT - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Format mask constant can be used to mask off a file type from the mode.
S_IFREG - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Identifies the file as a regular file
S_IFSOCK - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Identifies the file as a socket
S_IRGRP - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Permits a file's group to read the file.
S_IROTH - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Permits others to read the file.
S_IRUSR - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Permits the owner of a file to read the file.
S_ISGID - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Bit to determine whether a file is executed as the group owner
S_ISUID - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Bit to determine whether a file is executed as the owner
S_IWGRP - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Permits a file's group to write to the file.
S_IWOTH - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Permits others to write to the file.
S_IWUSR - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Permits the owner of a file to write to the file.
S_IXGRP - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Permits a file's group to execute the file or to search the file's directory.
S_IXOTH - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Permits others to execute the file or to search the file's directory.
S_IXUSR - Static variable in class com.maverick.sftp.SftpFileAttributes
Permissions flag: Permits the owner of a file to execute the file or to search the file's directory.
ScpClient - class com.sshtools.scp.ScpClient.
Implements an SCP (Secure Copy) client which may be useful for SSH1 connections and SSH2 where SFTP is not available.
ScpClient(SshClient) - Constructor for class com.sshtools.scp.ScpClient
Creates an SCP client.
ScpClient(File, SshClient) - Constructor for class com.sshtools.scp.ScpClient
Creates an SCP client.
ScpClient.ScpEngine - class com.sshtools.scp.ScpClient.ScpEngine.
Implements an SCP Engine by extending J2SSH Mavericjs ScpEngineIO
ScpClient.ScpEngine(String, SshSession) - Constructor for class com.sshtools.scp.ScpClient.ScpEngine
Contruct the channel with the specified scp command.
ScpClientIO - class com.maverick.scp.ScpClientIO.
Implements the IO of a Secure Copy (SCP) client.
ScpClientIO(SshClient) - Constructor for class com.maverick.scp.ScpClientIO
Creates an SCP client.
ScpClientIO.ScpEngineIO - class com.maverick.scp.ScpClientIO.ScpEngineIO.
Implements an SCP engine.
ScpClientIO.ScpEngineIO(String, SshSession) - Constructor for class com.maverick.scp.ScpClientIO.ScpEngineIO
Contruct the channel with the specified scp command.
SftpClient - class com.sshtools.sftp.SftpClient.
Implements a Secure File Transfer (SFTP) client.
SftpClient(SshClient) - Constructor for class com.sshtools.sftp.SftpClient
Constructs the SFTP client with a given channel event listener.
SftpFile - class com.maverick.sftp.SftpFile.
Represents an SFTP file object.
SftpFile(String, SftpFileAttributes) - Constructor for class com.maverick.sftp.SftpFile
Creates a new SftpFile object.
SftpFile(String) - Constructor for class com.maverick.sftp.SftpFile
Creates a new SftpFile object.
SftpFileAttributes - class com.maverick.sftp.SftpFileAttributes.
This class represents the ATTRS structure defined in the draft-ietf-secsh-filexfer-02.txt which is used by the protocol to store file attribute information.
SftpFileAttributes() - Constructor for class com.maverick.sftp.SftpFileAttributes
Creates a new FileAttributes object.
SftpFileAttributes(ByteArrayReader) - Constructor for class com.maverick.sftp.SftpFileAttributes
 
SftpFileInputStream - class com.maverick.sftp.SftpFileInputStream.
An InputStream to read the contents of a remote file.
SftpFileInputStream(SftpFile) - Constructor for class com.maverick.sftp.SftpFileInputStream
Creates a new SftpFileInputStream object.
SftpFileOutputStream - class com.maverick.sftp.SftpFileOutputStream.
An OutputStream to write data to a remote file.
SftpFileOutputStream(SftpFile) - Constructor for class com.maverick.sftp.SftpFileOutputStream
Creates a new SftpFileOutputStream object.
SftpStatusException - exception com.maverick.sftp.SftpStatusException.
This exception is thrown by the SftpSubsystemChannel class whenever a status message is received that is not expected.
SftpSubsystemChannel - class com.maverick.sftp.SftpSubsystemChannel.
This class implements the SFTP protocol which is executed as an SSH subsystem.
SftpSubsystemChannel(SshSession) - Constructor for class com.maverick.sftp.SftpSubsystemChannel
Constructs an uninitialized sftp channel with an unitialized session channel
SocketTransport - class com.sshtools.net.SocketTransport.
Extends a Socket to provide an SshTransport suitable for use in making connections using the SshConnector.
SocketTransport(String, int) - Constructor for class com.sshtools.net.SocketTransport
Connect the socket.
SocketWrapper - class com.sshtools.net.SocketWrapper.
Implements a basic wrapper around a Socket to provide an SshTransport suitable for use in making connections using the SshConnector.
SocketWrapper(Socket) - Constructor for class com.sshtools.net.SocketWrapper
Create a SocketWrapper
SocksProxyTransport - class com.sshtools.net.SocksProxyTransport.
Provides an SshTransport implementation that can route the connection through a SOCKS 4 or SOCKS 5 proxy.
Ssh1Client - class com.maverick.ssh1.Ssh1Client.
Implementation of an SshClient for the SSH1 protocol; no additional features are currently implemented outside of the general SshClient contract.
Ssh1Client() - Constructor for class com.maverick.ssh1.Ssh1Client
Default public constructor for the client called by SshConnector.
Ssh1Context - class com.maverick.ssh1.Ssh1Context.
This class implements SshContext to provide SSH1 connection configuration through the SshConnector class.
Ssh1Context() - Constructor for class com.maverick.ssh1.Ssh1Context
Construct a new context instance with default values.
Ssh1RsaPublicKey - class com.maverick.ssh1.Ssh1RsaPublicKey.
This class represents an SSH1 RSA public key.
Ssh1RsaPublicKey(BigInteger, BigInteger) - Constructor for class com.maverick.ssh1.Ssh1RsaPublicKey
Construct the RSA public key.
Ssh2Channel - class com.maverick.ssh2.Ssh2Channel.
All terminal sessions, forwarded connections, etc are channels and this class implements the base SSH2 channel.
Ssh2Channel(String, int, int) - Constructor for class com.maverick.ssh2.Ssh2Channel
Construct an SSH2 channel
Ssh2Client - class com.maverick.ssh2.Ssh2Client.
Implementation of an SshClient for the SSH2 protocol; this provides the ability to create custom channels and sending/receiving of global requests in addition to the standard SshClient contract.
Ssh2Client() - Constructor for class com.maverick.ssh2.Ssh2Client
Default contructor called by SshConnector.
Ssh2Context - class com.maverick.ssh2.Ssh2Context.
This class implements SshContextto provide SSH2 connection configuration through the SshConnector class.
Ssh2Context() - Constructor for class com.maverick.ssh2.Ssh2Context
Contructs a default context
Ssh2DsaPublicKey - class com.maverick.ssh2.Ssh2DsaPublicKey.
Represents an SSH2 DSA public key.
Ssh2DsaPublicKey(BigInteger, BigInteger, BigInteger, BigInteger) - Constructor for class com.maverick.ssh2.Ssh2DsaPublicKey
Construct a DSA key from the parameters.
Ssh2DsaPublicKey() - Constructor for class com.maverick.ssh2.Ssh2DsaPublicKey
Default contructor used to initialize the key from an encoded byte array using the init method.
Ssh2PasswordAuthentication - class com.maverick.ssh2.Ssh2PasswordAuthentication.
Implements Password authentication as defined in the SSH Authenticaiton Protocol.
Ssh2PasswordAuthentication() - Constructor for class com.maverick.ssh2.Ssh2PasswordAuthentication
Construct the method
Ssh2PublicKeyAuthentication - class com.maverick.ssh2.Ssh2PublicKeyAuthentication.
SSH2 public key authentication providing additional SSH2 public key authentication features.
Ssh2PublicKeyAuthentication() - Constructor for class com.maverick.ssh2.Ssh2PublicKeyAuthentication
 
Ssh2PublicKeyAuthentication.SignatureGenerator - interface com.maverick.ssh2.Ssh2PublicKeyAuthentication.SignatureGenerator.
Provides a callback when a private key signature is required.
Ssh2RsaPublicKey - class com.maverick.ssh2.Ssh2RsaPublicKey.
Represents an SSH2 RSA Public key.
Ssh2RsaPublicKey() - Constructor for class com.maverick.ssh2.Ssh2RsaPublicKey
Default constructor for initializing the key from a byte array using the init method.
Ssh2RsaPublicKey(BigInteger, BigInteger) - Constructor for class com.maverick.ssh2.Ssh2RsaPublicKey
Construct an RSA key from parameters.
Ssh2Session - class com.maverick.ssh2.Ssh2Session.
This class implements the SSH2 session channel, unlike SSH1 multiple sessions can be opened on the same SSH connection.
Ssh2Session(int, int, Ssh2Client) - Constructor for class com.maverick.ssh2.Ssh2Session
Contruct a session channel.
SshAuthentication - interface com.maverick.ssh.SshAuthentication.
The base interface for all SSH authentication mechanisms and authentication result constants.
SshChannel - interface com.maverick.ssh.SshChannel.
The base interface for all SSH channels.
SshClient - interface com.maverick.ssh.SshClient.
This interface defines the general contract for an SSH client that is compatible for both the SSH1 and SSH2 protocols.
SshConnector - class com.maverick.ssh.SshConnector.
Connecting to an SSH server STARTS HERE!.
SshContext - interface com.maverick.ssh.SshContext.
This interface defines the general configuration items available to both SSH1 and SSH2.
SshDes - class com.maverick.ssh1.SshDes.
DES cipher for SSH1.
SshDes() - Constructor for class com.maverick.ssh1.SshDes
 
SshDes3 - class com.maverick.ssh1.SshDes3.
3DES cipher implementation for SSH1.
SshDes3() - Constructor for class com.maverick.ssh1.SshDes3
 
SshHmac - class com.maverick.ssh2.SshHmac.
Data integrity is provided by the SSH Transport Protocol by including with each packet a message authentication code (MAC) that is computed from a shared secret, packet sequence number, and the contents of the packet.
SshHmac(String, GeneralDigest) - Constructor for class com.maverick.ssh2.SshHmac
Contruct an uninitialized MAC
SshKeyPair - class com.sshtools.publickey.SshKeyPair.
Storage class for a public/private key pair.
SshKeyPair() - Constructor for class com.sshtools.publickey.SshKeyPair
 
SshKeyPairGenerator - class com.sshtools.publickey.SshKeyPairGenerator.
Generate public/private key pairs.
SshKeyPairGenerator() - Constructor for class com.sshtools.publickey.SshKeyPairGenerator
 
SshPrivateKey - interface com.maverick.ssh.SshPrivateKey.
Interface for SSH supported private keys.
SshPrivateKeyFile - interface com.sshtools.publickey.SshPrivateKeyFile.
Interface which all private key formats must implement to provide decoding and decryption of the private key into a suitable format for the API.
SshPrivateKeyFileFactory - class com.sshtools.publickey.SshPrivateKeyFileFactory.
Private key format factory used to decode private key files.
SshPrivateKeyFileFactory() - Constructor for class com.sshtools.publickey.SshPrivateKeyFileFactory
 
SshPublicKey - interface com.maverick.ssh.SshPublicKey.
Interface for SSH supported public keys.
SshPublicKeyFile - interface com.sshtools.publickey.SshPublicKeyFile.
Interface which all public key formats must implement to provide decoding of the public key into a suitable format for the API.
SshPublicKeyFileFactory - class com.sshtools.publickey.SshPublicKeyFileFactory.
Public key format factory used to decode different formats of public keys.
SshPublicKeyFileFactory() - Constructor for class com.sshtools.publickey.SshPublicKeyFileFactory
 
SshSession - interface com.maverick.ssh.SshSession.
Base interface for SSH sessions supporting all the features common to both SSH1 and SSH2.
SshTransport - interface com.maverick.ssh.SshTransport.
Simple interface wrapper for transport layer communication.
SshTunnel - interface com.maverick.ssh.SshTunnel.
Interface defining the contract for SSH forwarding channels.
SubsystemChannel - class com.maverick.ssh.SubsystemChannel.
This class provides useful methods for implementing an SSH2 subsystem.
SubsystemChannel(SshChannel) - Constructor for class com.maverick.ssh.SubsystemChannel
Create a new subsystem channel.
saveHostFile() - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification
Save's the host key file to be saved.
sendGlobalRequest(GlobalRequest, boolean) - Method in class com.maverick.ssh2.Ssh2Client
Sends a global request to the remote side.
sendMessage(byte[]) - Method in class com.maverick.ssh.SubsystemChannel
Write a subsystem message to the channel outputstream.
sendRequest(String, boolean, byte[]) - Method in class com.maverick.ssh2.Ssh2Channel
Sends a channel request.
session - Variable in class com.maverick.scp.ScpClientIO.ScpEngineIO
 
setAttributes(String, SftpFileAttributes) - Method in class com.maverick.sftp.SftpSubsystemChannel
Sets the attributes of a file.
setAttributes(SftpFile, SftpFileAttributes) - Method in class com.maverick.sftp.SftpSubsystemChannel
Sets the attributes of a file.
setAuthenticating(boolean) - Method in class com.maverick.ssh.PublicKeyAuthentication
If true the authentication will proceed as normal and the result will either be a success or failure.
setBannerDisplay(BannerDisplay) - Method in class com.maverick.ssh2.Ssh2Context
Set a banner display for callback of authentication banners
setBlockSize(int) - Method in class com.sshtools.sftp.SftpClient
Sets the block size used when transfering files, defaults to the optimized setting of 32768.
setBufferSize(int) - Method in class com.sshtools.sftp.SftpClient
Set the size of the buffer which is used to read from the local file system.
setChannelLimit(int) - Method in interface com.maverick.ssh.SshContext
Set the maximum number of channels that are allowed open at any one time.
setChannelLimit(int) - Method in class com.maverick.ssh1.Ssh1Context
 
setChannelLimit(int) - Method in class com.maverick.ssh2.Ssh2Context
 
setCharsetEncoding(String) - Method in class com.maverick.sftp.SftpSubsystemChannel
Allows the default character encoding to be overriden for filename strings.
setCipherType(int) - Method in class com.maverick.ssh1.Ssh1Context
Set the cipher type for this configuration context.
setData(byte[]) - Method in class com.maverick.ssh2.GlobalRequest
Set the data.
setEnvironmentVariable(String, String) - Method in class com.maverick.ssh2.Ssh2Session
The SSH2 session supports the setting of environments variables however in our expericance no server to date allows unconditional setting of variables.
setGID(UnsignedInteger32) - Method in class com.maverick.sftp.SftpFileAttributes
Set the GID of this file.
setHostKeyVerification(HostKeyVerification) - Method in interface com.maverick.ssh.SshContext
Set the host key verification implementation.
setHostKeyVerification(HostKeyVerification) - Method in class com.maverick.ssh1.Ssh1Context
 
setHostKeyVerification(HostKeyVerification) - Method in class com.maverick.ssh2.Ssh2Context
Set the host key verification implementation
setKBIRequestHandler(KBIRequestHandler) - Method in class com.maverick.ssh2.KBIAuthentication
Set the KBIRequestHandler for this authentication attempt.
setKey(byte[]) - Method in class com.sshtools.cipher.CAST5Engine
 
setMaxAsyncRequests(int) - Method in class com.sshtools.sftp.SftpClient
Set the maximum number of asynchronous requests that are outstanding at any one time.
setNewPassword(String) - Method in class com.maverick.ssh2.Ssh2PasswordAuthentication
After performing an initial authentication attempt a flag may be set to indicate that a password change is required.
setPassword(String) - Method in class com.maverick.ssh.PasswordAuthentication
Set the password.
setPermissions(UnsignedInteger32) - Method in class com.maverick.sftp.SftpFileAttributes
Set the permissions of the file.
setPermissions(String) - Method in class com.maverick.sftp.SftpFileAttributes
Set the permissions from a string in the format "rwxr-xr-x"
setPermissionsFromMaskString(String) - Method in class com.maverick.sftp.SftpFileAttributes
Set permissions given a UNIX style mask, for example '0644'
setPermissionsFromUmaskString(String) - Method in class com.maverick.sftp.SftpFileAttributes
Set the permissions given a UNIX style umask, for example '0022' will result in 0022 ^ 0777.
setPreferredCipherCS(String) - Method in class com.maverick.ssh2.Ssh2Context
Set the preferred cipher for the Client->Server stream.
setPreferredCipherSC(String) - Method in class com.maverick.ssh2.Ssh2Context
Set the preferred cipher for the Server->Client stream.
setPreferredCompressionCS(String) - Method in class com.maverick.ssh2.Ssh2Context
Set the preferred compression for the Client->Server stream.
setPreferredCompressionSC(String) - Method in class com.maverick.ssh2.Ssh2Context
Set the preferred compression for the Server->Client stream.
setPreferredKeyExchange(String) - Method in class com.maverick.ssh2.Ssh2Context
Set the preferred key exchange method.
setPreferredMacCS(String) - Method in class com.maverick.ssh2.Ssh2Context
Set the preferred mac for the Client->Server stream.
setPreferredMacSC(String) - Method in class com.maverick.ssh2.Ssh2Context
Set the preferred mac for the Server->Client stream.
setPreferredPublicKey(String) - Method in class com.maverick.ssh2.Ssh2Context
Set the preferred public key algorithm.
setPrivateKey(SshPrivateKey) - Method in class com.maverick.ssh.PublicKeyAuthentication
Set the private key for this authentication.
setPublicKey(SshPublicKey) - Method in class com.maverick.ssh.PublicKeyAuthentication
Set the public key for this authentication.
setResponse(String) - Method in class com.maverick.ssh2.KBIPrompt
Set the user's response for this prompt.
setSFTPProvider(String) - Method in interface com.maverick.ssh.SshContext
Set the path to the SFTP provider.
setSFTPProvider(String) - Method in class com.maverick.ssh1.Ssh1Context
 
setSFTPProvider(String) - Method in class com.maverick.ssh2.Ssh2Context
 
setSignatureGenerator(Ssh2PublicKeyAuthentication.SignatureGenerator) - Method in class com.maverick.ssh2.Ssh2PublicKeyAuthentication
Set the signature generator for this authentication attempt.
setSize(UnsignedInteger64) - Method in class com.maverick.sftp.SftpFileAttributes
Set the size of the file.
setSupportedVersions(int) - Method in class com.maverick.ssh.SshConnector
Sets the protocol versions supported by this connector.
setTimes(UnsignedInteger32, UnsignedInteger32) - Method in class com.maverick.sftp.SftpFileAttributes
Set the last access and last modified times.
setUID(UnsignedInteger32) - Method in class com.maverick.sftp.SftpFileAttributes
Set the UID of the owner.
setUsername(String) - Method in class com.maverick.ssh.PasswordAuthentication
Set the username.
setUsername(String) - Method in class com.maverick.ssh.PublicKeyAuthentication
 
setUsername(String) - Method in interface com.maverick.ssh.SshAuthentication
Set the username for this authentication attempt.
setUsername(String) - Method in class com.maverick.ssh2.KBIAuthentication
 
setX11Display(String) - Method in interface com.maverick.ssh.SshContext
Set the DISPLAY variable for the SSH connection.
setX11Display(String) - Method in class com.maverick.ssh1.Ssh1Context
 
setX11Display(String) - Method in class com.maverick.ssh2.Ssh2Context
 
setX11RealCookie(byte[]) - Method in interface com.maverick.ssh.SshContext
Sets the real X11 authentication cookie which can be obtained from the users $HOME/.Xauthority file.
setX11RealCookie(byte[]) - Method in class com.maverick.ssh1.Ssh1Context
 
setX11RealCookie(byte[]) - Method in class com.maverick.ssh2.Ssh2Context
 
setX11RequestListener(ForwardingRequestListener) - Method in interface com.maverick.ssh.SshContext
Set the listener to which X11 forwarding requests will be processed.
setX11RequestListener(ForwardingRequestListener) - Method in class com.maverick.ssh1.Ssh1Context
 
setX11RequestListener(ForwardingRequestListener) - Method in class com.maverick.ssh2.Ssh2Context
 
showPrompts(String, String, KBIPrompt[]) - Method in interface com.maverick.ssh2.KBIRequestHandler
Called by the keyboard-interactive authentication mechanism when the server requests information from the user.
sign(byte[]) - Method in interface com.maverick.ssh.SshPrivateKey
Create a signature from the data.
sign(SshPublicKey, byte[]) - Method in interface com.maverick.ssh2.Ssh2PublicKeyAuthentication.SignatureGenerator
 
signal(String) - Method in class com.maverick.ssh2.Ssh2Session
Send a signal to the remote process.
ssh - Variable in class com.maverick.scp.ScpClientIO
 
startLocalForwarding(String, int, String, int) - Method in class com.sshtools.net.ForwardingClient
Start's a local listening socket and forwards any connections made to the to the remote side.
startShell() - Method in interface com.maverick.ssh.SshSession
Start the users default shell.
startShell() - Method in class com.maverick.ssh2.Ssh2Session
 
startSubsystem(String) - Method in class com.maverick.ssh2.Ssh2Session
SSH2 supports special subsystems that are identified by a name rather than a command string, an example of an SSH2 subsystem is SFTP.
started(long, String) - Method in interface com.maverick.sftp.FileTransferProgress
The transfer has started
stat(String) - Method in class com.sshtools.sftp.SftpClient
Returns the attributes of the file from the remote computer.
stop() - Method in class com.sshtools.net.ForwardingClient.ActiveTunnel
Stop's the tunnel from transfering data, closing the channel and the attached socket.
stopAllLocalForwarding() - Method in class com.sshtools.net.ForwardingClient
Stop all local forwarding
stopLocalForwarding(String, int) - Method in class com.sshtools.net.ForwardingClient
Stops a local listening socket from accepting connections.
supported - Variable in class com.maverick.ssh2.AbstractComponentFactory
The supported components stored in a Hashtable with a String key as the component name such as "3des-cbc" and a Class value storing the implementation class.
supportedChannelTypes() - Method in interface com.maverick.ssh2.ChannelFactory
Return the supported channel types.
supportedCiphers() - Method in class com.maverick.ssh2.Ssh2Context
Returns this context's supported cipher algorithms.
supportedCompressions() - Method in class com.maverick.ssh2.Ssh2Context
Get this context's supported compression algorithms.
supportedKeyExchanges() - Method in class com.maverick.ssh2.Ssh2Context
Get this context's supported key exchange methods.
supportedMacs() - Method in class com.maverick.ssh2.Ssh2Context
Get this context's supported message authentication algorithms.
supportedPublicKeys() - Method in class com.maverick.ssh2.Ssh2Context
Get this context's supported public keys.
supportedRequests() - Method in interface com.maverick.ssh2.GlobalRequestHandler
Return the supported request types.
symlink(String, String) - Method in class com.sshtools.sftp.SftpClient
Create a symbolic link on the remote computer.

T

TRIPLEDES_CBC - Static variable in class com.maverick.ssh2.TripleDesCbc
 
TWOFISH128_CBC - Static variable in class com.sshtools.cipher.Twofish128Cbc
 
TWOFISH192_CBC - Static variable in class com.sshtools.cipher.Twofish192Cbc
 
TWOFISH256_CBC - Static variable in class com.sshtools.cipher.Twofish256Cbc
 
TWOFISH_CBC - Static variable in class com.sshtools.cipher.Twofish256Cbc
 
TransferCancelledException - exception com.maverick.sftp.TransferCancelledException.
Exception thrown when a file transfer is cancelled.
TransferCancelledException() - Constructor for class com.maverick.sftp.TransferCancelledException
Creates a new TransferCancelledException object.
TripleDesCbc - class com.maverick.ssh2.TripleDesCbc.
3DES cipher for SSH2.
TripleDesCbc() - Constructor for class com.maverick.ssh2.TripleDesCbc
Contstruct the uninitialized cipher.
Twofish128Cbc - class com.sshtools.cipher.Twofish128Cbc.
This cipher can optionally be added to the J2SSH Maverick API.
Twofish128Cbc() - Constructor for class com.sshtools.cipher.Twofish128Cbc
 
Twofish192Cbc - class com.sshtools.cipher.Twofish192Cbc.
This cipher can optionally be added to the J2SSH Maverick API.
Twofish192Cbc() - Constructor for class com.sshtools.cipher.Twofish192Cbc
 
Twofish256Cbc - class com.sshtools.cipher.Twofish256Cbc.
This cipher can optionally be added to the J2SSH Maverick API.
Twofish256Cbc() - Constructor for class com.sshtools.cipher.Twofish256Cbc
 
TwofishEngine - class com.sshtools.cipher.TwofishEngine.
A class that provides Twofish encryption operations.
TwofishEngine() - Constructor for class com.sshtools.cipher.TwofishEngine
 
toByteArray() - Method in class com.maverick.sftp.SftpFileAttributes
Returns a formatted byte array suitable for encoding into SFTP subsystem messages.
toKeyPair(String) - Method in interface com.sshtools.publickey.SshPrivateKeyFile
Decode the private key using the users passphrase.
toPublicKey() - Method in interface com.sshtools.publickey.SshPublicKeyFile
Convert the key file into a usable SshPublicKey.
toString() - Method in class com.sshtools.net.HttpProxyTransport
 
toString() - Method in class com.sshtools.net.SocksProxyTransport
 
toString() - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification
Outputs the allowed hosts in the known_hosts file format.
transform(byte[], int, byte[], int, int) - Method in class com.maverick.ssh1.SshDes
 
transform(byte[], int, byte[], int, int) - Method in class com.maverick.ssh1.SshDes3
 

U

UNKNOWN_CHANNEL_TYPE - Static variable in class com.maverick.ssh2.ChannelOpenException
The channel type is unknown
umask(int) - Method in class com.sshtools.sftp.SftpClient
Sets the umask used by this client.
umask(String) - Method in class com.sshtools.sftp.SftpClient
Sets the umask for this client.

V

verify(long, byte[], int, int, byte[], int) - Method in class com.maverick.ssh2.SshHmac
Verify a MAC.
verifyHost(String, SshPublicKey) - Method in interface com.maverick.ssh.HostKeyVerification
Verify that the public key is acceptable for the host.
verifyHost(String, SshPublicKey) - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification
Verifies a host key against the list of known_hosts.
verifySignature(byte[], byte[]) - Method in interface com.maverick.ssh.SshPublicKey
Verify the signature.
verifySignature(byte[], byte[]) - Method in class com.maverick.ssh2.Ssh2DsaPublicKey
 
verifySignature(byte[], byte[]) - Method in class com.maverick.ssh2.Ssh2RsaPublicKey
 

W

waitForResponse() - Method in class com.maverick.scp.ScpClientIO.ScpEngineIO
 
write(byte[], int, int) - Method in class com.maverick.sftp.SftpFileOutputStream
 
write(int) - Method in class com.maverick.sftp.SftpFileOutputStream
 
writeCompleteFile(InputStream, long) - Method in class com.maverick.scp.ScpClientIO.ScpEngineIO
 
writeError(String) - Method in class com.maverick.scp.ScpClientIO.ScpEngineIO
 
writeFile(byte[], UnsignedInteger64, byte[], int, int) - Method in class com.maverick.sftp.SftpSubsystemChannel
Write a block of data to an open file.
writeOk() - Method in class com.maverick.scp.ScpClientIO.ScpEngineIO
 
writeStreamToRemote(InputStream, long, String) - Method in class com.maverick.scp.ScpClientIO.ScpEngineIO
Write a stream as a file to the remote server.

X

X11_FORWARDING - Static variable in interface com.sshtools.net.ForwardingClientListener
Constant used to specify whether the event relates to an X11 forwarding
X11_KEY - Static variable in class com.sshtools.net.ForwardingClient
The key used to identify X11 forwarding

_

_Km - Variable in class com.sshtools.cipher.CAST5Engine
 
_Kr - Variable in class com.sshtools.cipher.CAST5Engine
 

A B C D E F G H I K L M O P Q R S T U V W X _

Copyright © 2003 3SP LTD. All Rights Reserved.