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

A

AbstractKnownHostsKeyVerification - Class in com.sshtools.publickey

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.

ACCESS_DENIED - Static variable in exception com.sshtools.publickey.PublicKeySubsystemException

add(SshPublicKey, String) - Method in class com.sshtools.publickey.PublicKeySubsystem

Add a public key to the users list of acceptable keys.

addCustomRoot(String) - Method in class com.sshtools.sftp.SftpClient

Add a custom file system root path such as "flash:"

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.

addListener(ForwardingClientListener) - Method in class com.sshtools.net.ForwardingClient

Add a ForwardingClientListener to receive forwarding events.

adler - Variable in class com.sshtools.zlib.ZStream

allowedHosts() - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification

Returns a Map of the allowed hosts.

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 forwarding client to manage X11 connections.

allowX11Forwarding(String) - Method in class com.sshtools.net.ForwardingClient

Configure the forwarding client to manage X11 connections.

allowX11Forwarding(String, File) - Method in class com.sshtools.net.ForwardingClient

Configure the forwarding client to manage X11 connections.

associateCommand(SshPublicKey, String) - Method in class com.sshtools.publickey.PublicKeySubsystem

Associate a command with an accepted public key.

avail_in - Variable in class com.sshtools.zlib.ZStream

avail_out - Variable in class com.sshtools.zlib.ZStream

B

begin - Variable in class com.sshtools.net.HttpHeader

buf - Variable in class com.sshtools.zlib.ZInputStream

buf - Variable in class com.sshtools.zlib.ZOutputStream

buf1 - Variable in class com.sshtools.zlib.ZInputStream

buf1 - Variable in class com.sshtools.zlib.ZOutputStream

bufsize - Variable in class com.sshtools.zlib.ZInputStream

bufsize - Variable in class com.sshtools.zlib.ZOutputStream

C

cancelAllRemoteForwarding() - Method in class com.sshtools.net.ForwardingClient

Stop all remote forwarding

cancelAllRemoteForwarding(boolean) - Method in class com.sshtools.net.ForwardingClient

Stop all remote forwarding.

cancelRemoteForwarding(String, int) - Method in class com.sshtools.net.ForwardingClient

Requests that the remote side stop listening for socket connections.

cancelRemoteForwarding(String, int, boolean) - 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, or the user's default directory if null or any empty string is provided as the directory path.

cdup() - Method in class com.sshtools.sftp.SftpClient

Change the working directory to the parent directory

channelClosed(int, String, SshTunnel) - Method in interface com.sshtools.net.ForwardingClientListener

A forwarding channel has been closed.

channelFailure(int, String, String, int, boolean, Throwable) - Method in interface com.sshtools.net.ForwardingClientListener

A forwarding channel failed to open.

channelOpened(int, String, SshTunnel) - Method in interface com.sshtools.net.ForwardingClientListener

A forwarding channel has been opened.

