Index (Maverick Extensions 2.0.0-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV NEXT

FRAMES NO FRAMES

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.
AbstractSftpClient - Class in com.sshtools.sftp: Implements a Secure File Transfer (SFTP) client.
AbstractSftpClient(SshClient, int) - Constructor for class com.sshtools.sftp.AbstractSftpClient
ACCESS_DENIED - Static variable in exception com.sshtools.publickey.PublicKeySubsystemException
ACL - Class in com.sshtools.sftp: Version 4 of the SFTP protocol introduces an ACL field in the SftpFileAttributes structure.
ACL(int, int, int, String) - Constructor for class com.sshtools.sftp.ACL
ACL_ALARM_TYPE - Static variable in class com.sshtools.sftp.ACL
ACL_ALLOWED_TYPE - Static variable in class com.sshtools.sftp.ACL
ACL_AUDIT_TYPE - Static variable in class com.sshtools.sftp.ACL
ACL_DENIED_TYPE - Static variable in class com.sshtools.sftp.ACL
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.AbstractSftpClient
addCustomRoot(String) - Method in interface 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

Base64EncodedFileFormat - Class in com.sshtools.publickey
Base64EncodedFileFormat(String, String) - Constructor for class com.sshtools.publickey.Base64EncodedFileFormat
begin - Variable in class com.sshtools.net.HttpHeader
begin - Variable in class com.sshtools.publickey.Base64EncodedFileFormat
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
buffer - Variable in class com.sshtools.scp.ScpClientIO.ScpEngineIO
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.
canRead() - Method in class com.sshtools.sftp.SftpFile: Determine whether the user has read access to the file.
canWrite() - Method in class com.sshtools.sftp.SftpFile: Determine whether the user has write access to the file.
cd(String) - Method in class com.sshtools.sftp.AbstractSftpClient
cd(String) - Method in interface com.sshtools.sftp.SftpClient: Changes the working directory on the remote server, or the home directory if null or any empty string is provided as the directory path
cdup() - Method in class com.sshtools.sftp.AbstractSftpClient
cdup() - Method in interface com.sshtools.sftp.SftpClient: Change the working directory to the parent directory
changeGroup(String, String) - Method in class com.sshtools.sftp.AbstractSftpClient
changeGroup(String, String) - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
changeGroup(String, String) - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
changeOwner(String, String) - Method in class com.sshtools.sftp.AbstractSftpClient
changeOwner(String, String) - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
changeOwner(String, String) - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
changePassphrase(String, String) - Method in interface com.sshtools.publickey.SshPrivateKeyFile: Change the passphrase of the key file.
changePermissions(String, int) - Method in class com.sshtools.sftp.AbstractSftpClient
changePermissions(String, int) - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
changePermissions(String, int) - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
changePermissions(SftpFile, int) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Change the permissions of a file.
changePermissions(String, int) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Change the permissions of a file.
changePermissions(String, String) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Change the permissions of a file.
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.AbstractSftpClient
chgrp(String, String) - Method in interface com.sshtools.sftp.SftpClient: Sets the group ID for the file or directory.
chmod(int, String) - Method in class com.sshtools.sftp.AbstractSftpClient
chmod(int, String) - Method in interface 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.AbstractSftpClient
chown(String, String) - Method in interface 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.scp.ScpClientIO.ScpEngineIO: Close the SCP engine and underlying session.
close() - Method in class com.sshtools.sftp.AbstractSftpClient
close() - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
close() - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
close() - Method in class com.sshtools.zlib.ZInputStream
close() - Method in class com.sshtools.zlib.ZOutputStream
closeFile(SftpFile) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Close a file or directory.
cmd - Variable in class com.sshtools.scp.ScpClientIO.ScpEngineIO
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.sftp.fallback - package com.sshtools.sftp.fallback
com.sshtools.sftp.subsystem - package com.sshtools.sftp.subsystem
com.sshtools.zlib - package com.sshtools.zlib
completed() - Method in interface com.sshtools.sftp.FileTransferProgress: The transfer has completed.
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
convertFile(File, String, String, int, File) - Static method in class com.sshtools.publickey.SshPrivateKeyFileFactory: Take a file in any of the supported public key formats and convert to the requested format.
convertFile(File, int, File) - Static method in class com.sshtools.publickey.SshPublicKeyFileFactory: Take a file in any of the supported public key formats and convert to the requested format.
copyLocalDirectory(String, String, boolean, boolean, boolean, FileTransferProgress) - Method in class com.sshtools.sftp.AbstractSftpClient
copyLocalDirectory(String, String, boolean, boolean, boolean, FileTransferProgress) - Method in interface 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.AbstractSftpClient
copyRemoteDirectory(String, String, boolean, boolean, boolean, FileTransferProgress) - Method in interface com.sshtools.sftp.SftpClient: Copy the contents of a remote directory to a local directory
create(SshKeyPair, String, String, int) - Static method in class com.sshtools.publickey.SshPrivateKeyFileFactory
create(SshPublicKey, String, String, int) - Static method in class com.sshtools.publickey.SshPublicKeyFileFactory: Create a file representation from an existing public key.
createChannel() - Method in class com.sshtools.scp.ScpClient.ScpEngine
createChannel() - Method in class com.sshtools.scp.ScpClientIO
createFile(SshKeyPair, String, String, int, File) - Static method in class com.sshtools.publickey.SshPrivateKeyFileFactory: Take a SshPrivateKey and write it to a file.
createFile(SshPublicKey, String, String, int, File) - Static method in class com.sshtools.publickey.SshPublicKeyFileFactory: Take a SshPublicKey and write it to a file
createSftpClient(SshClient) - Method in class com.sshtools.sftp.SftpClientFactory
createSftpClient(SshClient, int) - Method in class com.sshtools.sftp.SftpClientFactory
createSftpClient(SshClient, int, int) - Method in class com.sshtools.sftp.SftpClientFactory
createSymbolicLink(String, String) - Method in class com.sshtools.sftp.AbstractSftpClient
createSymbolicLink(String, String) - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
createSymbolicLink(String, String) - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
createSymbolicLink(String, String) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Create a symbolic link.

D

decodeSSH2PublicKey(byte[]) - Static method in class com.sshtools.publickey.SshPublicKeyFileFactory: Decode an SSH2 encoded public key as specified in the SSH2 transport protocol.
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
delete() - Method in class com.sshtools.sftp.SftpFile: Delete this file/directory from the remote server.
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 - Variable in class com.sshtools.publickey.Base64EncodedFileFormat
end() - Method in class com.sshtools.zlib.ZOutputStream
EOL_CR - Static variable in interface 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 interface 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 interface com.sshtools.sftp.SftpClient: Specifies that the remote server is using \n as its newline convention when used with SftpClient.setRemoteEOL(int)
equals(Object) - Method in class com.sshtools.sftp.SftpFile: Compares the Object to this instance and returns true if they point to the same file.
exit() - Method in class com.sshtools.net.ForwardingClient
exit() - Method in class com.sshtools.scp.ScpClient
exit() - Method in class com.sshtools.sftp.AbstractSftpClient
exit() - Method in interface com.sshtools.sftp.SftpClient: Close the SFTP client.

F

FileTransferProgress - Interface in com.sshtools.sftp: Interface for monitoring the state of a file transfer
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
formatKey(byte[]) - Method in class com.sshtools.publickey.Base64EncodedFileFormat
formatLongname(SftpFile) - Static method in class com.sshtools.sftp.AbstractSftpClient: Format a String with the details of the file.
formatLongname(SftpFileAttributes, String) - Static method in class com.sshtools.sftp.AbstractSftpClient: 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
generateKeyPair(String, int) - Static method in class com.sshtools.publickey.SshKeyPairGenerator: Generates a new key pair.
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) - Method in class com.sshtools.scp.ScpClientIO: Gets a remote file as a java.io.InputStream.
get(String, FileTransferProgress) - Method in class com.sshtools.scp.ScpClientIO: Gets a remote file as a java.io.InputStream.
get(String, FileTransferProgress) - Method in class com.sshtools.sftp.AbstractSftpClient
get(String, FileTransferProgress, boolean) - Method in class com.sshtools.sftp.AbstractSftpClient
get(String, boolean) - Method in class com.sshtools.sftp.AbstractSftpClient
get(String) - Method in class com.sshtools.sftp.AbstractSftpClient
get(String, String, FileTransferProgress) - Method in class com.sshtools.sftp.AbstractSftpClient
get(String, String, FileTransferProgress, boolean) - Method in class com.sshtools.sftp.AbstractSftpClient
get(String, OutputStream, FileTransferProgress, long) - Method in class com.sshtools.sftp.AbstractSftpClient
get(String, String, boolean) - Method in class com.sshtools.sftp.AbstractSftpClient
get(String, String) - Method in class com.sshtools.sftp.AbstractSftpClient
get(String, OutputStream, FileTransferProgress) - Method in class com.sshtools.sftp.AbstractSftpClient
get(String, OutputStream, long) - Method in class com.sshtools.sftp.AbstractSftpClient
get(String, OutputStream) - Method in class com.sshtools.sftp.AbstractSftpClient
get(String, FileTransferProgress) - Method in interface com.sshtools.sftp.SftpClient: Download the remote file to the local computer.
get(String, FileTransferProgress, boolean) - Method in interface com.sshtools.sftp.SftpClient: Download the remote file to the local computer.
get(String, boolean) - Method in interface com.sshtools.sftp.SftpClient: Download the remote file to the local computer
get(String) - Method in interface com.sshtools.sftp.SftpClient: Download the remote file to the local computer
get(String, String, FileTransferProgress) - Method in interface com.sshtools.sftp.SftpClient: Download the remote file to the local computer.
get(String, String, FileTransferProgress, boolean) - Method in interface com.sshtools.sftp.SftpClient: Download the remote file to the local computer.
get(String, String, boolean) - Method in interface com.sshtools.sftp.SftpClient: Download the remote file into the local file.
get(String, String) - Method in interface com.sshtools.sftp.SftpClient: Download the remote file into the local file.
get(String, OutputStream, FileTransferProgress) - Method in interface com.sshtools.sftp.SftpClient: Download the remote file writing it to the specified OutputStream.
get(String, OutputStream, FileTransferProgress, long) - Method in interface com.sshtools.sftp.SftpClient: Download the remote file writing it to the specified OutputStream.
get(String, OutputStream, long) - Method in interface com.sshtools.sftp.SftpClient: Download the remote file into an OutputStream.
get(String, OutputStream) - Method in interface com.sshtools.sftp.SftpClient: Download the remote file into an OutputStream.
getAbsolutePath(String) - Method in class com.sshtools.sftp.AbstractSftpClient
getAbsolutePath(String) - Method in interface com.sshtools.sftp.SftpClient: Get the absolute path for a file.
getAbsolutePath() - Method in class com.sshtools.sftp.SftpFile: Get the absolute path
getAbsolutePath(SftpFile) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Get the absolute path of a file.
getAbsolutePath(String) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Get the absolute path of a file.
getAccessedDateTime() - Method in class com.sshtools.sftp.SftpFileAttributes: Returns the last accessed date/time as a Java Date object.
getAccessedTime() - Method in class com.sshtools.sftp.SftpFileAttributes: Get the last accessed time.
getAlgorithm() - Method in class com.sshtools.zlib.OpenSSHZLibCompression
getAlgorithm() - Method in class com.sshtools.zlib.ZLibCompression
getAttributeBits() - Method in class com.sshtools.sftp.SftpFileAttributes
getAttributes(String) - Method in class com.sshtools.sftp.AbstractSftpClient
getAttributes(String) - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
getAttributes() - Method in class com.sshtools.sftp.SftpFile: Get the files attributes.
getAttributes(String) - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
getAttributes(String) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Get the attributes of a file.
getAttributes(SftpFile) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Get the attributes of a file.
getAuthenticationMethod() - Method in class com.sshtools.net.HttpResponse
getAuthenticationRealm() - Method in class com.sshtools.net.HttpResponse
getCanonicalNewline() - Method in class com.sshtools.sftp.AbstractSftpClient
getCanonicalNewline() - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
getCanonicalNewline() - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
getCanonicalNewline() - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Returns the canonical newline convention in use when reading/writing text files.
getChannel() - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
getCharsetEncoding() - Method in class com.sshtools.sftp.AbstractSftpClient
getCharsetEncoding() - Method in interface com.sshtools.sftp.SftpClient
getCharsetEncoding() - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Get the current encoding being used for filename Strings.
getComment() - Method in class com.sshtools.publickey.OpenSSHPublicKeyFile
getComment() - Method in class com.sshtools.publickey.SECSHPublicKeyFile
getComment() - Method in class com.sshtools.publickey.Ssh1RsaPublicKeyFile
getComment() - Method in interface com.sshtools.publickey.SshPublicKeyFile: Get the comment applied to the key file.
getCreationDateTime() - Method in class com.sshtools.sftp.SftpFileAttributes: Returns the creation date/time as a Java Date object.
getCreationTime() - Method in class com.sshtools.sftp.SftpFileAttributes: Get the creation time of this file.
getDefaultDirectory() - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
getDefaultDirectory() - Method in interface com.sshtools.sftp.SftpClient: Get the default directory (or HOME directory)
getDefaultDirectory() - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
getDefaultDirectory() - Method in class com.sshtools.sftp.subsystem.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.
getExtension(String) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Get the data value of a supported SFTP extension.
getFailedTransfers() - Method in class com.sshtools.sftp.DirectoryOperation: Returns a Hashtable of files and exceptions.
getFile(String) - Method in class com.sshtools.sftp.AbstractSftpClient
getFile(String) - Method in interface com.sshtools.sftp.SftpClient
getFile(String) - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
getFile(String) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Utility method to obtain an SftpFile instance for a given path.
getFileCount() - Method in class com.sshtools.sftp.DirectoryOperation: Get the total number of new and changed files to transfer
getFilename() - Method in class com.sshtools.sftp.SftpFile: Get the filename.
getFiles(String, OutputStream, FileTransferProgress, long) - Method in class com.sshtools.sftp.AbstractSftpClient
getFiles(String, String, FileTransferProgress, boolean) - Method in class com.sshtools.sftp.AbstractSftpClient
getFiles(String) - Method in class com.sshtools.sftp.AbstractSftpClient
getFiles(String, boolean) - Method in class com.sshtools.sftp.AbstractSftpClient
getFiles(String, FileTransferProgress) - Method in class com.sshtools.sftp.AbstractSftpClient
getFiles(String, FileTransferProgress, boolean) - Method in class com.sshtools.sftp.AbstractSftpClient
getFiles(String, OutputStream) - Method in class com.sshtools.sftp.AbstractSftpClient
getFiles(String, OutputStream, FileTransferProgress) - Method in class com.sshtools.sftp.AbstractSftpClient
getFiles(String, OutputStream, long) - Method in class com.sshtools.sftp.AbstractSftpClient
getFiles(String, String) - Method in class com.sshtools.sftp.AbstractSftpClient
getFiles(String, String, boolean) - Method in class com.sshtools.sftp.AbstractSftpClient
getFiles(String, String, FileTransferProgress) - Method in class com.sshtools.sftp.AbstractSftpClient
getFiles(String, OutputStream, FileTransferProgress, long) - Method in interface com.sshtools.sftp.SftpClient: make local copies of some of the variables, then call getfilematches, which calls get on each file that matches the regexp remote.
getFiles(String, String, FileTransferProgress, boolean) - Method in interface com.sshtools.sftp.SftpClient: make local copies of some of the variables, then call getfilematches, which calls get on each file that matches the regexp remote.
getFiles(String) - Method in interface com.sshtools.sftp.SftpClient: Download the remote files to the local computer
getFiles(String, boolean) - Method in interface com.sshtools.sftp.SftpClient: Download the remote files to the local computer
getFiles(String, FileTransferProgress) - Method in interface com.sshtools.sftp.SftpClient: Download the remote files to the local computer.
getFiles(String, FileTransferProgress, boolean) - Method in interface com.sshtools.sftp.SftpClient: Download the remote files to the local computer.
getFiles(String, OutputStream) - Method in interface com.sshtools.sftp.SftpClient: Download the remote files into an OutputStream.
getFiles(String, OutputStream, FileTransferProgress) - Method in interface com.sshtools.sftp.SftpClient: Download the remote files writing it to the specified OutputStream.
getFiles(String, OutputStream, long) - Method in interface com.sshtools.sftp.SftpClient: Download the remote files into an OutputStream.
getFiles(String, String) - Method in interface com.sshtools.sftp.SftpClient: Download the remote files into the local file.
getFiles(String, String, boolean) - Method in interface com.sshtools.sftp.SftpClient: Download the remote files into the local file.
getFiles(String, String, FileTransferProgress) - Method in interface com.sshtools.sftp.SftpClient: Download the remote file to the local computer.
getFlags() - Method in class com.sshtools.sftp.ACL
getFlushMode() - Method in class com.sshtools.zlib.ZInputStream
getFlushMode() - Method in class com.sshtools.zlib.ZOutputStream
getFormattedKey() - Method in class com.sshtools.publickey.OpenSSHPublicKeyFile
getFormattedKey() - Method in class com.sshtools.publickey.SECSHPublicKeyFile
getFormattedKey() - Method in class com.sshtools.publickey.Ssh1RsaPublicKeyFile
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.sshtools.sftp.SftpFileAttributes: Get the GID of this file.
getHandle() - Method in class com.sshtools.sftp.SftpFile: Get the open file handle
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
getHeaderValue(String) - Method in class com.sshtools.publickey.Base64EncodedFileFormat
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) - Method in class com.sshtools.sftp.AbstractSftpClient
getInputStream(String, long) - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
getInputStream(String, long) - Method in interface com.sshtools.sftp.SftpClient: Create an InputStream for reading a remote file.
getInputStream(String) - Method in interface com.sshtools.sftp.SftpClient: Create an InputStream for reading a remote file.
getInputStream(String, long) - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
getInstance() - Static method in class com.sshtools.sftp.SftpClientFactory
getKeyBlob(byte[]) - Method in class com.sshtools.publickey.Base64EncodedFileFormat
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.
getMask() - Method in class com.sshtools.sftp.ACL
getMaskString() - Method in class com.sshtools.sftp.SftpFileAttributes: Return the UNIX style mode mask
getMessageId() - Method in class com.sshtools.sftp.subsystem.SftpMessage
getModifiedDateTime() - Method in class com.sshtools.sftp.SftpFileAttributes: Returns the modified date/time as a Java Date object.
getModifiedTime() - Method in class com.sshtools.sftp.SftpFileAttributes: Get the last modified time.
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.sshtools.sftp.subsystem.SftpSubsystemChannel: Verify that an OK status has been returned for a request id.
getOptions() - Method in class com.sshtools.publickey.OpenSSHPublicKeyFile
getOptions() - Method in class com.sshtools.publickey.SECSHPublicKeyFile
getOptions() - Method in class com.sshtools.publickey.Ssh1RsaPublicKeyFile
getOptions() - Method in interface com.sshtools.publickey.SshPublicKeyFile: Get the options string applied to the key file
getOutputStream() - Method in class com.sshtools.net.SocketWrapper
getOutputStream(String) - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
getOutputStream(String) - Method in interface com.sshtools.sftp.SftpClient: Create an OutputStream for writing to a remote file.
getOutputStream(String) - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
getPacketSize() - Method in class com.sshtools.scp.ScpClient: Get the packet size that will be used when creating the channel for transfer.
getParent() - Method in class com.sshtools.sftp.SftpFile: Get the parent of the current file.
getPermissions() - Method in class com.sshtools.sftp.SftpFileAttributes: Get the current permissions value.
getPermissionsString() - Method in class com.sshtools.sftp.SftpFileAttributes: Returns a formatted permissions string.
getPort() - Method in class com.sshtools.net.SocketWrapper
getRealPath(String) - Method in class com.sshtools.sftp.AbstractSftpClient
getRealPath(String) - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
getRealPath(String) - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
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.
getServerVersion() - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Version 4 of the SFTP protocol allows the server to return its maximum supported version instead of the actual version to be used.
getSFTPClient() - Method in class com.sshtools.sftp.SftpFile: Get the SFTP client that created this file object.
getSize() - Method in class com.sshtools.sftp.SftpFileAttributes: Get the size of the file.
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
getStatus() - Method in exception com.sshtools.sftp.SftpStatusException: Get the status
getSymbolicLinkTarget(String) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Get the target path of a symbolic link.
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.AbstractSftpClient
getTransferMode() - Method in interface com.sshtools.sftp.SftpClient
getTransferSize() - Method in class com.sshtools.sftp.DirectoryOperation: Get the total number of bytes that this operation will transfer
getType() - Method in interface com.sshtools.publickey.SshPrivateKeyFile: Get a description of the format type e.g.
getType() - Method in class com.sshtools.sftp.ACL
getType() - Method in class com.sshtools.sftp.SftpFileAttributes
getType() - Method in class com.sshtools.sftp.subsystem.SftpMessage
getUID() - Method in class com.sshtools.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
getVersion() - Method in class com.sshtools.net.HttpResponse
getVersion() - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
getVersion() - Method in interface com.sshtools.sftp.SftpClient
getVersion() - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
getVersion() - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: When called after the initialize method this will return the version in operation for this sftp session.
getWho() - Method in class com.sshtools.sftp.ACL
getWindowSpace() - Method in class com.sshtools.scp.ScpClient: Get the window space that will be used when creating the channel for transfer.
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 interface com.sshtools.sftp.SftpClient