chgrp(String, 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(String, String) - Method in class com.sshtools.sftp.SftpClient

Sets the user ID to owner for the file or directory.

close() - Method in class com.sshtools.net.SocketWrapper

close() - Method in class com.sshtools.zlib.ZInputStream

close() - Method in class com.sshtools.zlib.ZOutputStream

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.

com.sshtools.zlib - package com.sshtools.zlib

compress - Variable in class com.sshtools.zlib.ZInputStream

compress(byte[], int, int) - Method in class com.sshtools.zlib.ZLibCompression

compress - Variable in class com.sshtools.zlib.ZOutputStream

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.

connectViaProxy(String, int, String, int, String, String, String, Hashtable) - Static method in class com.sshtools.net.HttpProxyTransport

connectViaProxy(String, int, String, int, String, String, String) - Static method in class com.sshtools.net.HttpProxyTransportWrapper

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

ConsoleKnownHostsKeyVerification - Class in com.sshtools.publickey

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.

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 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

D

Deflate - Class in com.sshtools.zlib

deflate(int) - Method in class com.sshtools.zlib.ZStream

deflateEnd() - Method in class com.sshtools.zlib.ZStream

deflateInit(int) - Method in class com.sshtools.zlib.ZStream

deflateInit(int, int) - Method in class com.sshtools.zlib.ZStream

deflateParams(int, int) - Method in class com.sshtools.zlib.ZStream

deflateSetDictionary(byte[], int) - Method in class com.sshtools.zlib.ZStream

DirectoryOperation - Class in com.sshtools.sftp

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

duplicate() - Method in class com.sshtools.net.HttpProxyTransport

duplicate() - Method in class com.sshtools.net.HttpProxyTransportWrapper

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

end() - Method in class com.sshtools.zlib.ZOutputStream

EOL_CR - Static variable in class com.sshtools.sftp.SftpClient

Specifies that the remote server is using \r as its newline convention when used with SftpClient.setRemoteEOL(int)

EOL_CRLF - Static variable in class com.sshtools.sftp.SftpClient

Specifies that the remote server is using \r\n as its newline convention when used with SftpClient.setRemoteEOL(int)

EOL_LF - Static variable in class com.sshtools.sftp.SftpClient

Specifies that the remote server is using \n as its newline convention when used with SftpClient.setRemoteEOL(int)

exit() - Method in class com.sshtools.net.ForwardingClient

exit() - Method in class com.sshtools.scp.ScpClient

exit() - Method in class com.sshtools.sftp.SftpClient

Close the SFTP client.

F

finalize() - Method in class com.sshtools.sftp.SftpClient

finish() - Method in class com.sshtools.zlib.ZOutputStream

flush - Variable in class com.sshtools.zlib.ZInputStream

flush - Variable in class com.sshtools.zlib.ZOutputStream

flush() - Method in class com.sshtools.zlib.ZOutputStream

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.

ForwardingClient - Class in com.sshtools.net

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 in com.sshtools.net

This class represents an active tunnel.

ForwardingClientListener - Interface in com.sshtools.net

An event listener for receiving notification of forwarding events.

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, String, int) - Method in interface com.sshtools.net.ForwardingClientListener

The forwarding identifed by the key has been stopped.

free() - Method in class com.sshtools.zlib.ZStream

G

GENERAL_FAILURE - Static variable in exception com.sshtools.publickey.PublicKeySubsystemException

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, FileTransferProgress) - Method in class com.sshtools.scp.ScpClient

get(String, String, boolean) - Method in class com.sshtools.scp.ScpClient

Downloads a remote file onto the local computer.

get(String, String, boolean, FileTransferProgress) - Method in class com.sshtools.scp.ScpClient

get(String, FileTransferProgress) - Method in class com.sshtools.sftp.SftpClient

Download the remote file to the local computer.

get(String, FileTransferProgress, boolean) - Method in class com.sshtools.sftp.SftpClient

Download the remote file to the local computer.

get(String, boolean) - 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, FileTransferProgress, boolean) - Method in class com.sshtools.sftp.SftpClient

Download the remote file to the local computer.

get(String, String, boolean) - Method in class com.sshtools.sftp.SftpClient

Download the remote file into the local file.

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, FileTransferProgress, long) - Method in class com.sshtools.sftp.SftpClient

Download the remote file writing it to the specified OutputStream.

get(String, OutputStream, long) - Method in class com.sshtools.sftp.SftpClient

Download the remote file into an OutputStream.

get(String, OutputStream) - Method in class com.sshtools.sftp.SftpClient

Download the remote file into an OutputStream.

getAbsolutePath(String) - Method in class com.sshtools.sftp.SftpClient

Get the absolute path for a file.

getAuthenticationMethod() - Method in class com.sshtools.net.HttpResponse

getAuthenticationRealm() - Method in class com.sshtools.net.HttpResponse

getDefaultDirectory() - Method in class com.sshtools.sftp.SftpClient

Get the default directory (or HOME 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.

getFailedTransfers() - Method in class com.sshtools.sftp.DirectoryOperation

Returns a Hashtable of files and exceptions.

getFileCount() - Method in class com.sshtools.sftp.DirectoryOperation

Get the total number of new and changed files to transfer

getFiles(String) - Method in class com.sshtools.sftp.SftpClient

Download the remote files to the local computer

getFiles(String, boolean) - Method in class com.sshtools.sftp.SftpClient

Download the remote files to the local computer

getFiles(String, FileTransferProgress) - Method in class com.sshtools.sftp.SftpClient

Download the remote files to the local computer.

getFiles(String, FileTransferProgress, boolean) - Method in class com.sshtools.sftp.SftpClient

Download the remote files to the local computer.

getFiles(String, String) - Method in class com.sshtools.sftp.SftpClient

Download the remote files into the local file.

getFiles(String, String, boolean) - Method in class com.sshtools.sftp.SftpClient

Download the remote files into the local file.

getFiles(String, String, FileTransferProgress, boolean) - Method in class com.sshtools.sftp.SftpClient

Download the remote file to the local computer.

getFlushMode() - Method in class com.sshtools.zlib.ZInputStream

getFlushMode() - Method in class com.sshtools.zlib.ZOutputStream

getHeaderField(String) - Method in class com.sshtools.net.HttpHeader

getHeaderFieldNames() - Method in class com.sshtools.net.HttpHeader

getHeaderFields() - Method in class com.sshtools.net.HttpHeader

getHost() - Method in class com.sshtools.net.HttpProxyTransport

getHost() - Method in class com.sshtools.net.HttpProxyTransportWrapper

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

getInputStream() - Method in class com.sshtools.net.SocketWrapper

getInputStream(String, long) - Method in class com.sshtools.sftp.SftpClient

Create an InputStream for reading a remote file.

getInputStream(String) - Method in class com.sshtools.sftp.SftpClient

Create an InputStream for reading a remote file.

getKnownHostsFile() - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification

getLocalForwardings() - Method in class com.sshtools.net.ForwardingClient

Return the currently active local forwarding listeners.

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.

getName() - Method in class com.sshtools.zlib.OpenSSHZLibCompression

getName() - Method in class com.sshtools.zlib.ZLibCompression

getNewFiles() - Method in class com.sshtools.sftp.DirectoryOperation

Returns a list of new files that will be transfered in the directory operation

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.

getPort() - Method in class com.sshtools.net.SocketWrapper

getReason() - Method in class com.sshtools.net.HttpResponse

getRemoteForwardings() - Method in class com.sshtools.net.ForwardingClient

Returns the currently active remote forwarding listeners.

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.

getSocket() - Method in class com.sshtools.net.SocketWrapper

getSoTimeout() - Method in class com.sshtools.net.SocketWrapper

getStartLine() - Method in class com.sshtools.net.HttpHeader

getStatus() - Method in class com.sshtools.net.HttpResponse

getStatus() - Method in exception com.sshtools.publickey.PublicKeySubsystemException

getSubsystemChannel() - Method in class com.sshtools.sftp.SftpClient

Returns the instance of the SftpSubsystemChannel used by this class

getTotalIn() - Method in class com.sshtools.zlib.ZInputStream

Returns the total number of bytes input so far.

getTotalIn() - Method in class com.sshtools.zlib.ZOutputStream

Returns the total number of bytes input so far.

getTotalOut() - Method in class com.sshtools.zlib.ZInputStream

Returns the total number of bytes output so far.

getTotalOut() - Method in class com.sshtools.zlib.ZOutputStream

Returns the total number of bytes output so far.

getTransferMode() - Method in class com.sshtools.sftp.SftpClient

getTransferSize() - Method in class com.sshtools.sftp.DirectoryOperation

Get the total number of bytes that this operation will transfer

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

getVersion() - Method in class com.sshtools.net.HttpResponse

getX11ForwardingTunnels() - Method in class com.sshtools.net.ForwardingClient

Get the active X11 forwarding channels.

GlobRegExpMatching - Class in com.sshtools.sftp

Implements the RegularExpressionMatching Interface.

GlobRegExpMatching() - Constructor for class com.sshtools.sftp.GlobRegExpMatching

GlobSyntax - Static variable in class com.sshtools.sftp.SftpClient

H

hasLocalForwarding(String, int) - Method in class com.sshtools.net.ForwardingClient

hasRemoteForwarding(String, int) - Method in class com.sshtools.net.ForwardingClient

HIGHEST_RANDOM_PORT - Variable in class com.sshtools.net.ForwardingClient

The highest possible random port to select *

HttpHeader - Class in com.sshtools.net

Utility class to process HTTP headers.

HttpHeader() - Constructor for class com.sshtools.net.HttpHeader

HttpProxyTransport - Class in com.sshtools.net

Provides an SshTransport implementation that can route the connection through a HTTP proxy.

HttpProxyTransportWrapper - Class in com.sshtools.net

Provides an SshTransport implementation that can route the connection through a HTTP proxy.

HttpRequest - Class in com.sshtools.net

Utility class to process HTTP requests.

HttpRequest() - Constructor for class com.sshtools.net.HttpRequest

HttpResponse - Class in com.sshtools.net

Utility class to process HTTP responses.

HttpResponse(InputStream) - Constructor for class com.sshtools.net.HttpResponse

I

inflate(int) - Method in class com.sshtools.zlib.ZStream

inflateEnd() - Method in class com.sshtools.zlib.ZStream

inflateInit() - Method in class com.sshtools.zlib.ZStream

inflateInit(int) - Method in class com.sshtools.zlib.ZStream

inflateSetDictionary(byte[], int) - Method in class com.sshtools.zlib.ZStream

inflateSync() - Method in class com.sshtools.zlib.ZStream

init(int, int) - Method in class com.sshtools.zlib.ZLibCompression

isClosed() - Method in class com.sshtools.sftp.SftpClient

Returns the state of the SFTP client.

isDirectoryOrLinkedDirectory(SftpFile) - Method in class com.sshtools.sftp.SftpClient

Determine whether the file object is pointing to a symbolic link that is pointing to a directory.

isHostFileWriteable() - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification

Determines whether the host file is writable.

isXForwarding() - Method in class com.sshtools.net.ForwardingClient

Is X forwarding currently active?

J

JZlib - Class in com.sshtools.zlib

JZlib() - Constructor for class com.sshtools.zlib.JZlib

K

KEY_NOT_FOUND - Static variable in exception com.sshtools.publickey.PublicKeySubsystemException

KEY_NOT_SUPPORTED - Static variable in exception com.sshtools.publickey.PublicKeySubsystemException

L

lcd(String) - Method in class com.sshtools.sftp.SftpClient

Changes the local working directory.

list() - Method in class com.sshtools.publickey.PublicKeySubsystem

List all of the users acceptable keys.

LOCAL_FORWARDING - Static variable in interface com.sshtools.net.ForwardingClientListener

Constant used to specify whether the event relates to a local forwarding

LOWEST_RANDOM_PORT - Variable in class com.sshtools.net.ForwardingClient

The lowest possible random port to select *

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

matchFileNamesWithPattern(File[], String) - Method in class com.sshtools.sftp.GlobRegExpMatching

compiles fileNameRegExp into a regular expression and pattern matches on each file's name, and returns those that match.

matchFileNamesWithPattern(File[], String) - Method in class com.sshtools.sftp.NoRegExpMatching

opens and returns the requested filename string

matchFileNamesWithPattern(File[], String) - Method in class com.sshtools.sftp.Perl5RegExpMatching

compiles fileNameRegExp into a regular expression and pattern matches on each file's name, and returns those that match.

matchFileNamesWithPattern(File[], String) - Method in interface com.sshtools.sftp.RegularExpressionMatching

returns each of the files that match the pattern fileNameRegExp

matchFilesWithPattern(SftpFile[], String) - Method in class com.sshtools.sftp.GlobRegExpMatching

compiles fileNameRegExp into a regular expression and pattern matches on each file's name, and returns those that match.

matchFilesWithPattern(SftpFile[], String) - Method in class com.sshtools.sftp.NoRegExpMatching

returns files

matchFilesWithPattern(SftpFile[], String) - Method in class com.sshtools.sftp.Perl5RegExpMatching

compiles fileNameRegExp into a regular expression and pattern matches on each file's name, and returns those that match.

matchFilesWithPattern(SftpFile[], String) - Method in interface com.sshtools.sftp.RegularExpressionMatching

returns each of the SftpFiles that match the pattern fileNameRegExp

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.

MODE_BINARY - Static variable in class com.sshtools.sftp.SftpClient

Instructs the client to use a binary transfer mode when used with SftpClient.setTransferMode(int)

MODE_TEXT - Static variable in class com.sshtools.sftp.SftpClient

Instructs the client to use a text transfer mode when used with SftpClient.setTransferMode(int).

msg - Variable in class com.sshtools.zlib.ZStream

N

next_in - Variable in class com.sshtools.zlib.ZStream

next_in_index - Variable in class com.sshtools.zlib.ZStream

next_out - Variable in class com.sshtools.zlib.ZStream

next_out_index - Variable in class com.sshtools.zlib.ZStream

NoRegExpMatching - Class in com.sshtools.sftp

Implements the RegularExpressionMatching Interface.
Performs no regular expression matching so:
matchFilesWithPattern() simply returns the files parameter it is passed as an argument
matchFileNamesWithPattern() simply returns a 1 element array containing the filename on the first element of the file[] argument passed to it.

NoRegExpMatching() - Constructor for class com.sshtools.sftp.NoRegExpMatching

NoSyntax - Static variable in class com.sshtools.sftp.SftpClient

constants for setting the regular expression syntax.

O

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.

onInvalidHostEntry(String) - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification

onInvalidHostEntry(String) - Method in class com.sshtools.publickey.ConsoleKnownHostsKeyVerification

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.

openFile(String) - Method in class com.sshtools.sftp.SftpClient

OpenSSHZLibCompression - Class in com.sshtools.zlib

OpenSSHZLibCompression() - Constructor for class com.sshtools.zlib.OpenSSHZLibCompression

P

Perl5RegExpMatching - Class in com.sshtools.sftp

Implements the RegularExpressionMatching Interface.

Perl5RegExpMatching() - Constructor for class com.sshtools.sftp.Perl5RegExpMatching

Perl5Syntax - Static variable in class com.sshtools.sftp.SftpClient

processHeaderFields(InputStream) - Method in class com.sshtools.net.HttpHeader

PublicKeySubsystem - Class in com.sshtools.publickey

This class implements version 1 of the public key subsystem.

PublicKeySubsystem(Ssh2Session) - Constructor for class com.sshtools.publickey.PublicKeySubsystem

PublicKeySubsystemException - Exception in com.sshtools.publickey

Exception thrown by the PublicKeySubsystem when errors occur in listing, adding or removing keys.

PublicKeySubsystemException(int, String) - Constructor for exception com.sshtools.publickey.PublicKeySubsystemException

put(String, String, boolean) - Method in class com.sshtools.scp.ScpClient

Uploads a local file onto the remote server.

put(String, String, boolean, FileTransferProgress) - Method in class com.sshtools.scp.ScpClient

pattern matches the files in the local directory using "local" as a glob Regular Expression.

put(String[], String, boolean) - Method in class com.sshtools.scp.ScpClient

Uploads an array of local files onto the remote server.

put(String[], String, boolean, FileTransferProgress) - Method in class com.sshtools.scp.ScpClient

Uploads an array of local files onto the remote server.

put(String, FileTransferProgress, boolean) - Method in class com.sshtools.sftp.SftpClient

Upload a file to the remote computer.

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, boolean) - 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, FileTransferProgress, boolean) - Method in class com.sshtools.sftp.SftpClient