H

hasAttributeBits() - Method in class com.sshtools.sftp.SftpFileAttributes
hasGID() - Method in class com.sshtools.sftp.SftpFileAttributes
hashCode() - Method in class com.sshtools.sftp.SftpFile
hasLocalForwarding(String, int) - Method in class com.sshtools.net.ForwardingClient
hasRemoteForwarding(String, int) - Method in class com.sshtools.net.ForwardingClient
hasSize() - Method in class com.sshtools.sftp.SftpFileAttributes
hasUID() - Method in class com.sshtools.sftp.SftpFileAttributes
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

in - Variable in class com.sshtools.scp.ScpClientIO.ScpEngineIO
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
initialize() - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Initializes the sftp subsystem and negotiates a version with the server.
INVALID_HANDLE - Static variable in exception com.sshtools.sftp.SftpStatusException: The file handle provided was invalid
INVALID_RESUME_STATE - Static variable in exception com.sshtools.sftp.SftpStatusException: The file cannot be resumed
INVALID_TEXT_MODE - Static variable in exception com.sshtools.sftp.SftpStatusException: The server reported a canonical newline convention not supported by this API
InvalidPassphraseException - Exception in com.sshtools.publickey: Thrown by an SshPrivateKeyFile when it detects that the passphrase supplied was invalid.
InvalidPassphraseException() - Constructor for exception com.sshtools.publickey.InvalidPassphraseException
InvalidPassphraseException(Exception) - Constructor for exception com.sshtools.publickey.InvalidPassphraseException
isBlock() - Method in class com.sshtools.sftp.SftpFile: Determine whether the file is pointing to a block special file.
isBlock() - Method in class com.sshtools.sftp.SftpFileAttributes: Determine whether these attributes refer to a block special file.
isCancelled() - Method in interface com.sshtools.sftp.FileTransferProgress: The transfer is cancelled.
isCharacter() - Method in class com.sshtools.sftp.SftpFile: Determine whether the file is pointing to a character mode device.
isCharacter() - Method in class com.sshtools.sftp.SftpFileAttributes: Determine whether these attributes refer to a character device.
isClosed() - Method in class com.sshtools.sftp.AbstractSftpClient
isClosed() - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
isClosed() - Method in interface com.sshtools.sftp.SftpClient: Returns the state of the SFTP client.
isClosed() - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
isDirectory() - Method in class com.sshtools.sftp.SftpFile: Determine whether the file object is pointing to a directory.
isDirectory() - Method in class com.sshtools.sftp.SftpFileAttributes: Determine whether these attributes refer to a directory
isDirectoryOrLinkedDirectory(SftpFile) - Method in class com.sshtools.sftp.AbstractSftpClient
isDirectoryOrLinkedDirectory(SftpFile) - Method in interface com.sshtools.sftp.SftpClient: Determine whether the file object is pointing to a symbolic link that is pointing to a directory.
isFifo() - Method in class com.sshtools.sftp.SftpFile: Determine whether the file is pointing to a pipe.
isFifo() - Method in class com.sshtools.sftp.SftpFileAttributes: Determine whether these attributes refer to a pipe.
isFile() - Method in class com.sshtools.sftp.SftpFile: Determine whether the file object is pointing to a file.
isFile() - Method in class com.sshtools.sftp.SftpFileAttributes: Determine whether these attributes refer to a file.
isFlagSet(long) - Method in class com.sshtools.sftp.SftpFileAttributes: Determine if a permissions flag is set.
isFormatted(byte[], String, String) - Static method in class com.sshtools.publickey.Base64EncodedFileFormat
isHostFileWriteable() - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification: Determines whether the host file is writable.
isLink() - Method in class com.sshtools.sftp.SftpFile: Determine whether the file object is a symbolic link.
isLink() - Method in class com.sshtools.sftp.SftpFileAttributes: Determine whether these attributes refer to a symbolic link.
isPassphraseProtected() - Method in interface com.sshtools.publickey.SshPrivateKeyFile: Determine if the private key file is protected by a passphrase.
isSocket() - Method in class com.sshtools.sftp.SftpFile: Determine whether the file is pointing to a socket.
isSocket() - Method in class com.sshtools.sftp.SftpFileAttributes: Determine whether these attributes refer to a socket.
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.AbstractSftpClient
lcd(String) - Method in interface com.sshtools.sftp.SftpClient: Changes the local working directory.
list() - Method in class com.sshtools.publickey.PublicKeySubsystem: List all of the users acceptable keys.
listChildren(SftpFile, Vector) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: List the children of a directory.
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.AbstractSftpClient
lpwd() - Method in interface com.sshtools.sftp.SftpClient: Returns the absolute path to the local working directory.
ls() - Method in class com.sshtools.sftp.AbstractSftpClient
ls(String) - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
ls() - Method in interface com.sshtools.sftp.SftpClient: List the contents of the current remote working directory.
ls(String) - Method in interface com.sshtools.sftp.SftpClient: List the contents remote directory.
ls(String) - Method in class com.sshtools.sftp.subsystem.SftpClientImpl