Upload a file to the remote computer.

put(String, String, boolean) - 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, FileTransferProgress, long) - Method in class com.sshtools.sftp.SftpClient

put(InputStream, String, long) - Method in class com.sshtools.sftp.SftpClient

Upload the contents of an InputStream to the remote computer.

put(InputStream, String) - Method in class com.sshtools.sftp.SftpClient

Upload the contents of an InputStream to the remote computer.

putFile(String, String, boolean, FileTransferProgress, boolean) - Method in class com.sshtools.scp.ScpClient

putFiles(String) - Method in class com.sshtools.sftp.SftpClient

Upload the contents of an InputStream to the remote computer.

putFiles(String, boolean) - Method in class com.sshtools.sftp.SftpClient

Upload files to the remote computer

putFiles(String, FileTransferProgress) - Method in class com.sshtools.sftp.SftpClient

Upload files to the remote computer

putFiles(String, FileTransferProgress, boolean) - Method in class com.sshtools.sftp.SftpClient

Upload files to the remote computer

putFiles(String, String) - Method in class com.sshtools.sftp.SftpClient

Upload files to the remote computer

putFiles(String, String, boolean) - Method in class com.sshtools.sftp.SftpClient

Upload files to the remote computer

putFiles(String, String, FileTransferProgress) - Method in class com.sshtools.sftp.SftpClient