M

makeDirectory(String, SftpFileAttributes) - Method in class com.sshtools.sftp.AbstractSftpClient
makeDirectory(String, SftpFileAttributes) - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
makeDirectory(String, SftpFileAttributes) - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
makeDirectory(String) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Make a directory.
makeDirectory(String, SftpFileAttributes) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Make a directory.
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
MAX_SFTP_VERSION - Static variable in class com.sshtools.sftp.SftpClientFactory
MAX_VERSION - Static variable in class com.sshtools.sftp.subsystem.SftpSubsystemChannel
mkdir(String) - Method in class com.sshtools.sftp.AbstractSftpClient
mkdir(String) - Method in interface com.sshtools.sftp.SftpClient: Creates a new directory on the remote server.
mkdirs(String) - Method in class com.sshtools.sftp.AbstractSftpClient
mkdirs(String) - Method in interface com.sshtools.sftp.SftpClient: Create a directory or set of directories.
MODE_BINARY - Static variable in interface com.sshtools.sftp.SftpClient: Instructs the client to use a binary transfer mode when used with SftpClient.setTransferMode(int)
MODE_TEXT - Static variable in interface 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 interface 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.
onInit(int) - Method in class com.sshtools.sftp.AbstractSftpClient
onInit(int) - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
onInit(int) - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
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_APPEND - Static variable in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: File open flag, forces all writes to append data at the end of the file.
OPEN_CREATE - Static variable in class com.sshtools.sftp.subsystem.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.sshtools.sftp.subsystem.SftpSubsystemChannel: File open flag, causes an open request to fail if the named file already exists.
OPEN_READ - Static variable in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: File open flag, opens the file for reading.
OPEN_TEXT - Static variable in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: File open flag, causes the file to be opened in text mode.
OPEN_TRUNCATE - Static variable in class com.sshtools.sftp.subsystem.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.sshtools.sftp.subsystem.SftpSubsystemChannel: File open flag, opens the file for writing.
openDirectory(String) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Open a directory.
openFile(String, int) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Open a file.
openFile(String, int, SftpFileAttributes) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Open a file.
OPENSSH_FORMAT - Static variable in class com.sshtools.publickey.SshPrivateKeyFileFactory
OPENSSH_FORMAT - Static variable in class com.sshtools.publickey.SshPublicKeyFileFactory
OpenSSHPublicKeyFile - Class in com.sshtools.publickey
OpenSSHZLibCompression - Class in com.sshtools.zlib
OpenSSHZLibCompression() - Constructor for class com.sshtools.zlib.OpenSSHZLibCompression
out - Variable in class com.sshtools.scp.ScpClientIO.ScpEngineIO