Upload files to the remote computer.

putFiles(String, String, FileTransferProgress, boolean) - Method in class com.sshtools.sftp.SftpClient

make local copies of some of the variables, then call putfilematches, which calls "put" on each file that matches the regexp local.

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

read() - Method in class com.sshtools.zlib.ZInputStream

read(byte[], int, int) - Method in class com.sshtools.zlib.ZInputStream

readLine(InputStream) - Method in class com.sshtools.net.HttpHeader

RegularExpressionMatching - Interface in com.sshtools.sftp

Interface for treating a filename as a regular expression and returning the list of files that match.

REMOTE_FORWARDING - Static variable in interface com.sshtools.net.ForwardingClientListener

Constant used to specify whether the event relates to a remote forwarding

remove(SshPublicKey) - Method in class com.sshtools.publickey.PublicKeySubsystem

Remove a public key from the users list of acceptable keys.

removeAllowedHost(String) - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification

Removes an allowed host.

removeCustomRoot(String) - Method in class com.sshtools.sftp.SftpClient

Remove a custom file system root path such as "flash:"

removeListener(ForwardingClientListener) - Method in class com.sshtools.net.ForwardingClient

Remove a ForwardingClientListener from the list receiving forwarding events.

rename(String, String) - Method in class com.sshtools.sftp.SftpClient