P

parse(byte[]) - Static method in class com.sshtools.publickey.SshPrivateKeyFileFactory: Parse formatted data and return a suitable SshPrivateKeyFile implementation.
parse(InputStream) - Static method in class com.sshtools.publickey.SshPrivateKeyFileFactory: Parse an InputStream 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.sshtools.scp.ScpClientIO.ScpEngineIO: Parse an SCP command
performDownload(String, OutputStream, FileTransferProgress, long) - Method in class com.sshtools.sftp.AbstractSftpClient
performDownload(String, OutputStream, FileTransferProgress, long) - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
performDownload(String, OutputStream, FileTransferProgress, long) - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
performOptimizedRead(byte[], long, int, OutputStream, int, FileTransferProgress) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Performs an optimized read of a file through use of asynchronous messages.
performOptimizedRead(byte[], long, int, OutputStream, int, FileTransferProgress, long) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Performs an optimized read of a file through use of asynchronous messages.
performOptimizedWrite(byte[], int, int, InputStream, int, FileTransferProgress) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Performs an optimized write of a file through asynchronous messaging and through buffering the local file into memory.
performOptimizedWrite(byte[], int, int, InputStream, int, FileTransferProgress, long) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Performs an optimized write of a file through asynchronous messaging and through buffering the local file into memory.
performUpload(InputStream, String, FileTransferProgress, long) - Method in class com.sshtools.sftp.AbstractSftpClient
performUpload(InputStream, String, FileTransferProgress, long) - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
performUpload(InputStream, String, FileTransferProgress, long) - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
Perl5RegExpMatching - Class in com.sshtools.sftp: Implements the RegularExpressionMatching Interface.
Perl5RegExpMatching() - Constructor for class com.sshtools.sftp.Perl5RegExpMatching
Perl5Syntax - Static variable in interface com.sshtools.sftp.SftpClient
postReadRequest(byte[], long, int) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Post a read request to the server and return the request id; this is used to optimize file downloads.
postWriteRequest(byte[], long, byte[], int, int) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Send a write request for an open file but do not wait for the response from the server.
processHeaderFields(InputStream) - Method in class com.sshtools.net.HttpHeader
progressed(long) - Method in interface com.sshtools.sftp.FileTransferProgress: The transfer has progressed
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(InputStream, long, String, String) - Method in class com.sshtools.scp.ScpClientIO: Uploads a java.io.InputStream to a remote server as a file.
put(InputStream, long, String, String, FileTransferProgress) - Method in class com.sshtools.scp.ScpClientIO: Uploads a java.io.InputStream to a remote server as a file.
put(String, FileTransferProgress, boolean) - Method in class com.sshtools.sftp.AbstractSftpClient
put(String, FileTransferProgress) - Method in class com.sshtools.sftp.AbstractSftpClient
put(String) - Method in class com.sshtools.sftp.AbstractSftpClient
put(String, boolean) - Method in class com.sshtools.sftp.AbstractSftpClient
put(String, String, FileTransferProgress) - Method in class com.sshtools.sftp.AbstractSftpClient
put(String, String, FileTransferProgress, boolean) - Method in class com.sshtools.sftp.AbstractSftpClient
put(String, String, boolean) - Method in class com.sshtools.sftp.AbstractSftpClient
put(String, String) - Method in class com.sshtools.sftp.AbstractSftpClient
put(InputStream, String, FileTransferProgress) - Method in class com.sshtools.sftp.AbstractSftpClient
put(InputStream, String, FileTransferProgress, long) - Method in class com.sshtools.sftp.AbstractSftpClient
put(InputStream, String, long) - Method in class com.sshtools.sftp.AbstractSftpClient
put(InputStream, String) - Method in class com.sshtools.sftp.AbstractSftpClient
put(String, FileTransferProgress, boolean) - Method in interface com.sshtools.sftp.SftpClient: Upload a file to the remote computer.
put(String, FileTransferProgress) - Method in interface com.sshtools.sftp.SftpClient: Upload a file to the remote computer.
put(String) - Method in interface com.sshtools.sftp.SftpClient: Upload a file to the remote computer
put(String, boolean) - Method in interface com.sshtools.sftp.SftpClient: Upload a file to the remote computer
put(String, String, FileTransferProgress) - Method in interface com.sshtools.sftp.SftpClient: Upload a file to the remote computer.
put(String, String, FileTransferProgress, boolean) - Method in interface com.sshtools.sftp.SftpClient: Upload a file to the remote computer.
put(String, String, boolean) - Method in interface com.sshtools.sftp.SftpClient: Upload a file to the remote computer
put(String, String) - Method in interface com.sshtools.sftp.SftpClient: Upload a file to the remote computer
put(InputStream, String, FileTransferProgress) - Method in interface com.sshtools.sftp.SftpClient: Upload a file to the remote computer reading from the specified InputStream .
put(InputStream, String, FileTransferProgress, long) - Method in interface com.sshtools.sftp.SftpClient
put(InputStream, String, long) - Method in interface com.sshtools.sftp.SftpClient: Upload the contents of an InputStream to the remote computer.
put(InputStream, String) - Method in interface 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(InputStream, String) - Method in class com.sshtools.sftp.AbstractSftpClient
putFiles(InputStream, String, FileTransferProgress) - Method in class com.sshtools.sftp.AbstractSftpClient
putFiles(InputStream, String, FileTransferProgress, long) - Method in class com.sshtools.sftp.AbstractSftpClient
putFiles(InputStream, String, long) - Method in class com.sshtools.sftp.AbstractSftpClient
putFiles(String) - Method in class com.sshtools.sftp.AbstractSftpClient
putFiles(String, boolean) - Method in class com.sshtools.sftp.AbstractSftpClient
putFiles(String, FileTransferProgress) - Method in class com.sshtools.sftp.AbstractSftpClient
putFiles(String, FileTransferProgress, boolean) - Method in class com.sshtools.sftp.AbstractSftpClient
putFiles(String, String) - Method in class com.sshtools.sftp.AbstractSftpClient
putFiles(String, String, boolean) - Method in class com.sshtools.sftp.AbstractSftpClient
putFiles(String, String, FileTransferProgress) - Method in class com.sshtools.sftp.AbstractSftpClient
putFiles(String, String, FileTransferProgress, boolean) - Method in class com.sshtools.sftp.AbstractSftpClient
putFiles(InputStream, String) - Method in interface com.sshtools.sftp.SftpClient: Upload the contents of an InputStream to the remote computer.
putFiles(InputStream, String, FileTransferProgress) - Method in interface com.sshtools.sftp.SftpClient: Upload files to the remote computer reading from the specified InputStream .
putFiles(InputStream, String, FileTransferProgress, long) - Method in interface com.sshtools.sftp.SftpClient
putFiles(InputStream, String, long) - Method in interface com.sshtools.sftp.SftpClient: Upload the contents of an InputStream to the remote computer.
putFiles(String) - Method in interface com.sshtools.sftp.SftpClient: Upload the contents of an InputStream to the remote computer.
putFiles(String, boolean) - Method in interface com.sshtools.sftp.SftpClient: Upload files to the remote computer
putFiles(String, FileTransferProgress) - Method in interface com.sshtools.sftp.SftpClient: Upload files to the remote computer
putFiles(String, FileTransferProgress, boolean) - Method in interface com.sshtools.sftp.SftpClient: Upload files to the remote computer
putFiles(String, String) - Method in interface com.sshtools.sftp.SftpClient: Upload files to the remote computer
putFiles(String, String, boolean) - Method in interface com.sshtools.sftp.SftpClient: Upload files to the remote computer
putFiles(String, String, FileTransferProgress) - Method in interface com.sshtools.sftp.SftpClient: Upload files to the remote computer.
putFiles(String, String, FileTransferProgress, boolean) - Method in interface 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.AbstractSftpClient
pwd() - Method in interface com.sshtools.sftp.SftpClient: Returns the absolute path name of the current remote working directory.