Rename a file on the remote computer.

REQUEST_NOT_SUPPPORTED - Static variable in exception com.sshtools.publickey.PublicKeySubsystemException

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.

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 existing files and recursion.

S

saveHostFile() - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification

Save's the host key file to be saved.

ScpClient - Class in com.sshtools.scp

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 in com.sshtools.scp

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.

selectRandomPort() - Method in class com.sshtools.net.ForwardingClient

Select a random port.

setBasicAuthentication(String, String) - Method in class com.sshtools.net.HttpRequest

setBlockSize(int) - Method in class com.sshtools.sftp.SftpClient

Sets the block size used when transferring 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.

setFlushMode(int) - Method in class com.sshtools.zlib.ZInputStream

setFlushMode(int) - Method in class com.sshtools.zlib.ZOutputStream

setHashHosts(boolean) - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification

setHeaderBegin(String) - Method in class com.sshtools.net.HttpRequest

setHeaderField(String, String) - Method in class com.sshtools.net.HttpHeader

setMaxAsyncRequests(int) - Method in class com.sshtools.sftp.SftpClient

Set the maximum number of asynchronous requests that are outstanding at any one time.

setRegularExpressionSyntax(int) - Method in class com.sshtools.sftp.SftpClient

sets the type of regular expression matching to perform on gets and puts

setRemoteEOL(int) - Method in class com.sshtools.sftp.SftpClient

When connected to servers running SFTP version 3 (or less) the remote EOL type needs to be explicitly set because there is no reliable way for the client to determine the type of EOL for text files.

setSoTimeout(int) - Method in class com.sshtools.net.SocketWrapper

setTransferMode(int) - Method in class com.sshtools.sftp.SftpClient

Sets the transfer mode for current operations.

SftpClient - Class in com.sshtools.sftp

Implements a Secure File Transfer (SFTP) client.

SftpClient(SshClient) - Constructor for class com.sshtools.sftp.SftpClient

SftpClient(SshSession) - Constructor for class com.sshtools.sftp.SftpClient

SftpClient(SshSession, int) - Constructor for class com.sshtools.sftp.SftpClient

SftpClient(SshClient, int) - Constructor for class com.sshtools.sftp.SftpClient

Constructs the SFTP client with a given channel event listener.

skip(long) - Method in class com.sshtools.zlib.ZInputStream

socket - Variable in class com.sshtools.net.SocketWrapper

SocketTransport - Class in com.sshtools.net

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 in com.sshtools.net

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

SOCKS4 - Static variable in class com.sshtools.net.SocksProxyTransport

SOCKS5 - Static variable in class com.sshtools.net.SocksProxyTransport

SocksProxyTransport - Class in com.sshtools.net

Provides an SshTransport implementation that can route the connection through a SOCKS 4 or SOCKS 5 proxy.

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.

startLocalForwardingOnRandomPort(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.

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 transferring data, closing the channel and the attached socket.

stopAllLocalForwarding() - Method in class com.sshtools.net.ForwardingClient

Stop all local forwarding

stopAllLocalForwarding(boolean) - 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.

stopLocalForwarding(String, int, boolean) - Method in class com.sshtools.net.ForwardingClient

Stops a local listening socket from accepting connections.

stopLocalForwarding(String, boolean) - Method in class com.sshtools.net.ForwardingClient

Stop a local listening socket from accepting connections.

STORAGE_EXCEEDED - Static variable in exception com.sshtools.publickey.PublicKeySubsystemException

symlink(String, String) - Method in class com.sshtools.sftp.SftpClient

Create a symbolic link on the remote computer.

T

toString() - Method in class com.sshtools.net.HttpHeader

toString() - Method in class com.sshtools.net.HttpProxyTransport

toString() - Method in class com.sshtools.net.HttpProxyTransportWrapper

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.

total_in - Variable in class com.sshtools.zlib.ZStream

total_out - Variable in class com.sshtools.zlib.ZStream

U

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.

uncompress(byte[], int, int) - Method in class com.sshtools.zlib.ZLibCompression

V

verifyHost(String, SshPublicKey) - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification

Verifies a host key against the list of known_hosts.

version() - Static method in class com.sshtools.zlib.JZlib

W

white_SPACE - Static variable in class com.sshtools.net.HttpHeader

write(int) - Method in class com.sshtools.zlib.ZOutputStream

write(byte[], int, int) - Method in class com.sshtools.zlib.ZOutputStream

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

Z

z - Variable in class com.sshtools.zlib.ZInputStream

z - Variable in class com.sshtools.zlib.ZOutputStream

Z_BEST_COMPRESSION - Static variable in class com.sshtools.zlib.JZlib

Z_BEST_SPEED - Static variable in class com.sshtools.zlib.JZlib

Z_BUF_ERROR - Static variable in class com.sshtools.zlib.JZlib

Z_DATA_ERROR - Static variable in class com.sshtools.zlib.JZlib

Z_DEFAULT_COMPRESSION - Static variable in class com.sshtools.zlib.JZlib

Z_DEFAULT_STRATEGY - Static variable in class com.sshtools.zlib.JZlib

Z_ERRNO - Static variable in class com.sshtools.zlib.JZlib

Z_FILTERED - Static variable in class com.sshtools.zlib.JZlib

Z_FINISH - Static variable in class com.sshtools.zlib.JZlib

Z_FULL_FLUSH - Static variable in class com.sshtools.zlib.JZlib

Z_HUFFMAN_ONLY - Static variable in class com.sshtools.zlib.JZlib

Z_MEM_ERROR - Static variable in class com.sshtools.zlib.JZlib

Z_NEED_DICT - Static variable in class com.sshtools.zlib.JZlib

Z_NO_COMPRESSION - Static variable in class com.sshtools.zlib.JZlib

Z_NO_FLUSH - Static variable in class com.sshtools.zlib.JZlib

Z_OK - Static variable in class com.sshtools.zlib.JZlib

Z_PARTIAL_FLUSH - Static variable in class com.sshtools.zlib.JZlib

Z_STREAM_END - Static variable in class com.sshtools.zlib.JZlib

Z_STREAM_ERROR - Static variable in class com.sshtools.zlib.JZlib

Z_SYNC_FLUSH - Static variable in class com.sshtools.zlib.JZlib

Z_VERSION_ERROR - Static variable in class com.sshtools.zlib.JZlib

ZInputStream - Class in com.sshtools.zlib

ZInputStream(InputStream) - Constructor for class com.sshtools.zlib.ZInputStream

ZInputStream(InputStream, int) - Constructor for class com.sshtools.zlib.ZInputStream

ZLibCompression - Class in com.sshtools.zlib

ZLibCompression() - Constructor for class com.sshtools.zlib.ZLibCompression

ZOutputStream - Class in com.sshtools.zlib

ZOutputStream(OutputStream) - Constructor for class com.sshtools.zlib.ZOutputStream

ZOutputStream(OutputStream, int) - Constructor for class com.sshtools.zlib.ZOutputStream

ZStream - Class in com.sshtools.zlib

ZStream() - Constructor for class com.sshtools.zlib.ZStream

ZStreamException - Exception in com.sshtools.zlib

ZStreamException() - Constructor for exception com.sshtools.zlib.ZStreamException

ZStreamException(String) - Constructor for exception com.sshtools.zlib.ZStreamException

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