Q

quit() - Method in class com.sshtools.sftp.AbstractSftpClient
quit() - Method in interface 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
readCompleteFile(OutputStream, long, FileTransferProgress) - Method in class com.sshtools.scp.ScpClientIO.ScpEngineIO
readFile(byte[], UnsignedInteger64, byte[], int, int) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Read a block of data from an open file.
readLine(InputStream) - Method in class com.sshtools.net.HttpHeader
readStreamFromRemote(String, FileTransferProgress) - Method in class com.sshtools.scp.ScpClientIO.ScpEngineIO: Open an InputStream.
readString() - Method in class com.sshtools.scp.ScpClientIO.ScpEngineIO: read the inputstream until come to an end of line character '\n', and return the bytes read as a string
recurseMakeDirectory(String) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Recurse through a hierarchy of directories creating them as necessary.
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.AbstractSftpClient
removeCustomRoot(String) - Method in interface com.sshtools.sftp.SftpClient: Remove a custom file system root path such as "flash:"
removeDirectory(String) - Method in class com.sshtools.sftp.AbstractSftpClient
removeDirectory(String) - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
removeDirectory(String) - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
removeDirectory(String) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Remove an empty directory.
removeFile(String) - Method in class com.sshtools.sftp.AbstractSftpClient
removeFile(String) - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
removeFile(String) - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
removeFile(String) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Remove a file.
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.AbstractSftpClient
rename(String, String) - Method in interface com.sshtools.sftp.SftpClient: Rename a file on the remote computer.
renameFile(String, String) - Method in class com.sshtools.sftp.AbstractSftpClient
renameFile(String, String) - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
renameFile(String, String) - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
renameFile(String, String) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Rename an existing file.
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.
resolveRemotePath(String) - Method in class com.sshtools.sftp.AbstractSftpClient: returns the canonical form of path, if path doesn't start with one of '/';cwd;a customRoot; or is a WindowsRoot then prepend cwd to path
rm(String) - Method in class com.sshtools.sftp.AbstractSftpClient
rm(String, boolean, boolean) - Method in class com.sshtools.sftp.AbstractSftpClient
rm(String) - Method in interface com.sshtools.sftp.SftpClient: Remove a file or directory from the remote computer.
rm(String, boolean, boolean) - Method in interface com.sshtools.sftp.SftpClient: Remove a file or directory on the remote computer with options to force deletion of existing files and recursion.

S

S_IFBLK - Static variable in class com.sshtools.sftp.SftpFileAttributes: Permissions flag: Identifies the file as a block special file
S_IFCHR - Static variable in class com.sshtools.sftp.SftpFileAttributes: Permissions flag: Identifies the file as a character device
S_IFDIR - Static variable in class com.sshtools.sftp.SftpFileAttributes: Permissions flag: Identifies the file as a directory
S_IFIFO - Static variable in class com.sshtools.sftp.SftpFileAttributes: Permissions flag: Identifies the file as a pipe
S_IFLNK - Static variable in class com.sshtools.sftp.SftpFileAttributes: Permissions flag: Identifies the file as a symbolic link
S_IFMT - Static variable in class com.sshtools.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.sshtools.sftp.SftpFileAttributes: Permissions flag: Identifies the file as a regular file
S_IFSOCK - Static variable in class com.sshtools.sftp.SftpFileAttributes: Permissions flag: Identifies the file as a socket
S_IRGRP - Static variable in class com.sshtools.sftp.SftpFileAttributes: Permissions flag: Permits a file's group to read the file.
S_IROTH - Static variable in class com.sshtools.sftp.SftpFileAttributes: Permissions flag: Permits others to read the file.
S_IRUSR - Static variable in class com.sshtools.sftp.SftpFileAttributes: Permissions flag: Permits the owner of a file to read the file.
S_ISGID - Static variable in class com.sshtools.sftp.SftpFileAttributes: Permissions flag: Bit to determine whether a file is executed as the group owner
S_ISUID - Static variable in class com.sshtools.sftp.SftpFileAttributes: Permissions flag: Bit to determine whether a file is executed as the owner
S_IWGRP - Static variable in class com.sshtools.sftp.SftpFileAttributes: Permissions flag: Permits a file's group to write to the file.
S_IWOTH - Static variable in class com.sshtools.sftp.SftpFileAttributes: Permissions flag: Permits others to write to the file.
S_IWUSR - Static variable in class com.sshtools.sftp.SftpFileAttributes: Permissions flag: Permits the owner of a file to write to the file.
S_IXGRP - Static variable in class com.sshtools.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.sshtools.sftp.SftpFileAttributes: Permissions flag: Permits others to execute the file or to search the file's directory.
S_IXUSR - Static variable in class com.sshtools.sftp.SftpFileAttributes: Permissions flag: Permits the owner of a file to execute the file or to search the file's directory.
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.
ScpClientIO - Class in com.sshtools.scp: Implements the IO of a Secure Copy (SCP) client.
ScpClientIO(SshClient) - Constructor for class com.sshtools.scp.ScpClientIO: Creates an SCP client.
ScpClientIO.ScpEngineIO - Class in com.sshtools.scp: Implements an SCP engine.
ScpClientIO.ScpEngineIO(String, SshSession) - Constructor for class com.sshtools.scp.ScpClientIO.ScpEngineIO: Contruct the channel with the specified scp command.
ScpFallbackImpl - Class in com.sshtools.sftp.fallback
ScpFallbackImpl(SshClient, int) - Constructor for class com.sshtools.sftp.fallback.ScpFallbackImpl
SECSH_FORMAT - Static variable in class com.sshtools.publickey.SshPublicKeyFileFactory
SECSHPublicKeyFile - Class in com.sshtools.publickey
selectRandomPort() - Method in class com.sshtools.net.ForwardingClient: Select a random port.
sendExtensionMessage(String, byte[]) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Send an extension message and return the response.
session - Variable in class com.sshtools.scp.ScpClientIO.ScpEngineIO
setAttributes(String, SftpFileAttributes) - Method in class com.sshtools.sftp.fallback.ScpFallbackImpl
setAttributes(String, SftpFileAttributes) - Method in interface com.sshtools.sftp.SftpClient: Updates a file's attributes.
setAttributes(String, SftpFileAttributes) - Method in class com.sshtools.sftp.subsystem.SftpClientImpl
setAttributes(String, SftpFileAttributes) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Sets the attributes of a file.
setAttributes(SftpFile, SftpFileAttributes) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Sets the attributes of a file.
setBasicAuthentication(String, String) - Method in class com.sshtools.net.HttpRequest
setCharsetEncoding(String) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Allows the default character encoding to be overriden for filename strings.
setComment(String) - Method in class com.sshtools.publickey.SECSHPublicKeyFile
setFlushMode(int) - Method in class com.sshtools.zlib.ZInputStream
setFlushMode(int) - Method in class com.sshtools.zlib.ZOutputStream
setGID(String) - Method in class com.sshtools.sftp.SftpFileAttributes: Set the GID of this file.
setHandle(byte[]) - Method in class com.sshtools.sftp.SftpFile: Set the open file handle
setHeaderBegin(String) - Method in class com.sshtools.net.HttpRequest
setHeaderField(String, String) - Method in class com.sshtools.net.HttpHeader
setHeaderValue(String, String) - Method in class com.sshtools.publickey.Base64EncodedFileFormat
setMaxSftpVersion(int) - Static method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Sets the maximum SFTP protocol version to use, this should be <=4.
setPacketSize(int) - Method in class com.sshtools.scp.ScpClient: Set the packet size that will be used when creating the channel for transfer.
setPermissions(UnsignedInteger32) - Method in class com.sshtools.sftp.SftpFileAttributes: Set the permissions of the file.
setPermissions(String) - Method in class com.sshtools.sftp.SftpFileAttributes: Set the permissions from a string in the format "rwxr-xr-x"
setPermissionsFromMaskString(String) - Method in class com.sshtools.sftp.SftpFileAttributes: Set permissions given a UNIX style mask, for example '0644'
setPermissionsFromUmaskString(String) - Method in class com.sshtools.sftp.SftpFileAttributes: Set the permissions given a UNIX style umask, for example '0022' will result in 0022 ^ 0777.
setRegularExpressionSyntax(int) - Method in class com.sshtools.sftp.AbstractSftpClient
setRegularExpressionSyntax(int) - Method in interface 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.AbstractSftpClient
setRemoteEOL(int) - Method in interface 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.
setSize(UnsignedInteger64) - Method in class com.sshtools.sftp.SftpFileAttributes: Set the size of the file.
setSoTimeout(int) - Method in class com.sshtools.net.SocketWrapper
setThisMaxSftpVersion(int) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Sets the maximum SFTP protocol version to use for this instance, this should be <=4.
setTimes(UnsignedInteger64, UnsignedInteger64) - Method in class com.sshtools.sftp.SftpFileAttributes: Set the last access and last modified times.
setTransferMode(int) - Method in class com.sshtools.sftp.AbstractSftpClient
setTransferMode(int) - Method in interface com.sshtools.sftp.SftpClient: Sets the transfer mode for current operations.
setUID(String) - Method in class com.sshtools.sftp.SftpFileAttributes: Set the UID of the owner.
setWindowSpace(int) - Method in class com.sshtools.scp.ScpClient: Set the window space that will be used when creating the channel for transfer.
SFTP_ALL_MODES - Static variable in class com.sshtools.sftp.SftpClientFactory
SFTP_OVER_SCP - Static variable in class com.sshtools.sftp.SftpClientFactory
SFTP_SUBSYSTEM - Static variable in class com.sshtools.sftp.SftpClientFactory
SftpClient - Interface in com.sshtools.sftp
SftpClientFactory - Class in com.sshtools.sftp
SftpClientFactory() - Constructor for class com.sshtools.sftp.SftpClientFactory
SftpClientImpl - Class in com.sshtools.sftp.subsystem
SftpClientImpl(SshClient, int) - Constructor for class com.sshtools.sftp.subsystem.SftpClientImpl
SftpFile - Class in com.sshtools.sftp: Represents an SFTP file object.
SftpFile(String, SftpFileAttributes, SftpClient) - Constructor for class com.sshtools.sftp.SftpFile: Creates a new SftpFile object.
SftpFileAttributes - Class in com.sshtools.sftp: 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(int, SftpClient) - Constructor for class com.sshtools.sftp.SftpFileAttributes: Creates a new FileAttributes object.
SftpFileAttributes(ByteArrayReader, SftpClient) - Constructor for class com.sshtools.sftp.SftpFileAttributes
SftpMessage - Class in com.sshtools.sftp.subsystem
SftpStatusException - Exception in com.sshtools.sftp: This exception is thrown by the SftpSubsystemChannel class whenever a status message is received that is not expected.
SftpStatusException(int, String) - Constructor for exception com.sshtools.sftp.SftpStatusException
SftpStatusException(int) - Constructor for exception com.sshtools.sftp.SftpStatusException
SftpSubsystemChannel - Class in com.sshtools.sftp.subsystem: This class implements the SFTP protocol which is executed as an SSH subsystem.
SftpSubsystemChannel(SshSession, SftpClient) - Constructor for class com.sshtools.sftp.subsystem.SftpSubsystemChannel
SftpSubsystemChannel(SshSession, SftpClient, int) - Constructor for class com.sshtools.sftp.subsystem.SftpSubsystemChannel
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.
ssh - Variable in class com.sshtools.scp.ScpClientIO
ssh - Variable in class com.sshtools.sftp.AbstractSftpClient
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
Ssh1RsaPublicKeyFile - Class in com.sshtools.publickey
Ssh1RsaPublicKeyFile(byte[]) - Constructor for class com.sshtools.publickey.Ssh1RsaPublicKeyFile
Ssh1RsaPublicKeyFile(SshPublicKey) - Constructor for class com.sshtools.publickey.Ssh1RsaPublicKeyFile
SSH2_DSA - Static variable in class com.sshtools.publickey.SshKeyPairGenerator
SSH2_RSA - Static variable in class com.sshtools.publickey.SshKeyPairGenerator
SSH_FILEXFER_ATTR_ACCESSTIME - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_ATTR_ACL - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_ATTR_BITS - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_ATTR_CREATETIME - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_ATTR_EXTENDED - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_ATTR_MODIFYTIME - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_ATTR_OWNERGROUP - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_ATTR_PERMISSIONS - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_ATTR_SIZE - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_ATTR_SUBSECOND_TIMES - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_ATTR_UIDGID - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_TYPE_BLOCK_DEVICE - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_TYPE_CHAR_DEVICE - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_TYPE_DIRECTORY - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_TYPE_FIFO - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_TYPE_REGULAR - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_TYPE_SOCKET - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_TYPE_SPECIAL - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_TYPE_SYMLINK - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FILEXFER_TYPE_UNKNOWN - Static variable in class com.sshtools.sftp.SftpFileAttributes
SSH_FX_BAD_MESSAGE - Static variable in exception com.sshtools.sftp.SftpStatusException: The client sent a bad protocol message
SSH_FX_CONNECTION_LOST - Static variable in exception com.sshtools.sftp.SftpStatusException: The file system connection was lost
SSH_FX_EOF - Static variable in exception com.sshtools.sftp.SftpStatusException: The file or listing is EOF
SSH_FX_FAILURE - Static variable in exception com.sshtools.sftp.SftpStatusException: Generic failure code
SSH_FX_FILE_ALREADY_EXISTS - Static variable in exception com.sshtools.sftp.SftpStatusException: The path already exists
SSH_FX_INVALID_HANDLE - Static variable in exception com.sshtools.sftp.SftpStatusException: The file handle provided was invalid
SSH_FX_NO_CONNECTION - Static variable in exception com.sshtools.sftp.SftpStatusException: There is no connection to the file system
SSH_FX_NO_MEDIA - Static variable in exception com.sshtools.sftp.SftpStatusException: There is no media available at the remote location
SSH_FX_NO_SUCH_FILE - Static variable in exception com.sshtools.sftp.SftpStatusException: No such file was found
SSH_FX_NO_SUCH_PATH - Static variable in exception com.sshtools.sftp.SftpStatusException: The path is invalid
SSH_FX_OK - Static variable in exception com.sshtools.sftp.SftpStatusException: Everything performed correctly
SSH_FX_OP_UNSUPPORTED - Static variable in exception com.sshtools.sftp.SftpStatusException: The operation requested is not supported
SSH_FX_PERMISSION_DENIED - Static variable in exception com.sshtools.sftp.SftpStatusException: The user does not have permission
SSH_FX_WRITE_PROTECT - Static variable in exception com.sshtools.sftp.SftpStatusException: Cannot write to remote location
SshKeyPairGenerator - Class in com.sshtools.publickey: Generate public/private key pairs.
SshKeyPairGenerator() - Constructor for class com.sshtools.publickey.SshKeyPairGenerator
SshPrivateKeyFile - Interface in com.sshtools.publickey: 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 in com.sshtools.publickey: Private key format factory used to decode private key files.
SshPrivateKeyFileFactory() - Constructor for class com.sshtools.publickey.SshPrivateKeyFileFactory
SshPublicKeyFile - Interface in com.sshtools.publickey: Interface which all public key formats must implement to provide decoding of the public key into a suitable format for the API.
SshPublicKeyFileFactory - Class in com.sshtools.publickey: Public key format factory used to decode different formats of public keys.
SshPublicKeyFileFactory() - Constructor for class com.sshtools.publickey.SshPublicKeyFileFactory
SSHTOOLS_FORMAT - Static variable in class com.sshtools.publickey.SshPrivateKeyFileFactory
started(long, String) - Method in interface com.sshtools.sftp.FileTransferProgress: The transfer has started
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.AbstractSftpClient
stat(String) - Method in interface 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
supportsExtension(String) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Does the server support an SFTP extension? This checks the extensions returned by the server during the SFTP version negotiation.
supportsPassphraseChange() - Method in interface com.sshtools.publickey.SshPrivateKeyFile: Method to determine whether the format supports changing of passphrases.
symlink(String, String) - Method in class com.sshtools.sftp.AbstractSftpClient
symlink(String, String) - Method in interface com.sshtools.sftp.SftpClient: Create a symbolic link on the remote computer.

T

toByteArray() - Method in class com.sshtools.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 class com.sshtools.publickey.OpenSSHPublicKeyFile
toPublicKey() - Method in class com.sshtools.publickey.SECSHPublicKeyFile
toPublicKey() - Method in class com.sshtools.publickey.Ssh1RsaPublicKeyFile
toPublicKey() - Method in interface com.sshtools.publickey.SshPublicKeyFile: Convert the key file into a usable SshPublicKey.
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.
toString() - Method in class com.sshtools.publickey.OpenSSHPublicKeyFile
toString() - Method in class com.sshtools.publickey.SECSHPublicKeyFile
toString() - Method in class com.sshtools.sftp.SftpFile
total_in - Variable in class com.sshtools.zlib.ZStream
total_out - Variable in class com.sshtools.zlib.ZStream
TransferCancelledException - Exception in com.sshtools.sftp: Exception thrown when a file transfer is cancelled.
TransferCancelledException() - Constructor for exception com.sshtools.sftp.TransferCancelledException: Creates a new TransferCancelledException object.

U

umask - Variable in class com.sshtools.sftp.AbstractSftpClient
umask(int) - Method in class com.sshtools.sftp.AbstractSftpClient
umask(String) - Method in class com.sshtools.sftp.AbstractSftpClient
umask(int) - Method in interface com.sshtools.sftp.SftpClient: Sets the umask used by this client.
umask(String) - Method in interface com.sshtools.sftp.SftpClient: Sets the umask for this client.
uncompress(byte[], int, int) - Method in class com.sshtools.zlib.ZLibCompression

V

verifyConnection() - Method in class com.sshtools.sftp.AbstractSftpClient
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

waitForResponse() - Method in class com.sshtools.scp.ScpClientIO.ScpEngineIO
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
writeCompleteFile(InputStream, long, FileTransferProgress) - Method in class com.sshtools.scp.ScpClientIO.ScpEngineIO
writeError(String) - Method in class com.sshtools.scp.ScpClientIO.ScpEngineIO
writeFile(byte[], UnsignedInteger64, byte[], int, int) - Method in class com.sshtools.sftp.subsystem.SftpSubsystemChannel: Write a block of data to an open file.
writeOk() - Method in class com.sshtools.scp.ScpClientIO.ScpEngineIO
writeStreamToRemote(InputStream, long, String, FileTransferProgress) - Method in class com.sshtools.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

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

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV NEXT

FRAMES NO FRAMES