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

AbstractDigest - Class in com.sshtools.ssh.components.jce
An abstract class that implements the Digest interface to provide support for JCE based digests.
AbstractDigest(String) - Constructor for class com.sshtools.ssh.components.jce.AbstractDigest
 
AbstractHmac - Class in com.sshtools.ssh.components.jce
An abstract class that implements the SshHmac interface to provide support for JCE based message authentication.
AbstractHmac(String, int) - Constructor for class com.sshtools.ssh.components.jce.AbstractHmac
 
AbstractHmac(String, int, int) - Constructor for class com.sshtools.ssh.components.jce.AbstractHmac
 
AbstractJCECipher - Class in com.sshtools.ssh.components.jce
An abstract base class for defining SSH ciphers which use a JCE provider instead of the internal Maverick Crypto provider.
AbstractJCECipher(String, String, int, String) - Constructor for class com.sshtools.ssh.components.jce.AbstractJCECipher
 
AbstractKeyExchange - Interface in com.sshtools.ssh.components.jce
 
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.
AbstractPublicKey - Interface in com.sshtools.ssh.components.jce
 
acceptLocalForwarding(SocketAddress, String, int) - Method in interface com.sshtools.net.ForwardingClientListener
Accept a remote forwarding based on the remote socket address?
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.
add(String, Class<?>) - Method in class com.sshtools.ssh.components.ComponentFactory
Add a new component type to the factory.
add(UnsignedInteger32, UnsignedInteger32) - Static method in class com.sshtools.util.UnsignedInteger32
Add two unsigned integers together.
add(UnsignedInteger32, int) - Static method in class com.sshtools.util.UnsignedInteger32
Add an int to an unsigned integer.
add(UnsignedInteger64, UnsignedInteger64) - Static method in class com.sshtools.util.UnsignedInteger64
Add an unsigned integer to another unsigned integer.
add(UnsignedInteger64, int) - Static method in class com.sshtools.util.UnsignedInteger64
Add an unsigned integer to an int.
addAttribute(String, Object) - Method in class com.sshtools.events.Event
Add an attribute to the event
addChannelEventListener(ChannelEventListener) - Method in interface com.sshtools.ssh.SshChannel
Provides an event listening mechanism.
addChannelEventListener(ChannelEventListener) - Method in class com.sshtools.ssh2.Ssh2Channel
 
addChannelFactory(ChannelFactory) - Method in class com.sshtools.ssh2.Ssh2Client
Installs a custom channel factory so that the client may respond to channel open requests.
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.
addEventListener(EventListener) - Static method in class com.sshtools.ssh.SshConnector
 
addEventListener(String, EventListener) - Static method in class com.sshtools.ssh.SshConnector
 
addListener(EventListener) - Method in interface com.sshtools.events.EventService
Add a MaverickListener to the list of objects that will be sent MaverickEvents.
addListener(String, EventListener) - Method in interface com.sshtools.events.EventService
Add a MaverickListener to the list of objects that will be sent MaverickEvents.
addListener(String, EventListener) - Method in class com.sshtools.events.EventServiceImplementation
Add a J2SSH Listener to the list of listeners that will be sent events
addListener(EventListener) - Method in class com.sshtools.events.EventServiceImplementation
 
addListener(ForwardingClientListener) - Method in class com.sshtools.net.ForwardingClient
Add a ForwardingClientListener to receive forwarding events.
addListener(TransportProtocolListener) - Method in class com.sshtools.ssh2.TransportProtocol
 
addListener(IOStreamConnector.IOStreamConnectorListener) - Method in class com.sshtools.util.IOStreamConnector
 
addRequestHandler(GlobalRequestHandler) - Method in class com.sshtools.ssh2.Ssh2Client
Installs a global request handler so that the client may respond to global requests.
addShutdownHook(Runnable) - Method in class com.sshtools.ssh.message.SshMessageRouter
 
ADMINISTRATIVIVELY_PROHIBITED - Static variable in exception com.sshtools.ssh.ChannelOpenException
The administrator does not permit this channel to be opened
AES128Cbc - Class in com.sshtools.ssh.components.jce
An implementation of the AES 128 bit cipher using a JCE provider.
AES128Cbc() - Constructor for class com.sshtools.ssh.components.jce.AES128Cbc
 
AES128Ctr - Class in com.sshtools.ssh.components.jce
 
AES128Ctr() - Constructor for class com.sshtools.ssh.components.jce.AES128Ctr
 
AES192Cbc - Class in com.sshtools.ssh.components.jce
An implementation of the AES 128 bit cipher using a JCE provider.
AES192Cbc() - Constructor for class com.sshtools.ssh.components.jce.AES192Cbc
 
AES192Ctr - Class in com.sshtools.ssh.components.jce
 
AES192Ctr() - Constructor for class com.sshtools.ssh.components.jce.AES192Ctr
 
AES256Cbc - Class in com.sshtools.ssh.components.jce
An implementation of the AES 128 bit cipher using a JCE provider.
AES256Cbc() - Constructor for class com.sshtools.ssh.components.jce.AES256Cbc
 
AES256Ctr - Class in com.sshtools.ssh.components.jce
 
AES256Ctr() - Constructor for class com.sshtools.ssh.components.jce.AES256Ctr
 
AGENT_ERROR - Static variable in exception com.sshtools.ssh.SshException
An error has occurred within the agent.
allocateChannel(SshAbstractChannel) - Method in class com.sshtools.ssh.message.SshMessageRouter
 
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.
ArcFour - Class in com.sshtools.ssh.components.jce
 
ArcFour() - Constructor for class com.sshtools.ssh.components.jce.ArcFour
 
ArcFour128 - Class in com.sshtools.ssh.components.jce
 
ArcFour128() - Constructor for class com.sshtools.ssh.components.jce.ArcFour128
 
ArcFour256 - Class in com.sshtools.ssh.components.jce
 
ArcFour256() - Constructor for class com.sshtools.ssh.components.jce.ArcFour256
 
array() - Method in class com.sshtools.util.ByteArrayReader
Provides access to the underlying array
array() - Method in class com.sshtools.util.ByteArrayWriter
Get the underlying byte array
Arrayequals(byte[], byte[]) - Static method in class com.sshtools.ssh2.TransportProtocol
 
Arrays - Class in com.sshtools.util
 
Arrays() - Constructor for class com.sshtools.util.Arrays
 
assertByte(int) - Method in class com.sshtools.util.SimpleASNReader
 
associateCommand(SshPublicKey, String) - Method in class com.sshtools.publickey.PublicKeySubsystem
Associate a command with an accepted public key.
ATTRIBUTE_AUTHENTICATION_METHODS - Static variable in class com.sshtools.events.J2SSHEventCodes
 
ATTRIBUTE_COMMAND - Static variable in class com.sshtools.events.J2SSHEventCodes
 
ATTRIBUTE_DIRECTORY_PATH - Static variable in class com.sshtools.events.J2SSHEventCodes
 
ATTRIBUTE_FILE_NAME - Static variable in class com.sshtools.events.J2SSHEventCodes
 
ATTRIBUTE_FILE_NEW_NAME - Static variable in class com.sshtools.events.J2SSHEventCodes
 
ATTRIBUTE_FORWARDING_TUNNEL_ENTRANCE - Static variable in class com.sshtools.events.J2SSHEventCodes
 
ATTRIBUTE_FORWARDING_TUNNEL_EXIT - Static variable in class com.sshtools.events.J2SSHEventCodes
 
ATTRIBUTE_HOST_KEY - Static variable in class com.sshtools.events.J2SSHEventCodes
 
ATTRIBUTE_IP - Static variable in class com.sshtools.events.J2SSHEventCodes
 
ATTRIBUTE_LOCAL_CIPHERS_CS - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_LOCAL_CIPHERS_SC - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_LOCAL_COMPONENT_LIST - Static variable in class com.sshtools.events.J2SSHEventCodes
 
ATTRIBUTE_LOCAL_CS_COMPRESSIONS - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_LOCAL_CS_MACS - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_LOCAL_KEY_EXCHANGES - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_LOCAL_PUBLICKEYS - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_LOCAL_SC_COMPRESSIONS - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_LOCAL_SC_MACS - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_LOG_MESSAGE - Static variable in class com.sshtools.events.J2SSHEventCodes
This attribute is the key for the log message previously passes to log.info()/log.debug() calls
ATTRIBUTE_NUMBER_OF_CONNECTIONS - Static variable in class com.sshtools.events.J2SSHEventCodes
 
ATTRIBUTE_REMOTE_CIPHERS_CS - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_REMOTE_CIPHERS_SC - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_REMOTE_COMPONENT_LIST - Static variable in class com.sshtools.events.J2SSHEventCodes
 
ATTRIBUTE_REMOTE_CS_COMPRESSIONS - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_REMOTE_CS_MACS - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_REMOTE_KEY_EXCHANGES - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_REMOTE_PUBLICKEYS - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_REMOTE_SC_COMPRESSIONS - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_REMOTE_SC_MACS - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_THROWABLE - Static variable in class com.sshtools.events.J2SSHEventCodes
This attribute is the key for the throwable object previously passed in some log.info() calls.
ATTRIBUTE_USING_CS_CIPHER - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_USING_CS_COMPRESSION - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_USING_CS_MAC - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_USING_KEY_EXCHANGE - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_USING_PUBLICKEY - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_USING_SC_CIPHER - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_USING_SC_COMPRESSION - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
ATTRIBUTE_USING_SC_MAC - Static variable in class com.sshtools.events.J2SSHEventCodes
algorithm negotiation preferences
AUTH_CANCELLED_BY_USER - Static variable in class com.sshtools.ssh2.TransportProtocol
Disconnect reason: Authentication was cancelled
authenticate(SshAuthentication) - Method in interface com.sshtools.ssh.SshClient
Authenticate the user.
authenticate(AuthenticationProtocol, String) - Method in interface com.sshtools.ssh2.AuthenticationClient
Perform the authentication according to the specification.
authenticate(AuthenticationClient, String) - Method in class com.sshtools.ssh2.AuthenticationProtocol
Authenticate using the mechanism provided.
authenticate(AuthenticationProtocol, String) - Method in class com.sshtools.ssh2.KBIAuthentication
 
authenticate(SshAuthentication) - Method in class com.sshtools.ssh2.Ssh2Client
 
authenticate(AuthenticationProtocol, String) - Method in class com.sshtools.ssh2.Ssh2HostbasedAuthentication
 
authenticate(AuthenticationProtocol, String) - Method in class com.sshtools.ssh2.Ssh2PasswordAuthentication
Implementation of the authentication method.
authenticate(AuthenticationProtocol, String) - Method in class com.sshtools.ssh2.Ssh2PublicKeyAuthentication
 
AuthenticationClient - Interface in com.sshtools.ssh2
Base interface for all SSH authentication mechanisms.
AuthenticationProtocol - Class in com.sshtools.ssh2
Main implementation of the SSH Authentication Protocol.
AuthenticationProtocol(TransportProtocol) - Constructor for class com.sshtools.ssh2.AuthenticationProtocol
Construct the protocol using the given transport
AuthenticationResult - Class in com.sshtools.ssh2
Throwable class used by the AuthenticationProtocol to indicate that a authentication request has either been completed, failed or cancelled.
AuthenticationResult(int) - Constructor for class com.sshtools.ssh2.AuthenticationResult
Construct an AuthenticationResult
AuthenticationResult(int, String) - Constructor for class com.sshtools.ssh2.AuthenticationResult
Construct an AuthenticationResult
available() - Method in class com.sshtools.sftp.SftpFileInputStream
 
available() - Method in class com.sshtools.util.DynamicBuffer
Return the number of bytes of data available to be read from the buffer

B

BAD_API_USAGE - Static variable in exception com.sshtools.ssh.SshException
The API has encountered an error because of incorrect usage.
BannerDisplay - Interface in com.sshtools.ssh2
Callback interface to display authentication banner messages.
Base64 - Class in com.sshtools.util
 
Base64.InputStream - Class in com.sshtools.util
 
Base64.InputStream(InputStream) - Constructor for class com.sshtools.util.Base64.InputStream
 
Base64.InputStream(InputStream, boolean) - Constructor for class com.sshtools.util.Base64.InputStream
 
Base64.OutputStream - Class in com.sshtools.util
 
Base64.OutputStream(OutputStream) - Constructor for class com.sshtools.util.Base64.OutputStream
 
Base64.OutputStream(OutputStream, boolean) - Constructor for class com.sshtools.util.Base64.OutputStream
 
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
 
bigIntValue() - Method in class com.sshtools.util.UnsignedInteger64
Return a BigInteger value of the unsigned integer.
BlowfishCbc - Class in com.sshtools.ssh.components.jce
An implementation of the Blowfish cipher using a JCE provider.
BlowfishCbc() - Constructor for class com.sshtools.ssh.components.jce.BlowfishCbc
 
buf - Variable in class com.sshtools.util.DynamicBuffer
The buffer
buffer - Variable in class com.sshtools.scp.ScpClientIO.ScpEngineIO
 
BUFFER_SIZE - Static variable in class com.sshtools.util.IOUtil
Default buffer size for stream utility methods
BY_APPLICATION - Static variable in class com.sshtools.ssh2.TransportProtocol
Disconnect reason: The application disconnected
ByteArrayReader - Class in com.sshtools.util
Utiltiy class to read common parameter types from a byte array.
ByteArrayReader(byte[], int, int) - Constructor for class com.sshtools.util.ByteArrayReader
Construct a reader.
ByteArrayReader(byte[]) - Constructor for class com.sshtools.util.ByteArrayReader
 
ByteArrayWriter - Class in com.sshtools.util
Utility class to write common parameter types to a byte array.
ByteArrayWriter() - Constructor for class com.sshtools.util.ByteArrayWriter
Contruct an empty writer.
ByteArrayWriter(int) - Constructor for class com.sshtools.util.ByteArrayWriter
Construct a writer with an array size of the length supplied.

C

calculateExchangeHash() - Method in class com.sshtools.ssh.components.jce.DiffieHellmanGroup14Sha1
Calculates the exchange hash as an SHA1 hash of the following data.
calculateExchangeHash() - Method in class com.sshtools.ssh.components.jce.DiffieHellmanGroup1Sha1
Calculates the exchange hash as an SHA1 hash of the following data.
calculateExchangeHash(boolean, int) - Method in class com.sshtools.ssh.components.jce.DiffieHellmanGroupExchangeSha1
Calculates the exchange hash as an SHA1 hash of the following data.
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.
CANCELLED - Static variable in interface com.sshtools.ssh.SshAuthentication
The authentication was cancelled by the user
CANCELLED_CONNECTION - Static variable in exception com.sshtools.ssh.SshException
The user cancelled the connection.
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.
cancelRemoteForwarding(String, int) - Method in interface com.sshtools.ssh.SshClient
Cancel a forwarding request.
cancelRemoteForwarding(String, int) - Method in class com.sshtools.ssh2.Ssh2Client
 
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.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
changePassphrase(String, String) - Method in interface com.sshtools.publickey.SshPrivateKeyFile
Change the passphrase of the key file.
changePermissions(SftpFile, int) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Change the permissions of a file.
changePermissions(String, int) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Change the permissions of a file.
changePermissions(String, String) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Change the permissions of a file.
changePositionofAlgorithm(String, int) - Method in class com.sshtools.ssh.components.ComponentFactory
 
changeTerminalDimensions(int, int, int, int) - Method in interface com.sshtools.ssh.SshSession
Change the dimensions of the terminal window.
changeTerminalDimensions(int, int, int, int) - Method in class com.sshtools.ssh2.Ssh2Session
 
channel - Variable in class com.sshtools.ssh.SubsystemChannel
 
CHANNEL_CLOSED - Static variable in class com.sshtools.ssh.message.SshAbstractChannel
 
CHANNEL_FAILURE - Static variable in exception com.sshtools.ssh.SshException
Indicates that a channel has failed; this is used by channel implementations (such as port forwarding or session channels) to indicate that the channel has critically failed.
CHANNEL_OPEN - Static variable in class com.sshtools.ssh.message.SshAbstractChannel
 
CHANNEL_UNINITIALIZED - Static variable in class com.sshtools.ssh.message.SshAbstractChannel
 
ChannelAdapter - Class in com.sshtools.ssh
An adapter for the ChannelEventListener.
ChannelAdapter() - Constructor for class com.sshtools.ssh.ChannelAdapter
 
channelClosed(int, String, SshTunnel) - Method in interface com.sshtools.net.ForwardingClientListener
A forwarding channel has been closed.
channelClosed(SshChannel) - Method in class com.sshtools.ssh.ChannelAdapter
 
channelClosed(SshChannel) - Method in interface com.sshtools.ssh.ChannelEventListener
A channel is closed.
channelClosing(SshChannel) - Method in class com.sshtools.ssh.ChannelAdapter
 
channelClosing(SshChannel) - Method in interface com.sshtools.ssh.ChannelEventListener
A channel is closing.
channelEOF(SshChannel) - Method in class com.sshtools.ssh.ChannelAdapter
 
channelEOF(SshChannel) - Method in interface com.sshtools.ssh.ChannelEventListener
A channel's input is EOF.
channelEOF() - Method in class com.sshtools.ssh2.Ssh2Channel
Called when the remote side data stream is EOF, by default this method does nothing
ChannelEventListener - Interface in com.sshtools.ssh
An event interface that provides notifications of SshChannel events.
ChannelFactory - Interface in com.sshtools.ssh2
The SSH2 protocol supports many different channel types including sesisons, port forwarding and x11 forwarding; most channels are requested by the client and created by the server however it is possible for the server to request any type of channel from the client, this interface defines the contract for supporting a standard and custom channel creation.
channelFailure(int, String, String, int, boolean, Throwable) - Method in interface com.sshtools.net.ForwardingClientListener
A forwarding channel failed to open.
channelid - Variable in class com.sshtools.ssh.message.SshAbstractChannel
 
channelOpened(int, String, SshTunnel) - Method in interface com.sshtools.net.ForwardingClientListener
A forwarding channel has been opened.
channelOpened(SshChannel) - Method in class com.sshtools.ssh.ChannelAdapter
 
channelOpened(SshChannel) - Method in interface com.sshtools.ssh.ChannelEventListener
A channel has been opened.
ChannelOpenException - Exception in com.sshtools.ssh
Exception thrown when a channel cannot be opened, the reason for which should be specified in with any of the constants defined here.
ChannelOpenException(String, int) - Constructor for exception com.sshtools.ssh.ChannelOpenException
 
channelRequest(String, boolean, byte[]) - Method in class com.sshtools.ssh2.Ssh2Channel
Called when a channel request is received, by default this method sends a failure message if the remote side requests a reply.
channelRequest(String, boolean, byte[]) - Method in class com.sshtools.ssh2.Ssh2Session
This overidden method handles the "exit-status", "exit-signal" and "xon-xoff" channel requests.
CHARSET_ENCODING - Static variable in class com.sshtools.ssh2.TransportProtocol
Character set encoding.
checkCloseStatus(boolean) - Method in class com.sshtools.ssh2.Ssh2Channel
 
checkCloseStatus(boolean) - Method in class com.sshtools.ssh2.Ssh2Session
 
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.
CIPHER_AES128_CBC - Static variable in class com.sshtools.ssh2.Ssh2Context
 
CIPHER_AES128_CTR - Static variable in class com.sshtools.ssh2.Ssh2Context
 
CIPHER_AES192_CBC - Static variable in class com.sshtools.ssh2.Ssh2Context
 
CIPHER_AES192_CTR - Static variable in class com.sshtools.ssh2.Ssh2Context
 
CIPHER_AES256_CBC - Static variable in class com.sshtools.ssh2.Ssh2Context
 
CIPHER_AES256_CTR - Static variable in class com.sshtools.ssh2.Ssh2Context
 
CIPHER_ARCFOUR - Static variable in class com.sshtools.ssh2.Ssh2Context
 
CIPHER_ARCFOUR_128 - Static variable in class com.sshtools.ssh2.Ssh2Context
 
CIPHER_ARCFOUR_256 - Static variable in class com.sshtools.ssh2.Ssh2Context
 
CIPHER_BLOWFISH_CBC - Static variable in class com.sshtools.ssh2.Ssh2Context
 
CIPHER_TRIPLEDES_CBC - Static variable in class com.sshtools.ssh2.Ssh2Context
 
CIPHER_TRIPLEDES_CTR - Static variable in class com.sshtools.ssh2.Ssh2Context
 
clear() - Method in class com.sshtools.ssh.components.ComponentFactory
Clear all of the entries in this component factory.
Client - Interface in com.sshtools.ssh
 
clientlisteners - Variable in class com.sshtools.net.ForwardingClient
 
clone() - Method in class com.sshtools.ssh.components.ComponentFactory
 
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.SftpFile
Close the file.
close() - Method in class com.sshtools.sftp.SftpFileInputStream
Closes the SFTP file handle.
close() - Method in class com.sshtools.sftp.SftpFileOutputStream
Closes the file's handle
close() - Method in class com.sshtools.sftp.SftpSubsystemChannel
 
close() - Method in class com.sshtools.ssh.message.SshMessageStore
 
close() - Method in interface com.sshtools.ssh.SshIO
Close the channel.
close() - Method in interface com.sshtools.ssh.SshSession
Close the session.
close() - Method in class com.sshtools.ssh.SubsystemChannel
Close the subsystem
close() - Method in class com.sshtools.ssh2.Ssh2Channel
Closes the channel.
close() - Method in class com.sshtools.util.Base64.OutputStream
 
close() - Method in class com.sshtools.util.DynamicBuffer
Closes the buffer
close() - Method in class com.sshtools.util.EOLProcessor
 
close() - Method in class com.sshtools.util.IOStreamConnector
 
close() - Method in class com.sshtools.util.TextConversionStream
 
closeFile(SftpFile) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Close a file or directory.
closeStream(InputStream) - Static method in class com.sshtools.util.IOUtil
 
closeStream(OutputStream) - Static method in class com.sshtools.util.IOUtil
 
cmd - Variable in class com.sshtools.scp.ScpClientIO.ScpEngineIO
 
com.sshtools.events - package com.sshtools.events
 
com.sshtools.logging - package com.sshtools.logging
 
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 a Secure Copy (SCP) engine suitable for the lightweight J2SSH Maverick API.
com.sshtools.sftp - package com.sshtools.sftp
The base implementation of the SFTP protocol.
com.sshtools.ssh - package com.sshtools.ssh
This package contains a set of general interface contracts for SSH communication.
com.sshtools.ssh.components - package com.sshtools.ssh.components
This package contains an abstract cryptographic provider for the SSH protocol.
com.sshtools.ssh.components.jce - package com.sshtools.ssh.components.jce
This package contains a set of algoritm implementations that enable the Maverick API to use a Java Cryptography Extension provider.
com.sshtools.ssh.compression - package com.sshtools.ssh.compression
Compression interface for the SSH Transport Protocol.
com.sshtools.ssh.message - package com.sshtools.ssh.message
 
com.sshtools.ssh2 - package com.sshtools.ssh2
This package contains an SSH2 implementation of the com.sshtools.ssh interfaces.
com.sshtools.util - package com.sshtools.util
A set of SSHTools utility classes.
com.sshtools.zlib - package com.sshtools.zlib
 
CommandExecutor - Class in com.sshtools.ssh
Deprecated. 
CommandExecutor(SshSession, String, String, String, String) - Constructor for class com.sshtools.ssh.CommandExecutor
Deprecated.
 
COMPLETE - Static variable in interface com.sshtools.ssh.SshAuthentication
The authentication completed
completed() - Method in interface com.sshtools.sftp.FileTransferProgress
The transfer has completed.
ComponentFactory - Class in com.sshtools.ssh.components
A utility class used to store the available transport components and provide delimited listing as required in the key exchange initialization process.
ComponentFactory(Class<?>) - Constructor for class com.sshtools.ssh.components.ComponentFactory
Create a component factory with the base class supplied.
ComponentManager - Class in com.sshtools.ssh.components
An abstract class that manages the components used by the SSH API.
ComponentManager() - Constructor for class com.sshtools.ssh.components.ComponentManager
 
compress(byte[], int, int) - Method in interface com.sshtools.ssh.compression.SshCompression
Compress a block of data.
compress(byte[], int, int) - Method in class com.sshtools.zlib.ZLibCompression
 
COMPRESSION_ERROR - Static variable in class com.sshtools.ssh2.TransportProtocol
Disconnect reason: A compression error occurred
COMPRESSION_NONE - Static variable in class com.sshtools.ssh2.Ssh2Context
Compression off
COMPRESSION_ZLIB - Static variable in class com.sshtools.ssh2.Ssh2Context
Optional zlib compression (requires sshtools-zlib.jar in classpath)
connect(SshTransport, SshContext, SshConnector, String, String, String, boolean) - Method in interface com.sshtools.ssh.SshClient
Connect to an SSH server.
connect(SshTransport, String) - Method in class com.sshtools.ssh.SshConnector
Create a new connection to an SSH server over the specified transport.
connect(SshTransport, String, boolean) - Method in class com.sshtools.ssh.SshConnector
connect(SshTransport, String, SshContext) - Method in class com.sshtools.ssh.SshConnector
connect(SshTransport, String, boolean, SshContext) - Method in class com.sshtools.ssh.SshConnector
connect(SshTransport, SshContext, SshConnector, String, String, String, boolean) - Method in class com.sshtools.ssh2.Ssh2Client
 
connect(InputStream, OutputStream) - Method in class com.sshtools.util.IOStreamConnector
 
CONNECT_FAILED - Static variable in exception com.sshtools.ssh.ChannelOpenException
The connection could not be established
CONNECT_FAILED - Static variable in exception com.sshtools.ssh.SshException
The connection could not be established.
CONNECTED - Static variable in class com.sshtools.ssh2.TransportProtocol
Protocol state: The transport protocol is connected and services can be started or may already be active.
CONNECTION_CLOSED - Static variable in exception com.sshtools.ssh.SshException
An attempt has been made to use a connection that has been closed and is no longer valid.
CONNECTION_LOST - Static variable in class com.sshtools.ssh2.TransportProtocol
Disconnect reason: The connection was lost
connectorClosed(IOStreamConnector) - Method in interface com.sshtools.util.IOStreamConnector.IOStreamConnectorListener
 
connectorTimeout(IOStreamConnector) - Method in interface com.sshtools.util.IOStreamConnector.IOStreamConnectorListener
 
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<String, String>) - 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.
contains(String) - Method in class com.sshtools.ssh.components.ComponentFactory
Determine whether the factory supports a given component type.
containsFile(File) - Method in class com.sshtools.sftp.DirectoryOperation
Determine whether the operation contains a file.
containsFile(SftpFile) - Method in class com.sshtools.sftp.DirectoryOperation
Determine whether the directory operation contains an SftpFile
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.
copy(InputStream, OutputStream) - Static method in class com.sshtools.util.IOUtil
Copy from an input stream to an output stream.
copy(InputStream, OutputStream, long) - Static method in class com.sshtools.util.IOUtil
Copy the specified number of bytes from an input stream to an output stream.
copy(InputStream, OutputStream, long, int) - Static method in class com.sshtools.util.IOUtil
Copy the specified number of bytes from an input stream to an output stream.
copyFile(File, File) - Static method in class com.sshtools.util.IOUtil
 
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
create(SshKeyPair, String, String, int) - Static method in class com.sshtools.publickey.SshPrivateKeyFileFactory
 
create(SshPublicKey, String, int) - Static method in class com.sshtools.publickey.SshPublicKeyFileFactory
Create a file representation from an existing public key.
create() - Method in class com.sshtools.ssh2.Ssh2Channel
Called after the channel has been created by the createChannel(String, byte[]) - Method in interface com.sshtools.ssh2.ChannelFactory
Create an instance of an SSH channel.
createConnection(String, int) - Method in class com.sshtools.net.ForwardingClient.ForwardingListener
 
createConnection(String, int) - Method in interface com.sshtools.ssh.ForwardingRequestListener
Create a connection to the specified host.
createDsaPrivateKey(BigInteger, BigInteger, BigInteger, BigInteger, BigInteger) - Method in class com.sshtools.ssh.components.ComponentManager
Create an instance of a DSA private key.
createDsaPrivateKey(BigInteger, BigInteger, BigInteger, BigInteger, BigInteger) - Method in class com.sshtools.ssh.components.jce.JCEComponentManager
 
createDsaPublicKey(BigInteger, BigInteger, BigInteger, BigInteger) - Method in class com.sshtools.ssh.components.ComponentManager
Create an instance of a DSA public key.
createDsaPublicKey() - Method in class com.sshtools.ssh.components.ComponentManager
Create an uninitialized instance of a DSA public key
createDsaPublicKey(BigInteger, BigInteger, BigInteger, BigInteger) - Method in class com.sshtools.ssh.components.jce.JCEComponentManager
 
createDsaPublicKey() - Method in class com.sshtools.ssh.components.jce.JCEComponentManager
 
createExtendedDataStream() - Method in class com.sshtools.ssh2.Ssh2Channel
Currently reserved.
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, int, File) - Static method in class com.sshtools.publickey.SshPublicKeyFileFactory
Take a SshPublicKey and write it to a file
createInputStream(int, int, InputStream) - Static method in class com.sshtools.util.EOLProcessor
 
createInstance(String, Class<?>) - Method in class com.sshtools.ssh.components.ComponentFactory
Override this method to create an instance of the component.
createInstance() - Static method in class com.sshtools.ssh.SshConnector
Returns an instance of the SshConnector.
createMessage(byte[]) - Method in class com.sshtools.ssh.message.SshMessageRouter
Called by the message routing framework to request the creation of an SshMessage.
createNewOrdering(int[]) - Method in class com.sshtools.ssh.components.ComponentFactory
 
createOutputStream(int, int, OutputStream) - Static method in class com.sshtools.util.EOLProcessor
 
createPacket() - Method in class com.sshtools.ssh.SubsystemChannel
Get a packet from the available pool or create if non available
createRsaPrivateCrtKey(BigInteger, BigInteger, BigInteger, BigInteger, BigInteger, BigInteger) - Method in class com.sshtools.ssh.components.ComponentManager
Create an instance of an RSA co-effecient private key.
createRsaPrivateCrtKey(BigInteger, BigInteger, BigInteger, BigInteger, BigInteger, BigInteger, BigInteger, BigInteger) - Method in class com.sshtools.ssh.components.ComponentManager
Create an instance of an RSA co-efficent private key.
createRsaPrivateCrtKey(BigInteger, BigInteger, BigInteger, BigInteger, BigInteger, BigInteger) - Method in class com.sshtools.ssh.components.jce.JCEComponentManager
 
createRsaPrivateCrtKey(BigInteger, BigInteger, BigInteger, BigInteger, BigInteger, BigInteger, BigInteger, BigInteger) - Method in class com.sshtools.ssh.components.jce.JCEComponentManager
 
createRsaPrivateKey(BigInteger, BigInteger) - Method in class com.sshtools.ssh.components.ComponentManager
Create an instance of an RSA private key.
createRsaPrivateKey(BigInteger, BigInteger) - Method in class com.sshtools.ssh.components.jce.JCEComponentManager
 
createRsaPublicKey(BigInteger, BigInteger) - Method in class com.sshtools.ssh.components.ComponentManager
Create an instance of an RSA public key.
createRsaPublicKey(BigInteger, BigInteger) - Method in class com.sshtools.ssh.components.jce.JCEComponentManager
 
createSsh2RsaPublicKey() - Method in class com.sshtools.ssh.components.ComponentManager
Create an instance of an SSH2 RSA public key.
createSsh2RsaPublicKey() - Method in class com.sshtools.ssh.components.jce.JCEComponentManager
 
createSymbolicLink(String, String) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Create a symbolic link.
CS7 - Static variable in class com.sshtools.ssh.PseudoTerminalModes
7 bit mode.
CS8 - Static variable in class com.sshtools.ssh.PseudoTerminalModes
8 bit mode.

D

dataReceived(SshChannel, byte[], int, int) - Method in class com.sshtools.ssh.ChannelAdapter
 
dataReceived(SshChannel, byte[], int, int) - Method in interface com.sshtools.ssh.ChannelEventListener
A block of data has been received by the channel.
dataSent(SshChannel, byte[], int, int) - Method in class com.sshtools.ssh.ChannelAdapter
 
dataSent(SshChannel, byte[], int, int) - Method in interface com.sshtools.ssh.ChannelEventListener
A block of data has been sent by the channel.
dataTransfered(byte[], int) - Method in interface com.sshtools.util.IOStreamConnector.IOStreamConnectorListener
 
debug(Object, String, Throwable) - Static method in class com.sshtools.logging.Log
An error log event
debug(Object, String) - Static method in class com.sshtools.logging.Log
A debug event
DECODE - Static variable in class com.sshtools.util.Base64
 
decode(String) - Static method in class com.sshtools.util.Base64
 
decode(byte[], int, int) - Static method in class com.sshtools.util.Base64
 
decode(String) - Static method in class com.sshtools.util.URLUTF8Encoder
 
decodeSSH2PublicKey(byte[]) - Static method in class com.sshtools.publickey.SshPublicKeyFileFactory
Decode an SSH2 encoded public key as specified in the SSH2 transport protocol.
decodeSSH2PublicKey(String, byte[]) - Static method in class com.sshtools.publickey.SshPublicKeyFileFactory
 
decodeToObject(String) - Static method in class com.sshtools.util.Base64
 
decodeToString(String) - Static method in class com.sshtools.util.Base64
 
DECRYPT_MODE - Static variable in class com.sshtools.ssh.components.SshCipher
Decryption mode.
DEFAULT_BUFFER_SIZE - Static variable in class com.sshtools.util.DynamicBuffer
Buffer size when the dynamic buffer is opened
DEFAULT_BUFFER_SIZE - Static variable in class com.sshtools.util.IOStreamConnector
 
DEFLATER - Static variable in interface com.sshtools.ssh.compression.SshCompression
Deflation mode
delete() - Method in class com.sshtools.sftp.SftpFile
Delete this file/directory from the remote server.
delTree(File) - Static method in class com.sshtools.util.IOUtil
 
DIFFIE_HELLMAN_GROUP14_SHA1 - Static variable in class com.sshtools.ssh.components.jce.DiffieHellmanGroup14Sha1
Constant for the algorithm name "diffie-hellman-group14-sha1".
DIFFIE_HELLMAN_GROUP1_SHA1 - Static variable in class com.sshtools.ssh.components.jce.DiffieHellmanGroup1Sha1
Constant for the algorithm name "diffie-hellman-group1-sha1".
DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA1 - Static variable in class com.sshtools.ssh.components.jce.DiffieHellmanGroupExchangeSha1
Constant for the algorithm name "diffie-hellman-group-exchange-sha1".
DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA256 - Static variable in class com.sshtools.ssh.components.jce.DiffieHellmanGroupExchangeSha256
 
DiffieHellmanGroup14Sha1 - Class in com.sshtools.ssh.components.jce
An implementation of the diffie-hellman-group1-sha1 key exchange mechanism that uses JCE provider for DH agreement and Digest.
DiffieHellmanGroup14Sha1() - Constructor for class com.sshtools.ssh.components.jce.DiffieHellmanGroup14Sha1
 
DiffieHellmanGroup1Sha1 - Class in com.sshtools.ssh.components.jce
An implementation of the diffie-hellman-group1-sha1 key exchange mechanism that uses JCE provider for DH agreement and Digest.
DiffieHellmanGroup1Sha1() - Constructor for class com.sshtools.ssh.components.jce.DiffieHellmanGroup1Sha1
Construct an uninitialized instance.
DiffieHellmanGroupExchangeSha1 - Class in com.sshtools.ssh.components.jce
An implementation of the diffie-hellman-group-exchange key exchange mechanism that uses JCE provider for DH agreement and Digest.
DiffieHellmanGroupExchangeSha1() - Constructor for class com.sshtools.ssh.components.jce.DiffieHellmanGroupExchangeSha1
Construct an uninitialized instance.
DiffieHellmanGroupExchangeSha1(String) - Constructor for class com.sshtools.ssh.components.jce.DiffieHellmanGroupExchangeSha1
 
DiffieHellmanGroupExchangeSha256 - Class in com.sshtools.ssh.components.jce
 
DiffieHellmanGroupExchangeSha256() - Constructor for class com.sshtools.ssh.components.jce.DiffieHellmanGroupExchangeSha256
 
DiffieHellmanGroups - Class in com.sshtools.ssh.components
 
DiffieHellmanGroups() - Constructor for class com.sshtools.ssh.components.DiffieHellmanGroups
 
Digest - Interface in com.sshtools.ssh.components
A general interface for a digest with utility methods to add java types into the digest.
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
disable() - Static method in class com.sshtools.logging.LoggerFactory
 
disableCompression() - Method in class com.sshtools.ssh2.Ssh2Context
 
disconnect() - Method in interface com.sshtools.ssh.SshClient
Disconnect from the remote computer.
disconnect() - Method in class com.sshtools.ssh2.Ssh2Client
 
disconnect(int, String) - Method in class com.sshtools.ssh2.TransportProtocol
Disconnect from the remote host.
DISCONNECTED - Static variable in class com.sshtools.ssh2.TransportProtocol
Protocol state: The transport protocol has disconnected.
displayBanner(String) - Method in interface com.sshtools.ssh2.BannerDisplay
Called when a banner message is received.
dispose() - Method in class com.sshtools.util.ByteArrayReader
 
dispose() - Method in class com.sshtools.util.ByteArrayWriter
 
doFinal() - Method in interface com.sshtools.ssh.components.Digest
Do the final processing and return the hash.
doFinal() - Method in class com.sshtools.ssh.components.jce.AbstractDigest
 
doFinal() - Method in class com.sshtools.ssh.components.jce.AbstractHmac
 
doFinal() - Method in class com.sshtools.ssh.components.NoneHmac
 
doFinal() - Method in interface com.sshtools.ssh.components.SshHmac
 
doPrivate(BigInteger) - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPrivateCrtKey
 
doPrivate(BigInteger) - Method in interface com.sshtools.ssh.components.SshRsaPrivateCrtKey
 
doPublic(BigInteger) - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPublicKey
 
doPublic(BigInteger) - Method in interface com.sshtools.ssh.components.SshRsaPublicKey
 
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
 
duplicate() - Method in interface com.sshtools.ssh.SshClient
Create an identical version of an SshClient using cached authentication information and the SshTransport duplicate method.
duplicate() - Method in interface com.sshtools.ssh.SshTransport
Create a new copy of this transport and connect to the same host:port combination.
duplicate() - Method in class com.sshtools.ssh2.Ssh2Client
 
DynamicBuffer - Class in com.sshtools.util
This class provides an alternative method of storing data, used within the API where Piped Streams could have been used.
DynamicBuffer() - Constructor for class com.sshtools.util.DynamicBuffer
Creates a new DynamicBuffer object.

E

ECHO - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Enable echoing.
echo() - Method in class com.sshtools.ssh2.KBIPrompt
true if the user response should be echo'd to the display, otherwise false.
ECHOCTL - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Echo control characters as ^(Char).
ECHOE - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Visually erase chars.
ECHOK - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Kill character discards current line.
ECHOKE - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Visual erase for line kill.
ECHONL - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Echo NL even if ECHO is off.
enable() - Static method in class com.sshtools.logging.LoggerFactory
 
enableCompression() - Method in class com.sshtools.ssh2.Ssh2Context
 
enableFIPSMode() - Method in class com.sshtools.ssh.SshConnector
 
enableFIPSMode() - Method in interface com.sshtools.ssh.SshContext
Enables FIPS compatible algorithms and disables any other non-compatible algorithms.
enableFIPSMode() - Method in class com.sshtools.ssh2.Ssh2Context
 
ENCODE - Static variable in class com.sshtools.util.Base64
 
encode - Static variable in class com.sshtools.util.ByteArrayReader
 
encode(String, boolean) - Static method in class com.sshtools.util.URLUTF8Encoder
Encode a string to the "x-www-form-urlencoded" form, enhanced with the UTF-8-in-URL proposal.
encodeBytes(byte[], boolean) - Static method in class com.sshtools.util.Base64
 
encodeBytes(byte[], int, int, boolean) - Static method in class com.sshtools.util.Base64
 
encodeInt(int) - Static method in class com.sshtools.util.ByteArrayWriter
Encode an integer into a 4 byte array.
encodeInt(byte[], int, int) - Static method in class com.sshtools.util.ByteArrayWriter
 
encodeObject(Serializable) - Static method in class com.sshtools.util.Base64
 
encodeString(String, boolean) - Static method in class com.sshtools.util.Base64
 
ENCRYPT_MODE - Static variable in class com.sshtools.ssh.components.SshCipher
Encryption mode.
end - Variable in class com.sshtools.publickey.Base64EncodedFileFormat
 
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)
EOLProcessor - Class in com.sshtools.util
This class processes text data and corrects line endings according to the settings provided.
EOLProcessor(int, int, OutputStream) - Constructor for class com.sshtools.util.EOLProcessor
 
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.
equals(Object) - Method in class com.sshtools.ssh.components.jce.Ssh2DsaPublicKey
 
equals(Object) - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPublicKey
 
equals(Object) - Method in class com.sshtools.ssh2.Ssh2Channel
This channel is equal to another channel if the channel id's are equal.
equals(Object) - Method in class com.sshtools.util.UnsignedInteger32
Compares an object.
equals(Object) - Method in class com.sshtools.util.UnsignedInteger64
Compares this unsigned integer to an object.
error(Object, String) - Static method in class com.sshtools.logging.Log
An error log event
error(Object, String, Throwable) - Static method in class com.sshtools.logging.Log
An exception event
Event - Class in com.sshtools.events
Superclass of all events that may be fired during the life of J2SSH.
Event(Object, int, boolean) - Constructor for class com.sshtools.events.Event
 
EVENT_AUTHENTICATION_METHODS_RECEIVED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_CONNECTION_ATTEMPT - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_DISCONNECTED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_FAILED_TO_NEGOTIATE_TRANSPORT_COMPONENT - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_FORWARDING_LOCAL_STARTED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_FORWARDING_LOCAL_STOPPED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_FORWARDING_REMOTE_STARTED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_FORWARDING_REMOTE_STOPPED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_HOSTKEY_ACCEPTED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_HOSTKEY_RECEIVED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_HOSTKEY_REJECTED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_KEY_EXCHANGE_COMPLETE - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_KEY_EXCHANGE_FAILURE - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_KEY_EXCHANGE_INIT - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_REACHED_CONNECTION_LIMIT - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_RECEIVED_DISCONNECT - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_SFTP_DIRECTORY_DELETED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_SFTP_FILE_CLOSED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_SFTP_FILE_DELETED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_SFTP_FILE_OPENED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_SFTP_FILE_RENAMED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_SFTP_SESSION_STARTED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_SFTP_SESSION_STOPPED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_SHELL_COMMAND - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_SHELL_SESSION_FAILED_TO_START - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_SHELL_SESSION_STARTED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_SUBSYSTEM_STARTED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_USERAUTH_FAILURE - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_USERAUTH_FURTHER_AUTHENTICATION_REQUIRED - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EVENT_USERAUTH_SUCCESS - Static variable in class com.sshtools.events.J2SSHEventCodes
 
EventListener - Interface in com.sshtools.events
Interface to be implemented by classes interested in receiving events.
EventObject - Class in com.sshtools.events
The root class from which all event state objects shall be derived.
EventObject(Object) - Constructor for class com.sshtools.events.EventObject
Constructs a prototypical Event.
EventService - Interface in com.sshtools.events
Interface to be implemented by an event service implementation.
EventServiceImplementation - Class in com.sshtools.events
Event Service Implementation singleton, that manages J2SSH Event Listeners, and allows events to be fired.
EventServiceImplementation() - Constructor for class com.sshtools.events.EventServiceImplementation
 
exchangeHash - Variable in class com.sshtools.ssh.components.SshKeyExchangeClient
The exchange hash produced during key exchange.
executeCommand(String) - Method in class com.sshtools.ssh.CommandExecutor
Deprecated.
 
executeCommand(String) - Method in interface com.sshtools.ssh.SshSession
Execute a command.
executeCommand(String, String) - Method in interface com.sshtools.ssh.SshSession
Execute a command.
executeCommand(String) - Method in class com.sshtools.ssh2.Ssh2Session
 
executeCommand(String, String) - Method in class com.sshtools.ssh2.Ssh2Session
 
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.
exit() - Method in interface com.sshtools.ssh.Client
 
exit() - Method in class com.sshtools.ssh2.Ssh2Client
 
exitCode() - Method in interface com.sshtools.ssh.SshSession
Return the exit code of the process once complete.
exitCode() - Method in class com.sshtools.ssh2.Ssh2Session
 
EXITCODE_NOT_RECEIVED - Static variable in interface com.sshtools.ssh.SshSession
Returned from exitCode() when the remote process is still active.
extendedDataReceived(SshChannel, byte[], int, int, int) - Method in class com.sshtools.ssh.ChannelAdapter
 
extendedDataReceived(SshChannel, byte[], int, int, int) - Method in interface com.sshtools.ssh.ChannelEventListener
A block of extended data has been received by the channel.

F

FAILED - Static variable in interface com.sshtools.ssh.SshAuthentication
The authentication failed
FileTransferProgress - Interface in com.sshtools.sftp
Interface for monitoring the state of a file transfer
finish() - Method in class com.sshtools.ssh.Packet
 
fireEvent(Event) - Method in interface com.sshtools.events.EventService
Fire a MaverickEvent at all MaverickListeners that have registered an interest in events.
fireEvent(Event) - Method in class com.sshtools.events.EventServiceImplementation
Send an SSH Event to each registered listener
flush() - Method in class com.sshtools.util.Base64.OutputStream
 
flush() - Method in class com.sshtools.util.DynamicBuffer
Flush data
forceKeyExchange() - Method in class com.sshtools.ssh2.Ssh2Client
The SSH transport protocol exchanges keys at the beginning of the session; the specification recommends that these keys be re-exchanged after each gigabyte of transmitted data or after each hour of connection time, whichever comes sooner.
formatKey(byte[]) - Method in class com.sshtools.publickey.Base64EncodedFileFormat
 
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.
FORWARDING_ERROR - Static variable in exception com.sshtools.ssh.SshException
An error has occurred the port forwarding system.
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.
ForwardingClient.ForwardingListener - Class in com.sshtools.net
 
ForwardingClient.ForwardingListener() - Constructor for class com.sshtools.net.ForwardingClient.ForwardingListener
 
ForwardingClient.SocketListener - Class in com.sshtools.net
 
ForwardingClient.SocketListener(String, int, String, int) - Constructor for class com.sshtools.net.ForwardingClient.SocketListener
 
ForwardingClientListener - Interface in com.sshtools.net
An event listener for receiving notification of forwarding events.
ForwardingRequestListener - Interface in com.sshtools.ssh
This interface is required when a request for remote port forwarding is made.
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.
freeChannel(SshAbstractChannel) - Method in class com.sshtools.ssh.message.SshMessageRouter
 
FURTHER_AUTHENTICATION_REQUIRED - Static variable in interface com.sshtools.ssh.SshAuthentication
The authentication succeeded but further authentication is required

G

GENERAL_FAILURE - Static variable in exception com.sshtools.publickey.PublicKeySubsystemException
 
generate(long, byte[], int, int, byte[], int) - Method in class com.sshtools.ssh.components.jce.AbstractHmac
 
generate(long, byte[], int, int, byte[], int) - Method in class com.sshtools.ssh.components.NoneHmac
 
generate(long, byte[], int, int, byte[], int) - Method in interface com.sshtools.ssh.components.SshHmac
 
generateDsaKeyPair(int) - Method in class com.sshtools.ssh.components.ComponentManager
Generate a new DSA public/private key pair.
generateDsaKeyPair(int) - Method in class com.sshtools.ssh.components.jce.JCEComponentManager
 
generateKeyPair(String, int) - Static method in class com.sshtools.publickey.SshKeyPairGenerator
Generates a new key pair.
generateRsaKeyPair(int) - Method in class com.sshtools.ssh.components.ComponentManager
Generate an RSA public/private pair.
generateRsaKeyPair(int) - Method in class com.sshtools.ssh.components.jce.JCEComponentManager
 
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.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.
getAbsolutePath() - Method in class com.sshtools.sftp.SftpFile
Get the absolute path
getAbsolutePath(SftpFile) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Get the absolute path of a file.
getAbsolutePath(String) - Method in class com.sshtools.sftp.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.
getActiveChannels() - Method in class com.sshtools.ssh.message.SshMessageRouter
 
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.AbstractHmac
 
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.DiffieHellmanGroup14Sha1
 
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.DiffieHellmanGroup1Sha1
Get the algorithm name for this key exchange
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.DiffieHellmanGroupExchangeSha1
Get the algorithm name for this key exchange
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.DiffieHellmanGroupExchangeSha256
 
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.HmacMD5
 
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.HmacMD596
 
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.HmacSha1
 
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.HmacSha196
 
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.HmacSha256
 
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.HmacSha512
 
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.Ssh2DsaPrivateKey
 
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.Ssh2DsaPublicKey
Get the algorithm name for the public key.
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPrivateCrtKey
 
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPrivateKey
 
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPublicKey
 
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.SshX509DsaPublicKey
Get the algorithm name for the public key.
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.SshX509RsaPublicKey
Get the algorithm name for the public key.
getAlgorithm() - Method in class com.sshtools.ssh.components.jce.SshX509RsaSha1PublicKey
Get the algorithm name for the public key.
getAlgorithm() - Method in class com.sshtools.ssh.components.NoneHmac
 
getAlgorithm() - Method in class com.sshtools.ssh.components.SshCipher
 
getAlgorithm() - Method in interface com.sshtools.ssh.components.SshHmac
 
getAlgorithm() - Method in class com.sshtools.ssh.components.SshKeyExchangeClient
Get the key exchange algorithm name.
getAlgorithm() - Method in interface com.sshtools.ssh.components.SshPrivateKey
 
getAlgorithm() - Method in interface com.sshtools.ssh.components.SshPublicKey
Get the algorithm name for the public key.
getAlgorithm() - Method in interface com.sshtools.ssh.compression.SshCompression
Get the algorithm name for this compression implementation.
getAlgorithm() - Method in class com.sshtools.zlib.OpenSSHZLibCompression
 
getAlgorithm() - Method in class com.sshtools.zlib.ZLibCompression
 
getAllAttributes() - Method in class com.sshtools.events.Event
 
getAttribute(String) - Method in class com.sshtools.events.Event
Get the value of an event attribute
getAttributes() - Method in class com.sshtools.sftp.SftpFile
Get the files attributes.
getAttributes(String) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Get the attributes of a file.
getAttributes(String, int) - Method in class com.sshtools.sftp.SftpSubsystemChannel
 
getAttributes(SftpFile) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Get the attributes of a file.
getAuthenticationMethod() - Method in class com.sshtools.net.HttpResponse
 
getAuthenticationMethods(String, String) - Method in class com.sshtools.ssh2.AuthenticationProtocol
Get a list of available authentication methods for the user.
getAuthenticationMethods() - Method in class com.sshtools.ssh2.AuthenticationResult
Get the authentication methods that can be used.
getAuthenticationMethods(String) - Method in class com.sshtools.ssh2.Ssh2Client
Get a list of authentication methods for the user.
getAuthenticationRealm() - Method in class com.sshtools.net.HttpResponse
 
getBannerDisplay() - Method in class com.sshtools.ssh2.Ssh2Context
Get the contexts banner display
getBitLength() - Method in class com.sshtools.ssh.components.jce.Ssh2DsaPublicKey
 
getBitLength() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPublicKey
 
getBitLength() - Method in interface com.sshtools.ssh.components.SshPublicKey
Get the bit length of the public key
getBlockSize() - Method in class com.sshtools.ssh.components.jce.AbstractJCECipher
 
getBlockSize() - Method in class com.sshtools.ssh.components.jce.ArcFour
 
getBlockSize() - Method in class com.sshtools.ssh.components.jce.ArcFour128
 
getBlockSize() - Method in class com.sshtools.ssh.components.jce.ArcFour256
 
getBlockSize() - Method in class com.sshtools.ssh.components.NoneCipher
Get the cipher block size.
getBlockSize() - Method in class com.sshtools.ssh.components.SshCipher
Get the cipher block size.
getByte() - Method in class com.sshtools.util.SimpleASNReader
 
getBytes() - Method in class com.sshtools.util.IOStreamConnector
 
getCanonicalNewline() - Method in class com.sshtools.sftp.SftpSubsystemChannel
Returns the canonical newline convention in use when reading/writing text files.
getCause() - Method in exception com.sshtools.ssh.SshException
If an INTERNAL_ERROR reason is given this method MAY return the cause of the error.
getCertificate() - Method in class com.sshtools.ssh.components.jce.SshX509DsaPublicKey
 
getCertificate() - Method in class com.sshtools.ssh.components.jce.SshX509RsaPublicKey
 
getCertificate() - Method in class com.sshtools.ssh.components.jce.SshX509RsaSha1PublicKey
 
getChannelCount() - Method in class com.sshtools.ssh.message.SshMessageRouter
 
getChannelCount() - Method in interface com.sshtools.ssh.SshClient
Get the number of active channels.
getChannelCount() - Method in class com.sshtools.ssh2.Ssh2Client
 
getChannelId() - Method in class com.sshtools.ssh.message.SshAbstractChannel
 
getChannelId() - Method in interface com.sshtools.ssh.SshChannel
Get the id of this channel.
getChannelLimit() - Method in interface com.sshtools.ssh.SshContext
Get the maximum number of channels that are allowed open at any one time.
getChannelLimit() - Method in class com.sshtools.ssh2.Ssh2Context
 
getCharsetEncoding() - Method in class com.sshtools.sftp.SftpSubsystemChannel
Get the current encoding being used for filename Strings.
getCharsetEncoding() - Static method in class com.sshtools.util.ByteArrayReader
Get the current encoding being used for Strings variables.
getCipherInUseCS() - Method in class com.sshtools.ssh2.Ssh2Client
Get the cipher algorithm used to encrypt data sent to the server.
getCipherInUseSC() - Method in class com.sshtools.ssh2.Ssh2Client
Get the cipher algorithm used to decrypt data received from the server.
getCiphersCS() - Method in class com.sshtools.ssh2.Ssh2Context
Get the ciphers for the Client->Server stream.
getCiphersSC() - Method in class com.sshtools.ssh2.Ssh2Context
Get the ciphers for the Server->Client stream.
getClient() - Method in interface com.sshtools.ssh.SshSession
Get the client that created this session.
getClient() - Method in class com.sshtools.ssh2.Ssh2Session
 
getClient() - Method in class com.sshtools.ssh2.TransportProtocol
Get the SshClient instance that created this transport.
getClientUsername() - Method in class com.sshtools.ssh2.Ssh2HostbasedAuthentication
Get the user's username on the client computer
getComment() - Method in class com.sshtools.publickey.OpenSSHPublicKeyFile
 
getComment() - Method in class com.sshtools.publickey.SECSHPublicKeyFile
 
getComment() - Method in interface com.sshtools.publickey.SshPublicKeyFile
Get the comment applied to the key file.
getCompressionInUseCS() - Method in class com.sshtools.ssh2.Ssh2Client
Get the compression algorithm used to compress the clients outgoing data.
getCompressionInUseSC() - Method in class com.sshtools.ssh2.Ssh2Client
Get the compression algorithm used to decompress the servers data.
getConnectionTimeout() - Static method in class com.sshtools.net.HttpProxyTransport
 
getConnectionTimeout() - Static method in class com.sshtools.net.HttpProxyTransportWrapper
 
getContext() - Method in interface com.sshtools.ssh.SshClient
Get the context that created this client.
getContext() - Method in class com.sshtools.ssh.SshConnector
Get the configuration context.
getContext() - Method in class com.sshtools.ssh2.Ssh2Client
 
getContext() - Method in class com.sshtools.ssh2.TransportProtocol
 
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.
getCrtCoefficient() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPrivateCrtKey
 
getCrtCoefficient() - Method in interface com.sshtools.ssh.components.SshRsaPrivateCrtKey
 
getData() - Method in class com.sshtools.ssh2.GlobalRequest
Get the request data, if the request has been sent and processed, this will return the response data (which can be null).
getData() - Method in class com.sshtools.util.SimpleASNReader
 
getDefaultDirectory() - Method in class com.sshtools.sftp.SftpClient
Get the default directory (or HOME directory)
getDefaultDirectory() - Method in class com.sshtools.sftp.SftpSubsystemChannel
Gets the users default directory.
getDeletedFiles() - Method in class com.sshtools.sftp.DirectoryOperation
When synchronizing directories, this method will return a list of files that will be deleted becasue they no longer exist at the source location.
getDHGroupExchangeKeySize() - Method in class com.sshtools.ssh2.Ssh2Context
 
getEncoded() - Method in class com.sshtools.ssh.components.jce.Ssh2DsaPublicKey
Encode the public key into a blob of binary data, the encoded result will be passed into init to recreate the key.
getEncoded() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPublicKey
 
getEncoded() - Method in class com.sshtools.ssh.components.jce.SshX509DsaPublicKey
Encode the public key into a blob of binary data, the encoded result will be passed into init to recreate the key.
getEncoded() - Method in class com.sshtools.ssh.components.jce.SshX509RsaPublicKey
Encode the public key into a blob of binary data, the encoded result will be passed into init to recreate the key.
getEncoded() - Method in class com.sshtools.ssh.components.jce.SshX509RsaSha1PublicKey
Encode the public key into a blob of binary data, the encoded result will be passed into init to recreate the key.
getEncoded() - Method in interface com.sshtools.ssh.components.SshPublicKey
Encode the public key into a blob of binary data, the encoded result will be passed into init to recreate the key.
getExchangeHash() - Method in class com.sshtools.ssh.components.SshKeyExchangeClient
Get the output of the key exchange
getExitSignalInfo() - Method in class com.sshtools.ssh2.Ssh2Session
Get the exit signal information, may be an empty string.
getExtension(String) - Method in class com.sshtools.sftp.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.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) - 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.
getFingerprint() - Method in class com.sshtools.ssh.components.jce.Ssh2DsaPublicKey
 
getFingerprint() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPublicKey
 
getFingerprint() - Method in interface com.sshtools.ssh.components.SshPublicKey
Return an SSH fingerprint of the public key
getFingerprint(byte[]) - Static method in class com.sshtools.ssh.SshKeyFingerprint
Generate an SSH key fingerprint as defined in draft-ietf-secsh-fingerprint-00.txt.
getFingerprint(byte[], String) - Static method in class com.sshtools.ssh.SshKeyFingerprint
Generate an SSH key fingerprint with a specific algorithm.
getFlags() - Method in class com.sshtools.sftp.ACL
 
getFormattedKey() - Method in class com.sshtools.publickey.OpenSSHPublicKeyFile
 
getFormattedKey() - Method in class com.sshtools.publickey.SECSHPublicKeyFile
 
getFormattedKey() - Method in interface com.sshtools.publickey.SshPrivateKeyFile
Get the formatted key
getFormattedKey() - Method in interface com.sshtools.publickey.SshPublicKeyFile
Get the formatted key.
getG() - Method in class com.sshtools.ssh.components.jce.Ssh2DsaPublicKey
 
getG() - Method in interface com.sshtools.ssh.components.SshDsaPublicKey
 
getGID() - Method in class com.sshtools.sftp.SftpFileAttributes
Get the GID of this file.
getGlobalMessages() - Method in class com.sshtools.ssh.message.SshMessageRouter
 
getGssCallback() - Method in class com.sshtools.ssh2.Ssh2Context
 
getHandle() - Method in class com.sshtools.sftp.SftpFile
Get the open file handle
getHashAlgorithm() - Method in class com.sshtools.ssh.components.SshKeyExchangeClient
 
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
 
getHost() - Method in interface com.sshtools.ssh.SshTransport
Get the name of the connected host.
getHost() - Method in class com.sshtools.ssh2.AuthenticationProtocol
 
getHostKey() - Method in class com.sshtools.ssh.components.SshKeyExchangeClient
Get the host key supplied during key exchange.
getHostKeyInUse() - Method in class com.sshtools.ssh2.Ssh2Client
Returns the host key algorithm used in the last key exchange.
getHostKeyVerification() - Method in interface com.sshtools.ssh.SshContext
Get the host key verification implementation.
getHostKeyVerification() - Method in class com.sshtools.ssh2.Ssh2Context
Get the host key verification implementation
getHostToConnect() - Method in class com.sshtools.net.ForwardingClient.SocketListener
 
getId() - Method in class com.sshtools.events.Event
Get the unique event id
getIdleConnectionTimeoutSeconds() - Method in class com.sshtools.ssh2.Ssh2Context
 
getIgnoreHostKeyifEmpty() - Method in class com.sshtools.ssh2.TransportProtocol
 
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.
getInputStream() - Method in interface com.sshtools.ssh.SshIO
Get an InputStream to read incoming channel data.
getInputStream() - Method in interface com.sshtools.ssh.SshSession
Get an InputStream to read the process stdout.
getInputStream() - Method in class com.sshtools.ssh2.Ssh2Channel
 
getInputStream() - Method in class com.sshtools.util.DynamicBuffer
Get the InputStream of this buffer.
getInstance() - Static method in class com.sshtools.events.EventServiceImplementation
Get the event service instance
getInstance() - Static method in class com.sshtools.logging.LoggerFactory
 
getInstance(String) - Method in class com.sshtools.ssh.components.ComponentFactory
Get a new instance of a supported component.
getInstance() - Static method in class com.sshtools.ssh.components.ComponentManager
Get the installed component manager.
getKeepAliveMaxDataLength() - Method in class com.sshtools.ssh2.Ssh2Context
 
getKeyBlob(byte[]) - Method in class com.sshtools.publickey.Base64EncodedFileFormat
 
getKeyExchange() - Method in class com.sshtools.ssh2.AuthenticationProtocol
 
getKeyExchange() - Method in class com.sshtools.ssh2.TransportProtocol
 
getKeyExchangeInstanceInUse() - Method in class com.sshtools.ssh2.Ssh2Client
 
getKeyExchangeInUse() - Method in class com.sshtools.ssh2.Ssh2Client
Returns the key exchange algorithm last used.
getKeyExchanges() - Method in class com.sshtools.ssh2.Ssh2Context
Get the ciphers for the Server->Client stream.
getKeyPair(SshPrivateKey, SshPublicKey) - Static method in class com.sshtools.ssh.components.SshKeyPair
Wraps a public/private key pair into an SshKeyPair instance.
getKnownHostsFile() - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification
 
getLastError() - Method in class com.sshtools.ssh2.TransportProtocol
Returns the last error detected by the protocol.
getLastError() - Method in class com.sshtools.util.IOStreamConnector
 
getLength() - Method in class com.sshtools.util.SimpleASNReader
 
getLinkAttributes(String) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Get the attributes of a file.
getListeningAddress() - Method in interface com.sshtools.ssh.SshTunnel
The source ip address of the connection that is being forwarded.
getListeningPort() - Method in interface com.sshtools.ssh.SshTunnel
The source port of the connection being forwarded.
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.
getLocalForwardingTunnels() - Method in class com.sshtools.net.ForwardingClient
Get all the active local forwarding tunnels
getLocalPort() - Method in class com.sshtools.net.ForwardingClient.SocketListener
 
getLongname() - Method in class com.sshtools.sftp.SftpFile
 
getMacInUseCS() - Method in class com.sshtools.ssh2.Ssh2Client
Get the MAC algorithm used to verify data sent by the client.
getMacInUseSC() - Method in class com.sshtools.ssh2.Ssh2Client
Get the MAC algorithm used to verify data sent by the server.
getMacLength() - Method in class com.sshtools.ssh.components.jce.AbstractHmac
 
getMacLength() - Method in class com.sshtools.ssh.components.NoneHmac
 
getMacLength() - Method in interface com.sshtools.ssh.components.SshHmac
 
getMacsCS() - Method in class com.sshtools.ssh2.Ssh2Context
Get the ciphers for the Client->Server stream.
getMacsSC() - Method in class com.sshtools.ssh2.Ssh2Context
Get the ciphers for the Server->Client stream.
getMask() - Method in class com.sshtools.sftp.ACL
 
getMaskString() - Method in class com.sshtools.sftp.SftpFileAttributes
Return the UNIX style mode mask
getMaxChannels() - Method in class com.sshtools.ssh.message.SshMessageRouter
 
getMaximumPacketLength() - Method in class com.sshtools.ssh2.Ssh2Context
Get the maximim packet size supported by the transport layer.
getMessageId() - Method in class com.sshtools.sftp.SftpMessage
 
getMessageId() - Method in interface com.sshtools.ssh.message.Message
 
getMessageId() - Method in class com.sshtools.ssh.message.SshMessage
 
getMessageRouter() - Method in class com.sshtools.ssh.message.SshAbstractChannel
 
getMessageRouter() - Method in interface com.sshtools.ssh.SshChannel
Returns the message router instance to which this channel belongs.
getMessageStore() - Method in class com.sshtools.ssh.message.SshAbstractChannel
 
getMessageStore() - Method in class com.sshtools.ssh2.Ssh2Channel
 
getMethod() - Method in class com.sshtools.ssh.PasswordAuthentication
 
getMethod() - Method in class com.sshtools.ssh.PublicKeyAuthentication
 
getMethod() - Method in interface com.sshtools.ssh.SshAuthentication
The SSH authentication method name
getMethod() - Method in class com.sshtools.ssh2.KBIAuthentication
 
getMethod() - Method in class com.sshtools.ssh2.Ssh2HostbasedAuthentication
 
getMethodName() - Method in class com.sshtools.ssh2.KBIAuthentication
 
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.
getModulus() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPrivateCrtKey
 
getModulus() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPrivateKey
 
getModulus() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPublicKey
 
getModulus() - Method in interface com.sshtools.ssh.components.SshRsaPrivateKey
 
getModulus() - Method in interface com.sshtools.ssh.components.SshRsaPublicKey
 
getName() - Method in class com.sshtools.ssh2.GlobalRequest
Get the name of the request.
getName() - Method in class com.sshtools.ssh2.Ssh2Channel
Get the name of the channel.
getNewFiles() - Method in class com.sshtools.sftp.DirectoryOperation
Returns a list of new files that will be transfered in the directory operation
getOKRequestStatus(UnsignedInteger32) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Verify that an OK status has been returned for a request id.
getOriginatingHost() - Method in interface com.sshtools.ssh.SshTunnel
The host that made the initial connection to the listening address.
getOriginatingPort() - Method in interface com.sshtools.ssh.SshTunnel
The port of the initial connection.
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.
getOutputStream() - Method in interface com.sshtools.ssh.SshIO
Get an OutputStream to write outgoing channel data.
getOutputStream() - Method in interface com.sshtools.ssh.SshSession
Get an OutputStream to write to the process stdin.
getOutputStream() - Method in class com.sshtools.ssh2.Ssh2Channel
 
getOutputStream() - Method in class com.sshtools.util.DynamicBuffer
Get the OutputStream of the buffer.
getP() - Method in class com.sshtools.ssh.components.jce.Ssh2DsaPublicKey
 
getP() - Method in interface com.sshtools.ssh.components.SshDsaPublicKey
 
getParent() - Method in class com.sshtools.sftp.SftpFile
Get the parent of the current file.
getPartialMessageTimeout() - Method in class com.sshtools.ssh2.Ssh2Context
 
getPassword() - Method in class com.sshtools.ssh.PasswordAuthentication
Get the password.
getPerContextAlgorithmPreferences() - Static method in class com.sshtools.ssh.components.ComponentManager
 
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
 
getPort() - Method in interface com.sshtools.ssh.SshTransport
Get the port of this connection
getPort() - Method in interface com.sshtools.ssh.SshTunnel
The port to which the data is being forwarded.
getPortToConnect() - Method in class com.sshtools.net.ForwardingClient.SocketListener
 
getPosition() - Method in class com.sshtools.util.ByteArrayReader
Get the current position within the array.
getPreferredCipherCS() - Method in class com.sshtools.ssh2.Ssh2Context
Get the currently preferred cipher for the Client->Server stream.
getPreferredCipherSC() - Method in class com.sshtools.ssh2.Ssh2Context
Get the currently preferred cipher for the Server->Client stream.
getPreferredCompressionCS() - Method in class com.sshtools.ssh2.Ssh2Context
Get the currently preferred compression for the Client->Server stream.
getPreferredCompressionSC() - Method in class com.sshtools.ssh2.Ssh2Context
Get the currently preferred compression for the Server->Client stream.
getPreferredKeyExchange() - Method in class com.sshtools.ssh2.Ssh2Context
Get the currently preferred key exchange method.
getPreferredMacCS() - Method in class com.sshtools.ssh2.Ssh2Context
Get the currently preferred mac for the Client->Server stream.
getPreferredMacSC() - Method in class com.sshtools.ssh2.Ssh2Context
Get the currently supported mac for the Server-Client stream.
getPreferredPublicKey() - Method in class com.sshtools.ssh2.Ssh2Context
Get the currently preferred public key algorithm.
getPrimeExponentP() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPrivateCrtKey
 
getPrimeExponentP() - Method in interface com.sshtools.ssh.components.SshRsaPrivateCrtKey
 
getPrimeExponentQ() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPrivateCrtKey
 
getPrimeExponentQ() - Method in interface com.sshtools.ssh.components.SshRsaPrivateCrtKey
 
getPrimeP() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPrivateCrtKey
 
getPrimeP() - Method in interface com.sshtools.ssh.components.SshRsaPrivateCrtKey
 
getPrimeQ() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPrivateCrtKey
 
getPrimeQ() - Method in interface com.sshtools.ssh.components.SshRsaPrivateCrtKey
 
getPrivateExponent() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPrivateCrtKey
 
getPrivateExponent() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPrivateKey
 
getPrivateExponent() - Method in interface com.sshtools.ssh.components.SshRsaPrivateKey
 
getPrivateKey() - Method in class com.sshtools.ssh.components.SshKeyPair
Get the private key.
getPrivateKey() - Method in class com.sshtools.ssh.PublicKeyAuthentication
Get the private key for this authentication.
getPrivateKey() - Method in class com.sshtools.ssh2.Ssh2HostbasedAuthentication
Get the private key used for this authentication
getProduct() - Method in class com.sshtools.ssh.SshConnector
 
getPrompt() - Method in class com.sshtools.ssh2.KBIPrompt
Get the prompt message to display to the user
getProvider() - Method in class com.sshtools.ssh.components.jce.AbstractDigest
 
getProvider() - Method in class com.sshtools.ssh.components.jce.AbstractHmac
 
getProvider() - Method in class com.sshtools.ssh.components.jce.AbstractJCECipher
 
getProvider() - Method in interface com.sshtools.ssh.components.jce.AbstractKeyExchange
 
getProvider() - Method in interface com.sshtools.ssh.components.jce.AbstractPublicKey
 
getProvider() - Method in class com.sshtools.ssh.components.jce.DiffieHellmanGroup14Sha1
 
getProvider() - Method in class com.sshtools.ssh.components.jce.DiffieHellmanGroup1Sha1
 
getProvider() - Method in class com.sshtools.ssh.components.jce.DiffieHellmanGroupExchangeSha1
 
getProvider() - Method in class com.sshtools.ssh2.TransportProtocol
 
getProviderForAlgorithm(String) - Static method in class com.sshtools.ssh.components.jce.JCEComponentManager
Get the provider for a specific algorithm.
getProviderForAlgorithm(String) - Static method in class com.sshtools.ssh.components.jce.JCEProvider
Get the provider for a specific algorithm.
getPublicExponent() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPrivateCrtKey
 
getPublicExponent() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPublicKey
 
getPublicExponent() - Method in interface com.sshtools.ssh.components.SshRsaPrivateCrtKey
 
getPublicExponent() - Method in interface com.sshtools.ssh.components.SshRsaPublicKey
 
getPublicKey() - Method in class com.sshtools.ssh.components.jce.Ssh2DsaPrivateKey
 
getPublicKey() - Method in interface com.sshtools.ssh.components.SshDsaPrivateKey
 
getPublicKey() - Method in class com.sshtools.ssh.components.SshKeyPair
Get the public key.
getPublicKey() - Method in class com.sshtools.ssh.PublicKeyAuthentication
Get the public key for this authentication.
getPublicKey() - Method in class com.sshtools.ssh2.Ssh2HostbasedAuthentication
Set the public key used for this authentication
getPublicKeys() - Method in class com.sshtools.ssh2.Ssh2Context
Get the ciphers for the Server->Client stream.
getQ() - Method in class com.sshtools.ssh.components.jce.Ssh2DsaPublicKey
 
getQ() - Method in interface com.sshtools.ssh.components.SshDsaPublicKey
 
getRealException() - Method in exception com.sshtools.ssh.SshIOException
Get the real exception
getReason() - Method in class com.sshtools.net.HttpResponse
 
getReason() - Method in exception com.sshtools.ssh.ChannelOpenException
 
getReason() - Method in exception com.sshtools.ssh.SshException
Get the reason for the exception
getRemoteForwardings() - Method in class com.sshtools.net.ForwardingClient
Returns the currently active remote forwarding listeners.
getRemoteForwardingTunnels() - Method in class com.sshtools.net.ForwardingClient
Get all the active remote forwarding tunnels
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.
getRemoteIdentification() - Method in interface com.sshtools.ssh.SshClient
Returns the identification string supplied by the server during protocol negotiation.
getRemoteIdentification() - Method in class com.sshtools.ssh2.Ssh2Client
 
getRemoteIdentification() - Method in class com.sshtools.ssh2.TransportProtocol
Get the identification string sent by the server during protocol negotiation
getResponse() - Method in class com.sshtools.ssh2.KBIPrompt
Get the user's response for this prompt.
getResult() - Method in class com.sshtools.ssh2.AuthenticationResult
Get the result of this authentication.
getRND() - Method in class com.sshtools.ssh.components.ComponentManager
Get the secure random number generator.
getRND() - Method in class com.sshtools.ssh.components.jce.JCEComponentManager
 
getSafePrime(UnsignedInteger32) - Static method in class com.sshtools.ssh.components.DiffieHellmanGroups
get the biggest safe prime from the list that is <= maximumSize
getSecret() - Method in class com.sshtools.ssh.components.SshKeyExchangeClient
Get the secret value produced during key exchange.
getSecureRandom() - Static method in class com.sshtools.ssh.components.jce.JCEComponentManager
Get the secure random implementation for the API.
getSecureRandom() - Static method in class com.sshtools.ssh.components.jce.JCEProvider
Get the secure random implementation for the API.
getSecureRandomAlgorithm() - Static method in class com.sshtools.ssh.components.jce.JCEComponentManager
Get the algorithm used for secure random number generation.
getSecureRandomAlgorithm() - Static method in class com.sshtools.ssh.components.jce.JCEProvider
Get the algorithm used for secure random number generation.
getServerVersion() - Method in class com.sshtools.sftp.SftpSubsystemChannel
Version 4 of the SFTP protocol allows the server to return its maximum supported version instead of the actual version to be used.
getSessionIdentifier() - Method in class com.sshtools.ssh2.AuthenticationProtocol
 
getSessionIdentifier() - Method in class com.sshtools.ssh2.TransportProtocol
Get the session identifier
getSFTPChannel() - Method in class com.sshtools.sftp.SftpFile
Get the SFTP subsystem channel that created this file object.
getSFTPProvider() - Method in interface com.sshtools.ssh.SshContext
Get the path to the SFTP provider.
getSFTPProvider() - Method in class com.sshtools.ssh2.Ssh2Context
 
getSignature() - Method in class com.sshtools.ssh.components.SshKeyExchangeClient
Get the signature produced during key exchange.
getSize() - Method in class com.sshtools.sftp.SftpFileAttributes
Get the size of the file.
getSocketTimeout() - Method in class com.sshtools.ssh2.Ssh2Context
 
getSoTimeout() - Method in class com.sshtools.net.SocketWrapper
 
getSoTimeout() - Method in interface com.sshtools.ssh.SocketTimeoutSupport
Get the current socket timeout in milliseconds.
getSource() - Method in class com.sshtools.events.EventObject
The object on which the Event initially occurred.
getStartLine() - Method in class com.sshtools.net.HttpHeader
 
getState() - Method in class com.sshtools.events.Event
Get the event state.
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
getStatusText(int) - Static method in exception com.sshtools.sftp.SftpStatusException
Convert a SSH_FXP_STATUS code into a readable string
getStderrInputStream() - Method in interface com.sshtools.ssh.SshSession
Get an InputStream to read the process stderr.
getStderrInputStream() - Method in class com.sshtools.ssh2.Ssh2Session
 
getStickyMessageIds() - Method in class com.sshtools.ssh.message.SshAbstractChannel
 
getStickyMessageIds() - Method in class com.sshtools.ssh2.Ssh2Channel
 
getSubsystemChannel() - Method in class com.sshtools.sftp.SftpClient
Returns the instance of the SftpSubsystemChannel used by this class
getSymbolicLinkTarget(String) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Get the target path of a symbolic link.
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
getTransport() - Method in interface com.sshtools.ssh.SshTunnel
The connection being forwarded (local forwarding) or the destination of the forwarding (remote forwarding).
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.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
getUsername() - Method in class com.sshtools.ssh.PasswordAuthentication
Get the username.
getUsername() - Method in class com.sshtools.ssh.PublicKeyAuthentication
 
getUsername() - Method in interface com.sshtools.ssh.SshAuthentication
Get the username for this authentication attempt.
getUsername() - Method in interface com.sshtools.ssh.SshClient
Return the username used for this connection
getUsername() - Method in class com.sshtools.ssh2.KBIAuthentication
 
getUsername() - Method in class com.sshtools.ssh2.Ssh2Client
 
getUsername() - Method in class com.sshtools.ssh2.Ssh2HostbasedAuthentication
 
getVersion() - Method in class com.sshtools.net.HttpResponse
 
getVersion() - Method in class com.sshtools.sftp.SftpSubsystemChannel
When called after the initialize method this will return the version in operation for this sftp session.
getVersion() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPublicKey
 
getVersion() - Method in interface com.sshtools.ssh.components.SshRsaPublicKey
 
getVersion() - Method in interface com.sshtools.ssh.SshClient
Returns the version for this client.
getVersion() - Method in class com.sshtools.ssh2.Ssh2Client
 
getWho() - Method in class com.sshtools.sftp.ACL
 
getX() - Method in class com.sshtools.ssh.components.jce.Ssh2DsaPrivateKey
 
getX() - Method in interface com.sshtools.ssh.components.SshDsaPrivateKey
 
getX11AuthenticationCookie() - Method in interface com.sshtools.ssh.SshContext
Get a fake random cookie for X11 authentication
getX11AuthenticationCookie() - Method in class com.sshtools.ssh2.Ssh2Context
 
getX11Display() - Method in interface com.sshtools.ssh.SshContext
Get the currently configured XDisplay setting which will be null if no display is currently set.
getX11Display() - Method in class com.sshtools.ssh2.Ssh2Context
 
getX11ForwardingTunnels() - Method in class com.sshtools.net.ForwardingClient
Get the active X11 forwarding channels.
getX11RealCookie() - Method in interface com.sshtools.ssh.SshContext
Get the real X11 authentication cookie, if not cookie has been set the fake cookie will be returned.
getX11RealCookie() - Method in class com.sshtools.ssh2.Ssh2Context
 
getX11RequestListener() - Method in interface com.sshtools.ssh.SshContext
Get the X11 forwarding request listener.
getX11RequestListener() - Method in class com.sshtools.ssh2.Ssh2Context
 
getY() - Method in class com.sshtools.ssh.components.jce.Ssh2DsaPublicKey
 
getY() - Method in interface com.sshtools.ssh.components.SshDsaPublicKey
 
GlobalRequest - Class in com.sshtools.ssh2
This class represents a global request.
GlobalRequest(String, byte[]) - Constructor for class com.sshtools.ssh2.GlobalRequest
Contstruct a request.
GlobalRequestHandler - Interface in com.sshtools.ssh2
There are several kinds of requests that affect the state of the remote end "globally", independent of any channels, this interface defines the contract for handling such global requests.
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
 
group1 - Static variable in class com.sshtools.ssh.components.DiffieHellmanGroups
 
group14 - Static variable in class com.sshtools.ssh.components.DiffieHellmanGroups
 
group15 - Static variable in class com.sshtools.ssh.components.DiffieHellmanGroups
 
group16 - Static variable in class com.sshtools.ssh.components.DiffieHellmanGroups
 
group17 - Static variable in class com.sshtools.ssh.components.DiffieHellmanGroups
 
group18 - Static variable in class com.sshtools.ssh.components.DiffieHellmanGroups
 
group5 - Static variable in class com.sshtools.ssh.components.DiffieHellmanGroups
 

H

hasBinary() - Method in class com.sshtools.util.EOLProcessor
Check to see if binary data was encountered during the encoding process
hasBinary() - Method in class com.sshtools.util.TextConversionStream
Check to see if binary data was encountered during the encoding process
hasExitSignal() - Method in class com.sshtools.ssh2.Ssh2Session
Determine whether the remote process was signalled.
hasGID() - Method in class com.sshtools.sftp.SftpFileAttributes
 
hashCode() - Method in class com.sshtools.sftp.SftpFile
 
hashCode() - Method in class com.sshtools.ssh.components.jce.Ssh2DsaPublicKey
 
hashCode() - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPublicKey
 
hashCode() - Method in class com.sshtools.util.UnsignedInteger32
Returns the objects hash code.
hashCode() - Method in class com.sshtools.util.UnsignedInteger64
Return the objects hash code.
hasLocalForwarding(String, int) - Method in class com.sshtools.net.ForwardingClient
 
hasMessage(MessageObserver) - Method in interface com.sshtools.ssh.message.MessageStore
 
hasMessage(MessageObserver) - Method in class com.sshtools.ssh.message.SshMessageStore
 
hasMoreData() - Method in class com.sshtools.util.SimpleASNReader
 
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 *
HMAC_MD5 - Static variable in class com.sshtools.ssh2.Ssh2Context
MD5 message authentication
HMAC_MD5_96 - Static variable in class com.sshtools.ssh2.Ssh2Context
MD5 96 bit message authentication
HMAC_SHA1 - Static variable in class com.sshtools.ssh2.Ssh2Context
SHA1 message authentication
HMAC_SHA1_96 - Static variable in class com.sshtools.ssh2.Ssh2Context
SHA1 96 bit message authentication
HMAC_SHA256 - Static variable in class com.sshtools.ssh2.Ssh2Context
 
HmacMD5 - Class in com.sshtools.ssh.components.jce
MD5 message authentication implementation.
HmacMD5() - Constructor for class com.sshtools.ssh.components.jce.HmacMD5
 
HmacMD596 - Class in com.sshtools.ssh.components.jce
MD5 message authentication implementation.
HmacMD596() - Constructor for class com.sshtools.ssh.components.jce.HmacMD596
 
HmacSha1 - Class in com.sshtools.ssh.components.jce
SHA-1 message authentication implementation.
HmacSha1() - Constructor for class com.sshtools.ssh.components.jce.HmacSha1
 
HmacSha196 - Class in com.sshtools.ssh.components.jce
SHA-1 message authentication implementation.
HmacSha196() - Constructor for class com.sshtools.ssh.components.jce.HmacSha196
 
HmacSha256 - Class in com.sshtools.ssh.components.jce
SHA-1 message authentication implementation.
HmacSha256() - Constructor for class com.sshtools.ssh.components.jce.HmacSha256
 
HmacSha512 - Class in com.sshtools.ssh.components.jce
SHA-1 message authentication implementation.
HmacSha512() - Constructor for class com.sshtools.ssh.components.jce.HmacSha512
 
HOST_KEY_NOT_VERIFIABLE - Static variable in class com.sshtools.ssh2.TransportProtocol
Disconnect reason: The host key supplied could not be verified
HOST_NOT_ALLOWED - Static variable in class com.sshtools.ssh2.TransportProtocol
Disconnect reason: The host is not allowed
hostKey - Variable in class com.sshtools.ssh.components.SshKeyExchangeClient
The server's host key.
HostKeyVerification - Interface in com.sshtools.ssh
This interface provides a callback method so that the user can verify the identity of the server (by checking the public key) during the initial protocol negotiation.
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

ICANON - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Canonicalize input lines.
ICRNL - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Map CR to NL on input.
idle() - Method in class com.sshtools.ssh.message.SshAbstractChannel
 
idle() - Method in class com.sshtools.ssh2.Ssh2Channel
 
IEXTEN - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Enable extensions.
IGNCR - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Ignore CR on input.
IGNPAR - Static variable in class com.sshtools.ssh.PseudoTerminalModes
The ignore parity flag.
ILLEGAL_USER_NAME - Static variable in class com.sshtools.ssh2.TransportProtocol
Disconnect reason: The user's name is illegal
IMAXBEL - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Ring bell on input queue full.
in - Variable in class com.sshtools.scp.ScpClientIO.ScpEngineIO
 
in - Variable in class com.sshtools.util.DynamicBuffer
This buffers InputStream
incomingtunnels - Variable in class com.sshtools.net.ForwardingClient
 
INFLATER - Static variable in interface com.sshtools.ssh.compression.SshCompression
Inflation mode
info(Object, String) - Static method in class com.sshtools.logging.Log
A normal log event
init() - Method in class com.sshtools.ssh.components.ComponentManager
 
init(byte[]) - Method in class com.sshtools.ssh.components.jce.AbstractHmac
 
init(int, byte[], byte[]) - Method in class com.sshtools.ssh.components.jce.AbstractJCECipher
 
init(int, byte[], byte[]) - Method in class com.sshtools.ssh.components.jce.ArcFour
 
init(int, byte[], byte[]) - Method in class com.sshtools.ssh.components.jce.ArcFour128
 
init(int, byte[], byte[]) - Method in class com.sshtools.ssh.components.jce.ArcFour256
 
init(byte[]) - Method in class com.sshtools.ssh.components.jce.HmacSha1
 
init(byte[]) - Method in class com.sshtools.ssh.components.jce.HmacSha196
 
init(byte[]) - Method in class com.sshtools.ssh.components.jce.HmacSha256
 
init(byte[]) - Method in class com.sshtools.ssh.components.jce.HmacSha512
 
init(byte[], int, int) - Method in class com.sshtools.ssh.components.jce.Ssh2DsaPublicKey
Initialize the public key from a blob of binary data.
init(byte[], int, int) - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPublicKey
 
init(byte[], int, int) - Method in class com.sshtools.ssh.components.jce.SshX509DsaPublicKey
Initialize the public key from a blob of binary data.
init(byte[], int, int) - Method in class com.sshtools.ssh.components.jce.SshX509RsaPublicKey
Initialize the public key from a blob of binary data.
init(byte[], int, int) - Method in class com.sshtools.ssh.components.jce.SshX509RsaSha1PublicKey
Initialize the public key from a blob of binary data.
init(int, byte[], byte[]) - Method in class com.sshtools.ssh.components.NoneCipher
Initialize the cipher with up to 40 bytes of iv and key data.
init(byte[]) - Method in class com.sshtools.ssh.components.NoneHmac
 
init(int, byte[], byte[]) - Method in class com.sshtools.ssh.components.SshCipher
Initialize the cipher with up to 40 bytes of iv and key data.
init(byte[]) - Method in interface com.sshtools.ssh.components.SshHmac
 
init(TransportProtocol, boolean) - Method in class com.sshtools.ssh.components.SshKeyExchangeClient
Initialize the key exchange.
init(byte[], int, int) - Method in interface com.sshtools.ssh.components.SshPublicKey
Initialize the public key from a blob of binary data.
init(int, int) - Method in interface com.sshtools.ssh.compression.SshCompression
Initialize the compression.
init(SshMessageRouter, int) - Method in class com.sshtools.ssh.message.SshAbstractChannel
 
init(int, int) - Method in class com.sshtools.zlib.ZLibCompression
 
initException - Static variable in class com.sshtools.ssh.SshConnector
 
initialize() - Method in class com.sshtools.sftp.SftpSubsystemChannel
Initializes the sftp subsystem and negotiates a version with the server.
initializeDefaultProvider(Provider) - Static method in class com.sshtools.ssh.components.jce.JCEComponentManager
Initialize the default JCE provider used by the API.
initializeDefaultProvider(Provider) - Static method in class com.sshtools.ssh.components.jce.JCEProvider
Initialize the default JCE provider used by the API.
initializeDigestFactory(ComponentFactory) - Method in class com.sshtools.ssh.components.ComponentManager
Initialize the digest factory.
initializeDigestFactory(ComponentFactory) - Method in class com.sshtools.ssh.components.jce.JCEComponentManager
 
initializeHmacFactory(ComponentFactory) - Method in class com.sshtools.ssh.components.ComponentManager
Initialize the SSH2 HMAC factory.
initializeHmacFactory(ComponentFactory) - Method in class com.sshtools.ssh.components.jce.JCEComponentManager
 
initializeKeyExchangeFactory(ComponentFactory) - Method in class com.sshtools.ssh.components.ComponentManager
Initialize the SSH2 key exchange factory.
initializeKeyExchangeFactory(ComponentFactory) - Method in class com.sshtools.ssh.components.jce.JCEComponentManager
 
initializeProviderForAlgorithm(String, Provider) - Static method in class com.sshtools.ssh.components.jce.JCEComponentManager
Initialize a provider for a specific algorithm.
initializeProviderForAlgorithm(String, Provider) - Static method in class com.sshtools.ssh.components.jce.JCEProvider
Initialize a provider for a specific algorithm.
initializePublicKeyFactory(ComponentFactory) - Method in class com.sshtools.ssh.components.ComponentManager
Initialize the public key factory.
initializePublicKeyFactory(ComponentFactory) - Method in class com.sshtools.ssh.components.jce.JCEComponentManager
 
initializeSsh2CipherFactory(ComponentFactory) - Method in class com.sshtools.ssh.components.ComponentManager
Initialize the SSH2 cipher factory.
initializeSsh2CipherFactory(ComponentFactory) - Method in class com.sshtools.ssh.components.jce.JCEComponentManager
 
initializeTunnel(SshTunnel) - Method in class com.sshtools.net.ForwardingClient.ForwardingListener
 
initializeTunnel(SshTunnel) - Method in interface com.sshtools.ssh.ForwardingRequestListener
Called once a connection has been established and a forwarding channel is about to be opened.
INLCR - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Map NL into CR on input.
INPCK - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Enable checking of parity errors.
INTERNAL_ERROR - Static variable in exception com.sshtools.ssh.SshException
An internal error occurred within the API; in all cases contact sshtools.com support with the details of this error and the state of the connection when receiving this exception is unknown.
intValue() - Method in class com.sshtools.util.UnsignedInteger32
Returns the long value of the unsigned integer cast to an int
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
 
IOStreamConnector - Class in com.sshtools.util
Connects an input stream to an outputstream.
IOStreamConnector() - Constructor for class com.sshtools.util.IOStreamConnector
Creates a new IOStreamConnector object.
IOStreamConnector(InputStream, OutputStream) - Constructor for class com.sshtools.util.IOStreamConnector
Creates a new IOStreamConnector object.
IOStreamConnector.IOStreamConnectorListener - Interface in com.sshtools.util
 
IOUtil - Class in com.sshtools.util
 
IOUtil() - Constructor for class com.sshtools.util.IOUtil
 
isAuthenticated() - Method in interface com.sshtools.ssh.SshClient
Evaluate whether the user has been authenticated.
isAuthenticated() - Method in class com.sshtools.ssh2.AuthenticationProtocol
Determine whether the protocol has made a sucessfull authentication attempt.
isAuthenticated() - Method in class com.sshtools.ssh2.Ssh2Client
 
isAuthenticating() - Method in class com.sshtools.ssh.PublicKeyAuthentication
Is the authentication attempt actually going to perform an authentication or are we simply just checking the suitability of a public key.
isBlock() - Method in class com.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.
isBlockingThread(Thread) - Method in class com.sshtools.ssh.message.SshMessageRouter
 
isBlockOwner(Thread) - Method in class com.sshtools.ssh.message.ThreadSynchronizer
 
isBuffered() - Method in class com.sshtools.ssh.message.SshMessageRouter
 
isBuffered() - Method in interface com.sshtools.ssh.SshClient
Identifies whether this client is in buffered mode
isBuffered() - Method in class com.sshtools.ssh2.Ssh2Client
 
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.SftpClient
Returns the state of the SFTP client.
isClosed() - Method in class com.sshtools.ssh.message.SshAbstractChannel
 
isClosed() - Method in class com.sshtools.ssh.message.SshMessageStore
 
isClosed() - Method in interface com.sshtools.ssh.SshChannel
Evaluate whether the channel is closed.
isClosed() - Method in interface com.sshtools.ssh.SshSession
Evaluate whether the channel is closed.
isClosed() - Method in class com.sshtools.ssh.SubsystemChannel
Is the subsystem closed?
isClosed() - Method in class com.sshtools.util.IOStreamConnector
 
isConnected() - Method in interface com.sshtools.ssh.message.SshMessageReader
 
isConnected() - Method in interface com.sshtools.ssh.SshClient
Evaluate whether the connection is still alive.
isConnected() - Method in class com.sshtools.ssh2.Ssh2Client
 
isConnected() - Method in class com.sshtools.ssh2.TransportProtocol
Returns the connected state
isDebugEnabled() - Static method in class com.sshtools.logging.Log
 
isDHGroupExchangeBackwardsCompatible() - Method in class com.sshtools.ssh2.Ssh2Context
 
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.SftpClient
Determine whether the file object is pointing to a symbolic link that is pointing to a directory.
isEnabled() - Static method in class com.sshtools.logging.LoggerFactory
 
isEnableNoneCipher() - Static method in class com.sshtools.ssh.components.ComponentManager
 
isEnableNoneMac() - Static method in class com.sshtools.ssh.components.ComponentManager
 
isErrorEnabled() - Static method in class com.sshtools.logging.Log
 
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.
isFlowControlEnabled() - Method in class com.sshtools.ssh2.Ssh2Session
On many systems it is possible to determine whether a pseudo-terminal is using control-S/ control-Q flow control.
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.
ISIG - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Enable signals INTR, QUIT, [D]SUSP.
isInfoEnabled() - Static method in class com.sshtools.logging.Log
 
isKeyExchangeMessage(int) - Method in class com.sshtools.ssh.components.jce.DiffieHellmanGroup14Sha1
 
isKeyExchangeMessage(int) - Method in class com.sshtools.ssh.components.jce.DiffieHellmanGroup1Sha1
 
isKeyExchangeMessage(int) - Method in class com.sshtools.ssh.components.jce.DiffieHellmanGroupExchangeSha1
 
isKeyExchangeMessage(int) - Method in class com.sshtools.ssh.components.SshKeyExchangeClient
 
isKeyReExchangeDisabled() - Method in class com.sshtools.ssh2.Ssh2Context
 
isLevelEnabled(LoggerLevel) - Method in interface com.sshtools.logging.Logger
 
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.
isListening() - Method in class com.sshtools.net.ForwardingClient.SocketListener
 
isLocal() - Method in interface com.sshtools.ssh.SshTunnel
Determines the type of forwarding channel.
isLocalEOF() - Method in interface com.sshtools.ssh.SshTunnel
 
isOpen() - Method in class com.sshtools.sftp.SftpFile
Determine whether the file is open.
isPassphraseProtected() - Method in interface com.sshtools.publickey.SshPrivateKeyFile
Determine if the private key file is protected by a passphrase.
isRemoteEOF() - Method in interface com.sshtools.ssh.SshTunnel
 
isRunning() - Method in class com.sshtools.net.ForwardingClient.SocketListener
 
isSendIgnorePacketOnIdle() - Method in class com.sshtools.ssh2.Ssh2Context
 
isSendKeepAliveOnIdle() - Method in class com.sshtools.ssh2.Ssh2Channel
 
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.
ISTRIP - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Strip 8th bit off characters.
isX11() - Method in interface com.sshtools.ssh.SshTunnel
Determine if this channel is an X11 forwarding channel.
isXForwarding() - Method in class com.sshtools.net.ForwardingClient
Is X forwarding currently active?
IUCLC - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Translate uppercase characters to lowercase.
IXANY - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Any char will restart after stop.
IXOFF - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Enable input flow control.
IXON - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Enable output flow control.

J

J2SSHEventCodes - Class in com.sshtools.events
List of unique J2SSH Event codes
J2SSHEventCodes() - Constructor for class com.sshtools.events.J2SSHEventCodes
 
J2SSHEventMessages - Class in com.sshtools.events
Time saving class for the LoggingMaverickListener class that sets the message code for each event to its event code field name.
J2SSHEventMessages() - Constructor for class com.sshtools.events.J2SSHEventMessages
 
JCE_3DESCBCNOPADDING - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
3DES in CBC mode 'DESede/CTR/NoPadding'
JCE_3DESCTRNOPADDING - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
3DES in counter clock mode 'DESede/CTR/NoPadding'
JCE_AESCBCNOPADDING - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
AES encryption algorithm 'AES/CBC/NoPadding'
JCE_AESCTRNOPADDING - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
AES in counter clock mode 'AES/CTR/NoPadding'
JCE_ARCFOUR - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
ARCFOUR cipher
JCE_BLOWFISHCBCNOPADDING - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
Blowfish encryption algorithm 'Blowfish/CBC/NoPadding'
JCE_DESCBCNOPADDING - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
DES encrpytion algorithm 'DES/CBC/NoPadding'
JCE_DH - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
Diffie Hellman key agreement algorithm 'DH'
JCE_DSA - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
DSA public key algorithm 'DSA'
JCE_ERROR - Static variable in exception com.sshtools.ssh.SshException
An error occurred in the JCE; typically this would result from Maverick attempting to use an algorithm that the JCE does not support.
JCE_HMACMD5 - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
MD5 message authentication code algorithm 'HmacMD5'
JCE_HMACSHA1 - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
SHA1 message authentication code algorithm 'HmacSha1'
JCE_HMACSHA256 - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
SHA 256 bit message authentication code algorithm 'HmacSha256'
JCE_HMACSHA512 - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
SHA 512 bit message authentication code algorithm 'HmacSha256'
JCE_MD5 - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
MD5 digest algorithm 'MD5'
JCE_MD5WithRSA - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
RSA signature algorithm 'SHA1WithRSA'
JCE_RSA - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
RSA public key algorithm 'RSA'
JCE_RSANONEPKCS1PADDING - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
RSA encryption algorithm 'RSA/NONE/PKCS1Padding'
JCE_SHA1 - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
SHA1 digest algorithm 'SHA-1'
JCE_SHA1PRNG - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
Secure random algorithm 'Sha1PRNG'
JCE_SHA1WithDSA - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
DSA signature algorithm 'SHA1WithDSA'
JCE_SHA1WithRSA - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
RSA signature algorithm 'SHA1WithRSA'
JCE_SHA256 - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
SHA256 digest algorithm 'SHA-256'
JCE_X509 - Static variable in interface com.sshtools.ssh.components.jce.JCEAlgorithms
X509 certificate algorithm 'X.509'
jceAlgorithm - Variable in class com.sshtools.ssh.components.jce.AbstractHmac
 
JCEAlgorithms - Interface in com.sshtools.ssh.components.jce
Interface containing the JCE algorithms required by the API.
JCEComponentManager - Class in com.sshtools.ssh.components.jce
A component manager for the Java runtime JCE provider.
JCEComponentManager() - Constructor for class com.sshtools.ssh.components.jce.JCEComponentManager
 
JCEProvider - Class in com.sshtools.ssh.components.jce
 
JCEProvider() - Constructor for class com.sshtools.ssh.components.jce.JCEProvider
 

K

KBIAuthentication - Class in com.sshtools.ssh2
keyboard-interactive authentication implementation as specified in draft-ietf-secsh-auth-kbdinteract-04.txt.
KBIAuthentication() - Constructor for class com.sshtools.ssh2.KBIAuthentication
 
KBIPrompt - Class in com.sshtools.ssh2
Represents a single prompt in the keyboard-interactive authentication process
KBIPrompt(String, boolean) - Constructor for class com.sshtools.ssh2.KBIPrompt
Creates a new KBIPrompt object.
KBIRequestHandler - Interface in com.sshtools.ssh2
Callback interface used by the KBIAuthentication authentication mechanism.
KEX_DIFFIE_HELLMAN_GROUP14_SHA1 - Static variable in class com.sshtools.ssh2.Ssh2Context
 
KEX_DIFFIE_HELLMAN_GROUP1_SHA1 - Static variable in class com.sshtools.ssh2.Ssh2Context
The required key exchange method
KEX_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA1 - Static variable in class com.sshtools.ssh2.Ssh2Context
Optional key exchange mechanism in which the server maintains a list of acceptable generators and primes
KEX_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA256 - Static variable in class com.sshtools.ssh2.Ssh2Context
 
KEY_EXCHANGE_FAILED - Static variable in exception com.sshtools.ssh.SshException
The protocol failed to negotiate a transport algorithm or failed to verify the host key of the remote host.
KEY_EXCHANGE_FAILED - Static variable in class com.sshtools.ssh2.TransportProtocol
Disconnect reason: Key exchange failed
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.
LICENSE_ERROR - Static variable in exception com.sshtools.ssh.SshException
The API is not licensed!
list() - Method in class com.sshtools.publickey.PublicKeySubsystem
List all of the users acceptable keys.
list(String) - Method in class com.sshtools.ssh.components.ComponentFactory
List the types of components supported by this factory.
listChildren(SftpFile, Vector<SftpFile>) - Method in class com.sshtools.sftp.SftpSubsystemChannel
List the children of a directory.
listenerList - Variable in class com.sshtools.util.IOStreamConnector
 
LOCAL_FORWARDING - Static variable in interface com.sshtools.net.ForwardingClientListener
Constant used to specify whether the event relates to a local forwarding
lockComponents() - Method in class com.sshtools.ssh.components.ComponentFactory
 
Log - Class in com.sshtools.logging
This is a wrapper class.
Log() - Constructor for class com.sshtools.logging.Log
 
log(LoggerLevel, Object, String) - Method in interface com.sshtools.logging.Logger
 
log(LoggerLevel, Object, String, Throwable) - Method in interface com.sshtools.logging.Logger
 
Logger - Interface in com.sshtools.logging
 
LoggerFactory - Class in com.sshtools.logging
 
LoggerFactory() - Constructor for class com.sshtools.logging.LoggerFactory
 
LoggerLevel - Enum in com.sshtools.logging
 
longValue() - Method in class com.sshtools.util.UnsignedInteger32
Returns the long value of this unsigned integer.
longValue() - Method in class com.sshtools.util.UnsignedInteger64
Return a long value of the unsigned integer.
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

mac - Variable in class com.sshtools.ssh.components.jce.AbstractHmac
 
MAC_ERROR - Static variable in class com.sshtools.ssh2.TransportProtocol
Disconnect reason: An error occurred verifying the MAC
macLength - Variable in class com.sshtools.ssh.components.jce.AbstractHmac
 
macSize - Variable in class com.sshtools.ssh.components.jce.AbstractHmac
 
main(String[]) - Static method in class com.sshtools.util.TextConversionStream
 
makeDirectory(String) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Make a directory.
makeDirectory(String, SftpFileAttributes) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Make a directory.
manager - Variable in class com.sshtools.ssh.message.SshAbstractChannel
 
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
matchRemoteFiles(String) - Method in class com.sshtools.sftp.SftpClient
Called by getFileMatches() to do regular expression pattern matching on the files in 'remote''s parent directory.
MaverickCallbackHandler - Interface in com.sshtools.ssh2
 
MAX_VALUE - Static variable in class com.sshtools.util.UnsignedInteger32
The maximum value of a 32bit unsigned integer
MAX_VALUE - Static variable in class com.sshtools.util.UnsignedInteger64
 
MAX_VERSION - Static variable in class com.sshtools.sftp.SftpSubsystemChannel
 
maximumChannels() - Method in class com.sshtools.ssh.message.SshMessageRouter
 
MD5_FINGERPRINT - Static variable in class com.sshtools.ssh.SshKeyFingerprint
 
MD5Digest - Class in com.sshtools.ssh.components.jce
MD5 digest implementation.
MD5Digest() - Constructor for class com.sshtools.ssh.components.jce.MD5Digest
 
Message - Interface in com.sshtools.ssh.message
 
MESSAGE_TIMEOUT - Static variable in exception com.sshtools.ssh.SshException
An expected message was not received before the specified timeout period.
messageAttributes - Static variable in class com.sshtools.events.J2SSHEventMessages
 
messageCodes - Static variable in class com.sshtools.events.J2SSHEventMessages
 
MessageHolder - Class in com.sshtools.ssh.message
 
MessageHolder() - Constructor for class com.sshtools.ssh.message.MessageHolder
 
MessageObserver - Interface in com.sshtools.ssh.message
 
MessageStore - Interface in com.sshtools.ssh.message
 
MIN_VALUE - Static variable in class com.sshtools.util.UnsignedInteger32
The minimum value of a 32bit unsigned integer
MIN_VALUE - Static variable in class com.sshtools.util.UnsignedInteger64
 
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).
move(int) - Method in class com.sshtools.util.ByteArrayWriter
Move the position of the next byte to be written.
ms - Variable in class com.sshtools.ssh.message.SshAbstractChannel
 
msg - Variable in class com.sshtools.ssh.message.MessageHolder
 

N

NEGOTIATING_PROTOCOL - Static variable in class com.sshtools.ssh2.TransportProtocol
Protocol state: Negotation of the protocol version
nextBytes(byte[]) - Method in class com.sshtools.ssh.components.jce.SecureRND
 
nextBytes(byte[], int, int) - Method in class com.sshtools.ssh.components.jce.SecureRND
 
nextBytes(byte[]) - Method in interface com.sshtools.ssh.components.SshSecureRandomGenerator
 
nextBytes(byte[], int, int) - Method in interface com.sshtools.ssh.components.SshSecureRandomGenerator
 
nextInt() - Method in class com.sshtools.ssh.components.jce.SecureRND
 
nextInt() - Method in interface com.sshtools.ssh.components.SshSecureRandomGenerator
 
nextMessage() - Method in interface com.sshtools.ssh.message.SshMessageReader
 
nextMessage(SshAbstractChannel, MessageObserver, long) - Method in class com.sshtools.ssh.message.SshMessageRouter
 
nextMessage(MessageObserver, long) - Method in class com.sshtools.ssh.message.SshMessageStore
 
nextMessage() - Method in class com.sshtools.ssh.SubsystemChannel
Read a subsystem message from the channel inputstream.
nextMessage() - Method in class com.sshtools.ssh2.TransportProtocol
Get the next message.
NO_MESSAGES - Static variable in class com.sshtools.ssh.message.SshMessageStore
 
NO_MORE_AUTH_METHODS_AVAILABLE - Static variable in class com.sshtools.ssh2.TransportProtocol
Disconnect reason: No more authentication methods are available
NOFLSH - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Don't flush after interrupt.
NoneCipher - Class in com.sshtools.ssh.components
This special cipher implementation provides an unencrypted connection.
NoneCipher() - Constructor for class com.sshtools.ssh.components.NoneCipher
 
NoneHmac - Class in com.sshtools.ssh.components
 
NoneHmac() - Constructor for class com.sshtools.ssh.components.NoneHmac
 
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

OCRNL - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Translate carriage return to newline (output).
OLCUC - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Convert lowercase to uppercase.
onDisconnect(String, int) - Method in interface com.sshtools.ssh2.TransportProtocolListener
 
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.
onIdle(long) - Method in interface com.sshtools.ssh2.TransportProtocolListener
 
onInvalidHostEntry(String) - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification
 
onInvalidHostEntry(String) - Method in class com.sshtools.publickey.ConsoleKnownHostsKeyVerification
 
ONLCR - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Map NL to CR-NL.
ONLRET - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Newline performs a carriage return (output).
ONOCR - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Translate newline to carriage return-newline (output).
onThreadExit() - Method in class com.sshtools.ssh.message.SshMessageRouter
Called when the threaded router closes.
onUnknownHost(String, SshPublicKey) - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification
Called by the verifyHost method when the host key supplied is not recorded in the known_hosts file.
onUnknownHost(String, SshPublicKey) - Method in class com.sshtools.publickey.ConsoleKnownHostsKeyVerification
Prompts the user through the console to verify the host key.
open(int, long, int) - Method in class com.sshtools.ssh2.Ssh2Channel
Called once an SSH_MSG_CHANNEL_OPEN_CONFIRMATION has been sent.
open(int, long, int, byte[]) - Method in class com.sshtools.ssh2.Ssh2Channel
Once a SSH_MSG_CHANNEL_OPEN_CONFIRMATION message is received the framework calls this method to complete the channel open operation.
OPEN_APPEND - Static variable in class com.sshtools.sftp.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.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.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.SftpSubsystemChannel
File open flag, opens the file for reading.
OPEN_TEXT - Static variable in class com.sshtools.sftp.SftpSubsystemChannel
File open flag, causes the file to be opened in text mode.
OPEN_TRUNCATE - Static variable in class com.sshtools.sftp.SftpSubsystemChannel
File open flag, forces an existing file with the same name to be truncated to zero length when creating a file by specifying OPEN_CREATE.
OPEN_WRITE - Static variable in class com.sshtools.sftp.SftpSubsystemChannel
File open flag, opens the file for writing.
openChannel(Ssh2Channel, byte[]) - Method in class com.sshtools.ssh2.Ssh2Client
Additional method to open a custom SSH2 channel.
openChannel(SshAbstractChannel) - Method in class com.sshtools.ssh2.Ssh2Client
Additional method to open a custom SSH2 channel.
openDirectory(String) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Open a directory.
openFile(String) - Method in class com.sshtools.sftp.SftpClient
 
openFile(String, int) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Open a file.
openFile(String, int, SftpFileAttributes) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Open a file.
openForwardingChannel(String, int, String, int, String, int, SshTransport, ChannelEventListener) - Method in interface com.sshtools.ssh.SshClient
Open a TCPIP forwarding channel to the remote computer.
openForwardingChannel(String, int, String, int, String, int, SshTransport, ChannelEventListener) - Method in class com.sshtools.ssh2.Ssh2Client
 
openRemoteClient(String, int, String, SshConnector) - Method in interface com.sshtools.ssh.SshClient
Open up an SSH client from the remote machine to another remote server.
openRemoteClient(String, int, String) - Method in interface com.sshtools.ssh.SshClient
Open up an SSH client from the remote machine to another remote server.
openRemoteClient(String, int, String, SshConnector) - Method in class com.sshtools.ssh2.Ssh2Client
 
openRemoteClient(String, int, String) - Method in class com.sshtools.ssh2.Ssh2Client
 
openSessionChannel() - Method in interface com.sshtools.ssh.SshClient
Open a session on the remote computer.
openSessionChannel(ChannelEventListener) - Method in interface com.sshtools.ssh.SshClient
Open a session on the remote computer.
openSessionChannel() - Method in class com.sshtools.ssh2.Ssh2Client
 
openSessionChannel(long) - Method in class com.sshtools.ssh2.Ssh2Client
 
openSessionChannel(ChannelEventListener, long) - Method in class com.sshtools.ssh2.Ssh2Client
 
openSessionChannel(ChannelEventListener) - Method in class com.sshtools.ssh2.Ssh2Client
 
openSessionChannel(int, int, ChannelEventListener) - Method in class com.sshtools.ssh2.Ssh2Client
Additional method to open a session with SSH2 specific features.
openSessionChannel(int, int, ChannelEventListener, long) - Method in class com.sshtools.ssh2.Ssh2Client
 
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
 
OPOST - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Enable output processing.
order - Variable in class com.sshtools.ssh.components.ComponentFactory
 
out - Variable in class com.sshtools.scp.ScpClientIO.ScpEngineIO
 
out - Variable in class com.sshtools.util.DynamicBuffer
This buffers OutputStream
outgoingtunnels - Variable in class com.sshtools.net.ForwardingClient
 

P

Packet - Class in com.sshtools.ssh
A utility class that provides the SSH layers with the ability to dynamically write an SSH packet.
Packet() - Constructor for class com.sshtools.ssh.Packet
 
Packet(int) - Constructor for class com.sshtools.ssh.Packet
 
PARENB - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Parity enable.
PARMRK - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Mark parity and framing errors.
PARODD - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Odd parity, else even.
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
PasswordAuthentication - Class in com.sshtools.ssh
Basic password authentication class used for SSH password authentication.
PasswordAuthentication() - Constructor for class com.sshtools.ssh.PasswordAuthentication
 
PENDIN - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Retype pending input.
performClientExchange(String, String, byte[], byte[]) - Method in class com.sshtools.ssh.components.jce.DiffieHellmanGroup14Sha1
 
performClientExchange(String, String, byte[], byte[]) - Method in class com.sshtools.ssh.components.jce.DiffieHellmanGroup1Sha1
 
performClientExchange(String, String, byte[], byte[]) - Method in class com.sshtools.ssh.components.jce.DiffieHellmanGroupExchangeSha1
The client requests a modulus from the server indicating the pre- ferred size.
performClientExchange(String, String, byte[], byte[]) - Method in class com.sshtools.ssh.components.SshKeyExchangeClient
Override to perform the client side key exchange.
PERFORMING_KEYEXCHANGE - Static variable in class com.sshtools.ssh2.TransportProtocol
Protocol state: The protocol is performing key exchange
performOptimizedRead(byte[], long, int, OutputStream, int, FileTransferProgress) - Method in class com.sshtools.sftp.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.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.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.SftpSubsystemChannel
Performs an optimized write of a file through asynchronous messaging and through buffering the local file into memory.
performSynchronousRead(byte[], int, OutputStream, FileTransferProgress, long) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Perform a synchronous read of a file from the remote file system.
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
 
position() - Method in class com.sshtools.ssh.Packet
 
POSSIBLE_CORRUPT_FILE - Static variable in exception com.sshtools.ssh.SshException
An error occurred reading the contents of a file.
postReadRequest(byte[], long, int) - Method in class com.sshtools.sftp.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.SftpSubsystemChannel
Send a write request for an open file but do not wait for the response from the server.
processBytes(byte[], int, int) - Method in class com.sshtools.util.EOLProcessor
 
processChannelMessage(SshChannelMessage) - Method in class com.sshtools.ssh.message.SshAbstractChannel
 
processChannelMessage(SshChannelMessage) - Method in class com.sshtools.ssh2.Ssh2Channel
Processes channel request messages by passing the request through to channelRequest() .
processEvent(Event) - Method in interface com.sshtools.events.EventListener
Invoked when an event occurs.
processExtendedData(int, int, SshChannelMessage) - Method in class com.sshtools.ssh2.Ssh2Channel
Called when extended data arrives.
processExtendedData(int, int, SshChannelMessage) - Method in class com.sshtools.ssh2.Ssh2Session
 
processGlobalMessage(SshMessage) - Method in class com.sshtools.ssh.message.SshMessageRouter
Called by the message routing framework so that the routing implementation may process a global message.
processGlobalRequest(GlobalRequest) - Method in interface com.sshtools.ssh2.GlobalRequestHandler
Called when a supported global request has been recieved.
processHeaderFields(InputStream) - Method in class com.sshtools.net.HttpHeader
 
processMessage(byte[]) - Method in class com.sshtools.ssh2.TransportProtocol
Process a message.
processStandardData(int, SshChannelMessage) - Method in class com.sshtools.ssh2.Ssh2Channel
Called when channel data arrives, by default this method makes the data available in the channels InputStream.
processStandardData(byte[], int, int) - Method in class com.sshtools.ssh2.Ssh2Channel
 
progressed(long) - Method in interface com.sshtools.sftp.FileTransferProgress
The transfer has progressed
PROMPT_TIMEOUT - Static variable in exception com.sshtools.ssh.SshException
The Shell class failed to detect the prompt.
PROTOCOL_ERROR - Static variable in class com.sshtools.ssh2.TransportProtocol
Disconnect reason: A protocol error occurred
PROTOCOL_VERSION_NOT_SUPPORTED - Static variable in class com.sshtools.ssh2.TransportProtocol
Disconnect reason: The protocol version is not supported
PROTOCOL_VIOLATION - Static variable in exception com.sshtools.ssh.SshException
The SSH protocol was violated in some way by the remote host and the connection has been terminated.
prv - Variable in class com.sshtools.ssh.components.jce.Ssh2DsaPrivateKey
 
prv - Variable in class com.sshtools.ssh.components.jce.Ssh2RsaPrivateCrtKey
 
prv - Variable in class com.sshtools.ssh.components.jce.Ssh2RsaPrivateKey
 
PSEUDO_TTY_ERROR - Static variable in exception com.sshtools.ssh.SshException
A request was made to allocate a pseudo terminal, but this request failed.
PseudoTerminalModes - Class in com.sshtools.ssh
When a client requests a pseudo terminal it informs the server of any terminal modes that it knows of.
PseudoTerminalModes(SshClient) - Constructor for class com.sshtools.ssh.PseudoTerminalModes
 
pubkey - Variable in class com.sshtools.ssh.components.jce.Ssh2DsaPublicKey
 
PUBLIC_KEY_ACCEPTABLE - Static variable in interface com.sshtools.ssh.SshAuthentication
The public key provided is acceptable for authentication
PUBLIC_KEY_SSHDSS - Static variable in class com.sshtools.ssh2.Ssh2Context
SSH2 DSA Public Key
PUBLIC_KEY_SSHRSA - Static variable in class com.sshtools.ssh2.Ssh2Context
SSH2 RSA Public Key
PublicKeyAuthentication - Class in com.sshtools.ssh
Public key based authentication implementation.
PublicKeyAuthentication() - Constructor for class com.sshtools.ssh.PublicKeyAuthentication
 
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.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.
putBigInteger(BigInteger) - Method in interface com.sshtools.ssh.components.Digest
Update the digest with a BigInteger value.
putBigInteger(BigInteger) - Method in class com.sshtools.ssh.components.jce.AbstractDigest
 
putByte(byte) - Method in interface com.sshtools.ssh.components.Digest
Put a single byte into the digest.
putByte(byte) - Method in class com.sshtools.ssh.components.jce.AbstractDigest
 
putBytes(byte[]) - Method in interface com.sshtools.ssh.components.Digest
Put a byte array into the digest.
putBytes(byte[], int, int) - Method in interface com.sshtools.ssh.components.Digest
Put a byte array into the digest
putBytes(byte[]) - Method in class com.sshtools.ssh.components.jce.AbstractDigest
 
putBytes(byte[], int, int) - Method in class com.sshtools.ssh.components.jce.AbstractDigest
 
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.
putInt(int) - Method in interface com.sshtools.ssh.components.Digest
Put an integer into the digest.
putInt(int) - Method in class com.sshtools.ssh.components.jce.AbstractDigest
 
putString(String) - Method in interface com.sshtools.ssh.components.Digest
Put a String into the digest.
putString(String) - Method in class com.sshtools.ssh.components.jce.AbstractDigest
 
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(byte[], int, int) - Method in class com.sshtools.sftp.SftpFileInputStream
 
read() - Method in class com.sshtools.sftp.SftpFileInputStream
 
read() - Method in class com.sshtools.util.Base64.InputStream
 
read(byte[], int, int) - Method in class com.sshtools.util.Base64.InputStream
 
read() - Method in class com.sshtools.util.DynamicBuffer
Read a byte from the buffer
read(byte[], int, int) - Method in class com.sshtools.util.DynamicBuffer
Read a byte array from the buffer
readBigInteger() - Method in class com.sshtools.util.ByteArrayReader
Read a BigInteger from the array.
readBinaryString() - Method in class com.sshtools.util.ByteArrayReader
Read a binary string from the array.
readBoolean() - Method in class com.sshtools.util.ByteArrayReader
Write a boolean value to the array.
readCompleteFile(OutputStream, long, FileTransferProgress) - Method in class com.sshtools.scp.ScpClientIO.ScpEngineIO
 
readFile(byte[], UnsignedInteger64, byte[], int, int) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Read a block of data from an open file.
readFully(byte[], int, int) - Method in class com.sshtools.util.ByteArrayReader
Read until the buffer supplied is full.
readFully(byte[]) - Method in class com.sshtools.util.ByteArrayReader
 
readInt(byte[], int) - Static method in class com.sshtools.util.ByteArrayReader
Read an integer (4 bytes) from the array.
readInt() - Method in class com.sshtools.util.ByteArrayReader
Read an integer (4 bytes) from the array.
readLine(InputStream) - Method in class com.sshtools.net.HttpHeader
 
readMessage() - Method in class com.sshtools.ssh2.AuthenticationProtocol
Read a message from the underlying transport layer.
readMPINT() - Method in class com.sshtools.util.ByteArrayReader
Reads a standard SSH1 MPINT using the first 16 bits as the length prefix
readMPINT32() - Method in class com.sshtools.util.ByteArrayReader
Reads an MPINT using the first 32 bits as the length prefix
readpos - Variable in class com.sshtools.util.DynamicBuffer
The current read position
readShort(byte[], int) - Static method in class com.sshtools.util.ByteArrayReader
 
readShort() - Method in class com.sshtools.util.ByteArrayReader
 
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
readString() - Method in class com.sshtools.util.ByteArrayReader
Read a String from the array.
readString(String) - Method in class com.sshtools.util.ByteArrayReader
Read a String from the array converting using the given character set.
readUINT32() - Method in class com.sshtools.util.ByteArrayReader
 
readUINT64() - Method in class com.sshtools.util.ByteArrayReader
 
recurseDeleteDirectory(File) - Static method in class com.sshtools.util.IOUtil
 
recurseMakeDirectory(String) - Method in class com.sshtools.sftp.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.
releaseBlock() - Method in class com.sshtools.ssh.message.ThreadSynchronizer
 
releaseWaiting() - Method in class com.sshtools.ssh.message.ThreadSynchronizer
 
REMOTE_FORWARDING - Static variable in interface com.sshtools.net.ForwardingClientListener
Constant used to specify whether the event relates to a remote forwarding
REMOTE_HOST_DISCONNECTED - Static variable in exception com.sshtools.ssh.SshException
The remote host disconnected following the normal SSH protocol disconnection procedure.
remoteforwardings - Variable in class com.sshtools.net.ForwardingClient
 
remove(SshPublicKey) - Method in class com.sshtools.publickey.PublicKeySubsystem
Remove a public key from the users list of acceptable keys.
remove(String) - Method in class com.sshtools.ssh.components.ComponentFactory
Remove a supported component
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:"
removeDirectory(String) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Remove an empty directory.
removeEventListener(String) - Static method in class com.sshtools.ssh.SshConnector
 
removeFile(String) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Remove a file.
removeListener(String) - Method in interface com.sshtools.events.EventService
Remove a MaverickListener from the list of objects that will be sent MaverickEventss.
removeListener(String) - Method in class com.sshtools.events.EventServiceImplementation
Remove an EventListener from the list of listeners that are sent events
removeListener(ForwardingClientListener) - Method in class com.sshtools.net.ForwardingClient
Remove a ForwardingClientListener from the list receiving forwarding events.
removeListener(IOStreamConnector.IOStreamConnectorListener) - Method in class com.sshtools.util.IOStreamConnector
 
rename(String, String) - Method in class com.sshtools.sftp.SftpClient
Rename a file on the remote computer.
renameFile(String, String) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Rename an existing file.
REQUEST_NOT_SUPPPORTED - Static variable in exception com.sshtools.publickey.PublicKeySubsystemException
 
requestBlock(MessageStore, MessageObserver, MessageHolder) - Method in class com.sshtools.ssh.message.ThreadSynchronizer
 
requestPseudoTerminal(String, int, int, int, int, byte[]) - Method in interface com.sshtools.ssh.SshSession
The remote process may require a pseudo terminal.
requestPseudoTerminal(String, int, int, int, int, PseudoTerminalModes) - Method in interface com.sshtools.ssh.SshSession
The remote process may require a pseudo terminal.
requestPseudoTerminal(String, int, int, int, int) - Method in interface com.sshtools.ssh.SshSession
The remote process may require a pseudo terminal.
requestPseudoTerminal(String, int, int, int, int) - Method in class com.sshtools.ssh2.Ssh2Session
 
requestPseudoTerminal(String, int, int, int, int, PseudoTerminalModes) - Method in class com.sshtools.ssh2.Ssh2Session
 
requestPseudoTerminal(String, int, int, int, int, byte[]) - Method in class com.sshtools.ssh2.Ssh2Session
 
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.
requestRemoteForwarding(String, int, String, int, ForwardingRequestListener) - Method in interface com.sshtools.ssh.SshClient
Requests that the remote computer accepts socket connections and forward them to the local computer.
requestRemoteForwarding(String, int, String, int, ForwardingRequestListener) - Method in class com.sshtools.ssh2.Ssh2Client
 
requiresPasswordChange() - Method in class com.sshtools.ssh2.Ssh2PasswordAuthentication
Indicates whether the users password requires changing.
RESERVED - Static variable in class com.sshtools.ssh2.TransportProtocol
Disconnect reason: Reserved
reset() - Method in interface com.sshtools.ssh.components.Digest
Reset the underlying digest.
reset() - Method in class com.sshtools.ssh.components.jce.AbstractDigest
 
reset() - Method in class com.sshtools.ssh.components.SshKeyExchangeClient
Reset the key exchange.
reset() - Method in class com.sshtools.ssh.Packet
 
reset() - Method in class com.sshtools.ssh.PseudoTerminalModes
Clear the modes
RESOURCE_SHORTAGE - Static variable in exception com.sshtools.ssh.ChannelOpenException
There are no more resources available to open the channel
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.
run() - Method in class com.sshtools.net.ForwardingClient.SocketListener
 

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.
SCP_TRANSFER_CANCELLED - Static variable in exception com.sshtools.ssh.SshException
The user cancelled an active SCP transfer.
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.
secret - Variable in class com.sshtools.ssh.components.SshKeyExchangeClient
The secret value produced during key exchange.
SECSH_FORMAT - Static variable in class com.sshtools.publickey.SshPublicKeyFileFactory
 
SECSHPublicKeyFile - Class in com.sshtools.publickey
 
SecureRND - Class in com.sshtools.ssh.components.jce
Secure random number generator implementation for JCE provider.
SecureRND() - Constructor for class com.sshtools.ssh.components.jce.SecureRND
 
selectRandomPort() - Method in class com.sshtools.net.ForwardingClient
Select a random port.
sendExtensionMessage(String, byte[]) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Send an extension message and return the response.
sendGlobalRequest(GlobalRequest, boolean) - Method in class com.sshtools.ssh2.Ssh2Client
Sends a global request to the remote side.
sendMessage(Packet) - Method in class com.sshtools.ssh.SubsystemChannel
Write a subsystem message to the channel outputstream.
sendMessage(byte[]) - Method in class com.sshtools.ssh.SubsystemChannel
Deprecated.
This has changed internally to use a Packet and it is recommended that all implementations change to use Packet's as they provide a more efficent way of sending data.
sendMessage(byte[]) - Method in class com.sshtools.ssh2.AuthenticationProtocol
 
sendMessage(byte[], boolean) - Method in class com.sshtools.ssh2.TransportProtocol
Send a transport protocol message.
sendRequest(String, String, String, byte[]) - Method in class com.sshtools.ssh2.AuthenticationProtocol
Send an authentication request.
sendRequest(String, boolean, byte[]) - Method in class com.sshtools.ssh2.Ssh2Channel
Sends a channel request.
sendRequest(String, boolean, byte[], boolean) - Method in class com.sshtools.ssh2.Ssh2Channel
Sends a channel request.
SERVICE_NAME - Static variable in class com.sshtools.ssh2.AuthenticationProtocol
The name of this service "ssh-userauth"
SERVICE_NOT_AVAILABLE - Static variable in class com.sshtools.ssh2.TransportProtocol
Disconnect reason: The requested service is not available
session - Variable in class com.sshtools.scp.ScpClientIO.ScpEngineIO
 
SESSION_CHANNEL - Static variable in class com.sshtools.ssh2.Ssh2Channel
 
SESSION_STREAM_ERROR - Static variable in exception com.sshtools.ssh.SshException
An error occurred whilst accessing a sessions streams
setAttributes(String, SftpFileAttributes) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Sets the attributes of a file.
setAttributes(SftpFile, SftpFileAttributes) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Sets the attributes of a file.
setAuthenticating(boolean) - Method in class com.sshtools.ssh.PublicKeyAuthentication
If true the authentication will proceed as normal and the result will either be a success or failure.
setAutoConsumeInput(boolean) - Method in interface com.sshtools.ssh.SshChannel
Automatically consume input data
setAutoConsumeInput(boolean) - Method in class com.sshtools.ssh2.Ssh2Channel
 
setBannerDisplay(BannerDisplay) - Method in class com.sshtools.ssh2.AuthenticationProtocol
Set a callback interface for banner messages.
setBannerDisplay(BannerDisplay) - Method in class com.sshtools.ssh2.Ssh2Context
Set a banner display for callback of authentication banners
setBasicAuthentication(String, String) - Method in class com.sshtools.net.HttpRequest
 
setBlockInterrupt(int) - Method in class com.sshtools.util.DynamicBuffer
 
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.
setBufferSize(int) - Method in class com.sshtools.util.IOStreamConnector
 
setChannelLimit(int) - Method in interface com.sshtools.ssh.SshContext
Set the maximum number of channels that are allowed open at any one time.
setChannelLimit(int) - Method in class com.sshtools.ssh2.Ssh2Context
 
setCharsetEncoding(String) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Allows the default character encoding to be overriden for filename strings.
setCharsetEncoding(String) - Static method in class com.sshtools.util.ByteArrayReader
Allows the default encoding to be overriden for String variables processed by the class.
setCipherPreferredPositionCS(String, int) - Method in class com.sshtools.ssh2.Ssh2Context
 
setCipherPreferredPositionSC(String, int) - Method in class com.sshtools.ssh2.Ssh2Context
 
setClientHostname(String) - Method in class com.sshtools.ssh2.Ssh2HostbasedAuthentication
Set the hostname of the client
setClientUsername(String) - Method in class com.sshtools.ssh2.Ssh2HostbasedAuthentication
Set the user's username on the client computer
setCloseInput(boolean) - Method in class com.sshtools.util.IOStreamConnector
 
setCloseOutput(boolean) - Method in class com.sshtools.util.IOStreamConnector
 
setComment(String) - Method in class com.sshtools.publickey.SECSHPublicKeyFile
 
setConnectionTimeout(int) - Static method in class com.sshtools.net.HttpProxyTransport
 
setConnectionTimeout(int) - Static method in class com.sshtools.net.HttpProxyTransportWrapper
 
setData(byte[]) - Method in class com.sshtools.ssh2.GlobalRequest
Set the data.
setDefaultHashAlgorithm(String) - Static method in class com.sshtools.ssh.SshKeyFingerprint
 
setDHGroupExchangeBackwardsCompatible(boolean) - Method in class com.sshtools.ssh2.Ssh2Context
 
setDHGroupExchangeKeySize(int) - Method in class com.sshtools.ssh2.Ssh2Context
 
setEnableNoneCipher(boolean) - Static method in class com.sshtools.ssh.components.ComponentManager
 
setEnableNoneMac(boolean) - Static method in class com.sshtools.ssh.components.ComponentManager
 
setEnvironmentVariable(String, String) - Method in class com.sshtools.ssh2.Ssh2Session
The SSH2 session supports the setting of environments variables however in our experiance no server to date allows unconditional setting of variables.
setGID(String) - Method in class com.sshtools.sftp.SftpFileAttributes
Set the GID of this file.
setGssCallback(MaverickCallbackHandler) - Method in class com.sshtools.ssh2.Ssh2Context
 
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
 
setHeaderValue(String, String) - Method in class com.sshtools.publickey.Base64EncodedFileFormat
 
setHostKeyVerification(HostKeyVerification) - Method in interface com.sshtools.ssh.SshContext
Set the host key verification implementation.
setHostKeyVerification(HostKeyVerification) - Method in class com.sshtools.ssh2.Ssh2Context
Set the host key verification implementation
setIdleConnectionTimeoutSeconds(int) - Method in class com.sshtools.ssh2.Ssh2Context
 
setIgnoreHostKeyifEmpty(boolean) - Method in class com.sshtools.ssh2.TransportProtocol
 
setInstance(Logger) - Static method in class com.sshtools.logging.LoggerFactory
 
setInstance(ComponentManager) - Static method in class com.sshtools.ssh.components.ComponentManager
Overide the installed component manager with an alternative implementation.
setKBIRequestHandler(KBIRequestHandler) - Method in class com.sshtools.ssh2.KBIAuthentication
Set the KBIRequestHandler for this authentication attempt.
setKeepAliveMaxDataLength(int) - Method in class com.sshtools.ssh2.Ssh2Context
 
setKeyExchangePreferredPosition(String, int) - Method in class com.sshtools.ssh2.Ssh2Context
 
setKeyReExchangeDisabled(boolean) - Method in class com.sshtools.ssh2.Ssh2Context
 
setMacPreferredPositionCS(String, int) - Method in class com.sshtools.ssh2.Ssh2Context
 
setMacPreferredPositionSC(String, int) - Method in class com.sshtools.ssh2.Ssh2Context
 
setMaxAsyncRequests(int) - Method in class com.sshtools.sftp.SftpClient
Set the maximum number of asynchronous requests that are outstanding at any one time.
setMaximumPacketLength(int) - Method in class com.sshtools.ssh2.Ssh2Context
Set the maximum packet size supported by the transport layer.
setMaxSftpVersion(int) - Static method in class com.sshtools.sftp.SftpSubsystemChannel
Sets the maximum SFTP protocol version to use, this should be <=4.
setNewPassword(String) - Method in class com.sshtools.ssh2.Ssh2PasswordAuthentication
After performing an initial authentication attempt a flag may be set to indicate that a password change is required.
setPartialMessageTimeout(int) - Method in class com.sshtools.ssh2.Ssh2Context
 
setPassword(String) - Method in class com.sshtools.ssh.PasswordAuthentication
Set the password.
setPassword(String) - Method in interface com.sshtools.ssh2.MaverickCallbackHandler
 
setPerContextAlgorithmPreferences(boolean) - Static method in class com.sshtools.ssh.components.ComponentManager
 
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.
setPosition(int) - Method in class com.sshtools.ssh.Packet
 
setPreferredCipherCS(String) - Method in class com.sshtools.ssh2.Ssh2Context
Set the preferred cipher for the Client->Server stream.
setPreferredCipherCS(int[]) - Method in class com.sshtools.ssh2.Ssh2Context
Set the preferred SC cipher order
setPreferredCipherSC(int[]) - Method in class com.sshtools.ssh2.Ssh2Context
Set the preferred SC cipher order
setPreferredCipherSC(String) - Method in class com.sshtools.ssh2.Ssh2Context
Set the preferred cipher for the Server->Client stream.
setPreferredCompressionCS(String) - Method in class com.sshtools.ssh2.Ssh2Context
Set the preferred compression for the Client->Server stream.
setPreferredCompressionSC(String) - Method in class com.sshtools.ssh2.Ssh2Context
Set the preferred compression for the Server->Client stream.
setPreferredKeyExchange(String) - Method in class com.sshtools.ssh2.Ssh2Context
Set the preferred key exchange method.
setPreferredMacCS(int[]) - Method in class com.sshtools.ssh2.Ssh2Context
Set the preferred CS Mac order
setPreferredMacCS(String) - Method in class com.sshtools.ssh2.Ssh2Context
Set the preferred mac for the Client->Server stream.
setPreferredMacSC(int[]) - Method in class com.sshtools.ssh2.Ssh2Context
Set the preferred SC Mac order
setPreferredMacSC(String) - Method in class com.sshtools.ssh2.Ssh2Context
Set the preferred mac for the Server->Client stream.
setPreferredPublicKey(String) - Method in class com.sshtools.ssh2.Ssh2Context
Set the preferred public key algorithm.
setPrivateKey(SshPrivateKey) - Method in class com.sshtools.ssh.components.SshKeyPair
Set the private key
setPrivateKey(SshPrivateKey) - Method in class com.sshtools.ssh.PublicKeyAuthentication
Set the private key for this authentication.
setPrivateKey(SshPrivateKey) - Method in class com.sshtools.ssh2.Ssh2HostbasedAuthentication
Set the private key for the authentication attempt
setProduct(String) - Method in class com.sshtools.ssh.SshConnector
 
setPublicKey(SshPublicKey) - Method in class com.sshtools.ssh.components.SshKeyPair
Set the public key
setPublicKey(SshPublicKey) - Method in class com.sshtools.ssh.PublicKeyAuthentication
Set the public key for this authentication.
setPublicKey(SshPublicKey) - Method in class com.sshtools.ssh2.Ssh2HostbasedAuthentication
Set the public key for the authentication attempt
setPublicKeyPreferredPosition(String, int) - Method in class com.sshtools.ssh2.Ssh2Context
 
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.
setResponse(String) - Method in class com.sshtools.ssh2.KBIPrompt
Set the user's response for this prompt.
setSecureRandomAlgorithm(String) - Static method in class com.sshtools.ssh.components.jce.JCEComponentManager
Set the algorithm used for secure random number generation.
setSecureRandomAlgorithm(String) - Static method in class com.sshtools.ssh.components.jce.JCEProvider
Set the algorithm used for secure random number generation.
setSendIgnorePacketOnIdle(boolean) - Method in class com.sshtools.ssh2.Ssh2Context
 
setSendKeepAliveOnIdle(boolean) - Method in class com.sshtools.ssh2.Ssh2Channel
 
setSFTPProvider(String) - Method in interface com.sshtools.ssh.SshContext
Set the path to the SFTP provider.
setSFTPProvider(String) - Method in class com.sshtools.ssh2.Ssh2Context
 
setSignatureGenerator(SignatureGenerator) - Method in class com.sshtools.ssh2.Ssh2PublicKeyAuthentication
Set the signature generator for this authentication attempt.
setSize(UnsignedInteger64) - Method in class com.sshtools.sftp.SftpFileAttributes
Set the size of the file.
setSocketTimeout(int) - Method in class com.sshtools.ssh2.Ssh2Context
 
setSoftwareVersionComments(String) - Method in class com.sshtools.ssh.SshConnector
Set the software/version/comments field of the SSH identification string
setSoTimeout(int) - Method in class com.sshtools.net.SocketWrapper
 
setSoTimeout(int) - Method in interface com.sshtools.ssh.SocketTimeoutSupport
Set the socket timeout in milliseconds.
setTerminalMode(int, int) - Method in class com.sshtools.ssh.PseudoTerminalModes
Set an integer value mode
setTerminalMode(int, boolean) - Method in class com.sshtools.ssh.PseudoTerminalModes
Set a boolean value mode
setThisMaxSftpVersion(int) - Method in class com.sshtools.sftp.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.SftpClient
Sets the transfer mode for current operations.
setUID(String) - Method in class com.sshtools.sftp.SftpFileAttributes
Set the UID of the owner.
setUser(String) - Method in interface com.sshtools.ssh2.MaverickCallbackHandler
 
setUsername(String) - Method in class com.sshtools.ssh.PasswordAuthentication
Set the username.
setUsername(String) - Method in class com.sshtools.ssh.PublicKeyAuthentication
 
setUsername(String) - Method in interface com.sshtools.ssh.SshAuthentication
Set the username for this authentication attempt.
setUsername(String) - Method in class com.sshtools.ssh2.KBIAuthentication
 
setUsername(String) - Method in class com.sshtools.ssh2.Ssh2HostbasedAuthentication
 
setX11AuthenticationCookie(byte[]) - Method in interface com.sshtools.ssh.SshContext
Set the fake cookie used for X11 authentication
setX11AuthenticationCookie(byte[]) - Method in class com.sshtools.ssh2.Ssh2Context
 
setX11Display(String) - Method in interface com.sshtools.ssh.SshContext
Set the DISPLAY variable for the SSH connection.
setX11Display(String) - Method in class com.sshtools.ssh2.Ssh2Context
 
setX11RealCookie(byte[]) - Method in interface com.sshtools.ssh.SshContext
Sets the real X11 authentication cookie which can be obtained from the users $HOME/.Xauthority file.
setX11RealCookie(byte[]) - Method in class com.sshtools.ssh2.Ssh2Context
 
setX11RequestListener(ForwardingRequestListener) - Method in interface com.sshtools.ssh.SshContext
Set the listener to which X11 forwarding requests will be processed.
setX11RequestListener(ForwardingRequestListener) - Method in class com.sshtools.ssh2.Ssh2Context
 
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.
SftpFile - Class in com.sshtools.sftp
Represents an SFTP file object.
SftpFile(String, SftpFileAttributes) - 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(SftpSubsystemChannel, int) - Constructor for class com.sshtools.sftp.SftpFileAttributes
Creates a new FileAttributes object.
SftpFileAttributes(SftpSubsystemChannel, ByteArrayReader) - Constructor for class com.sshtools.sftp.SftpFileAttributes
 
SftpFileInputStream - Class in com.sshtools.sftp
An InputStream to read the contents of a remote file.
SftpFileInputStream(SftpFile) - Constructor for class com.sshtools.sftp.SftpFileInputStream
 
SftpFileInputStream(SftpFile, long) - Constructor for class com.sshtools.sftp.SftpFileInputStream
Creates a new SftpFileInputStream object.
SftpFileOutputStream - Class in com.sshtools.sftp
An OutputStream to write data to a remote file.
SftpFileOutputStream(SftpFile) - Constructor for class com.sshtools.sftp.SftpFileOutputStream
Creates a new SftpFileOutputStream object.
SftpMessage - Class in com.sshtools.sftp
 
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
This class implements the SFTP protocol which is executed as an SSH subsystem.
SftpSubsystemChannel(SshSession) - Constructor for class com.sshtools.sftp.SftpSubsystemChannel
 
SftpSubsystemChannel(SshSession, int) - Constructor for class com.sshtools.sftp.SftpSubsystemChannel
 
SHA1_FINGERPRINT - Static variable in class com.sshtools.ssh.SshKeyFingerprint
 
SHA1Digest - Class in com.sshtools.ssh.components.jce
SHA-1 digest implementation.
SHA1Digest() - Constructor for class com.sshtools.ssh.components.jce.SHA1Digest
 
SHA256_FINGERPRINT - Static variable in class com.sshtools.ssh.SshKeyFingerprint
 
SHA256Digest - Class in com.sshtools.ssh.components.jce
SHA-1 digest implementation.
SHA256Digest() - Constructor for class com.sshtools.ssh.components.jce.SHA256Digest
 
SHELL_ERROR - Static variable in exception com.sshtools.ssh.SshException
A request was made to start a shell, but this request failed.
showPrompts(String, String, KBIPrompt[]) - Method in interface com.sshtools.ssh2.KBIRequestHandler
Called by the keyboard-interactive authentication mechanism when the server requests information from the user.
sign(byte[]) - Method in class com.sshtools.ssh.components.jce.Ssh2DsaPrivateKey
 
sign(byte[]) - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPrivateCrtKey
 
sign(byte[]) - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPrivateKey
 
sign(byte[]) - Method in interface com.sshtools.ssh.components.SshDsaPrivateKey
 
sign(byte[]) - Method in interface com.sshtools.ssh.components.SshPrivateKey
Create a signature from the data.
sign(byte[]) - Method in interface com.sshtools.ssh.components.SshRsaPrivateKey
 
sign(SshPublicKey, byte[]) - Method in interface com.sshtools.ssh2.SignatureGenerator
Sign the data using the private key of the public key provided.
signal(String) - Method in class com.sshtools.ssh2.Ssh2Session
Send a signal to the remote process.
signalClosingState() - Method in class com.sshtools.ssh.message.SshMessageRouter
 
signature - Variable in class com.sshtools.ssh.components.SshKeyExchangeClient
The signature generated over the exchange hash
SignatureGenerator - Interface in com.sshtools.ssh2
Provides a callback when a private key signature is required.
SimpleASNReader - Class in com.sshtools.util
 
SimpleASNReader(byte[]) - Constructor for class com.sshtools.util.SimpleASNReader
Creates a new SimpleASNReader object.
SimpleASNWriter - Class in com.sshtools.util
 
SimpleASNWriter() - Constructor for class com.sshtools.util.SimpleASNWriter
Creates a new SimpleASNWriter object.
socket - Variable in class com.sshtools.net.SocketWrapper
 
SOCKET_TIMEOUT - Static variable in exception com.sshtools.ssh.SshException
The API detected a socket timeout
socketlisteners - Variable in class com.sshtools.net.ForwardingClient
 
SocketTimeoutSupport - Interface in com.sshtools.ssh
This interface adds timeout support to the SocketTransport interface.
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.
sort(int[]) - Static method in class com.sshtools.util.Arrays
Sorts the specified array of ints into ascending numerical order.
source - Variable in class com.sshtools.events.EventObject
The object on which the Event initially occurred.
ssh - Variable in class com.sshtools.scp.ScpClientIO
 
SSH1_FORMAT - Static variable in class com.sshtools.publickey.SshPublicKeyFileFactory
 
SSH1_RSA - Static variable in class com.sshtools.publickey.SshKeyPairGenerator
 
SSH2_DSA - Static variable in class com.sshtools.publickey.SshKeyPairGenerator
 
SSH2_RSA - Static variable in class com.sshtools.publickey.SshKeyPairGenerator
 
Ssh2Channel - Class in com.sshtools.ssh2
All terminal sessions, forwarded connections, etc are channels and this class implements the base SSH2 channel.
Ssh2Channel(String, int, int) - Constructor for class com.sshtools.ssh2.Ssh2Channel
Construct an SSH2 channel
Ssh2Client - Class in com.sshtools.ssh2
Implementation of an SshClient for the SSH2 protocol; this provides the ability to create custom channels and sending/receiving of global requests in addition to the standard SshClient contract.
Ssh2Client() - Constructor for class com.sshtools.ssh2.Ssh2Client
Default constructor called by SshConnector.
Ssh2Context - Class in com.sshtools.ssh2
This class implements SshContextto provide SSH2 connection configuration through the SshConnector class.
Ssh2Context() - Constructor for class com.sshtools.ssh2.Ssh2Context
Contructs a default context
Ssh2DsaPrivateKey - Class in com.sshtools.ssh.components.jce
DSA private key implementation for the SSH2 protocol.
Ssh2DsaPrivateKey(DSAPrivateKey, DSAPublicKey) - Constructor for class com.sshtools.ssh.components.jce.Ssh2DsaPrivateKey
 
Ssh2DsaPrivateKey(BigInteger, BigInteger, BigInteger, BigInteger, BigInteger) - Constructor for class com.sshtools.ssh.components.jce.Ssh2DsaPrivateKey
 
Ssh2DsaPublicKey - Class in com.sshtools.ssh.components.jce
A DSA public key implementation which uses a JCE provider.
Ssh2DsaPublicKey() - Constructor for class com.sshtools.ssh.components.jce.Ssh2DsaPublicKey
 
Ssh2DsaPublicKey(DSAPublicKey) - Constructor for class com.sshtools.ssh.components.jce.Ssh2DsaPublicKey
 
Ssh2DsaPublicKey(BigInteger, BigInteger, BigInteger, BigInteger) - Constructor for class com.sshtools.ssh.components.jce.Ssh2DsaPublicKey
 
Ssh2HostbasedAuthentication - Class in com.sshtools.ssh2
Provides hostbased authentication for the SSH2 protocol.
Ssh2HostbasedAuthentication() - Constructor for class com.sshtools.ssh2.Ssh2HostbasedAuthentication
 
Ssh2PasswordAuthentication - Class in com.sshtools.ssh2
Implements Password authentication as defined in the SSH Authenticaiton Protocol.
Ssh2PasswordAuthentication() - Constructor for class com.sshtools.ssh2.Ssh2PasswordAuthentication
Construct the method
Ssh2PublicKeyAuthentication - Class in com.sshtools.ssh2
SSH2 public key authentication providing additional SSH2 public key authentication features.
Ssh2PublicKeyAuthentication() - Constructor for class com.sshtools.ssh2.Ssh2PublicKeyAuthentication
 
Ssh2RsaPrivateCrtKey - Class in com.sshtools.ssh.components.jce
RSA co-efficient private key implementation for SSH2 protocol.
Ssh2RsaPrivateCrtKey(RSAPrivateCrtKey) - Constructor for class com.sshtools.ssh.components.jce.Ssh2RsaPrivateCrtKey
 
Ssh2RsaPrivateCrtKey(BigInteger, BigInteger, BigInteger, BigInteger, BigInteger, BigInteger, BigInteger, BigInteger) - Constructor for class com.sshtools.ssh.components.jce.Ssh2RsaPrivateCrtKey
 
Ssh2RsaPrivateKey - Class in com.sshtools.ssh.components.jce
RSA private key implementation for the SSH2 protocol.
Ssh2RsaPrivateKey(RSAPrivateKey) - Constructor for class com.sshtools.ssh.components.jce.Ssh2RsaPrivateKey
 
Ssh2RsaPrivateKey(BigInteger, BigInteger) - Constructor for class com.sshtools.ssh.components.jce.Ssh2RsaPrivateKey
 
Ssh2RsaPublicKey - Class in com.sshtools.ssh.components.jce
A RSA public key implementation which uses a JCE provider.
Ssh2RsaPublicKey() - Constructor for class com.sshtools.ssh.components.jce.Ssh2RsaPublicKey
Default constructor for initializing the key from a byte array using the init method.
Ssh2RsaPublicKey(RSAPublicKey) - Constructor for class com.sshtools.ssh.components.jce.Ssh2RsaPublicKey
 
Ssh2RsaPublicKey(BigInteger, BigInteger) - Constructor for class com.sshtools.ssh.components.jce.Ssh2RsaPublicKey
 
Ssh2Session - Class in com.sshtools.ssh2
This class implements the SSH2 session channel, unlike SSH1 multiple sessions can be opened on the same SSH connection.
Ssh2Session(int, int, Ssh2Client) - Constructor for class com.sshtools.ssh2.Ssh2Session
Construct a session channel.
SSH_FILEXFER_TYPE_DIRECTORY - Static variable in class com.sshtools.sftp.SftpFileAttributes
 
SSH_FILEXFER_TYPE_REGULAR - 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_BYTE_RANGE_LOCK_CONFLICT - Static variable in exception com.sshtools.sftp.SftpStatusException
 
SSH_FX_BYTE_RANGE_LOCK_REFUSED - Static variable in exception com.sshtools.sftp.SftpStatusException
 
SSH_FX_CANNOT_DELETE - Static variable in exception com.sshtools.sftp.SftpStatusException
 
SSH_FX_CONNECTION_LOST - Static variable in exception com.sshtools.sftp.SftpStatusException
The file system connection was lost
SSH_FX_DELETE_PENDING - Static variable in exception com.sshtools.sftp.SftpStatusException
 
SSH_FX_DIR_NOT_EMPTY - Static variable in exception com.sshtools.sftp.SftpStatusException
 
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_FILE_CORRUPT - Static variable in exception com.sshtools.sftp.SftpStatusException
 
SSH_FX_FILE_IS_A_DIRECTORY - Static variable in exception com.sshtools.sftp.SftpStatusException
 
SSH_FX_GROUP_INVALID - Static variable in exception com.sshtools.sftp.SftpStatusException
 
SSH_FX_INVALID_FILENAME - Static variable in exception com.sshtools.sftp.SftpStatusException
 
SSH_FX_INVALID_HANDLE - Static variable in exception com.sshtools.sftp.SftpStatusException
The file handle provided was invalid
SSH_FX_INVALID_PARAMETER - Static variable in exception com.sshtools.sftp.SftpStatusException
 
SSH_FX_LINK_LOOP - Static variable in exception com.sshtools.sftp.SftpStatusException
 
SSH_FX_LOCK_CONFLICT - Static variable in exception com.sshtools.sftp.SftpStatusException
 
SSH_FX_NO_CONNECTION - Static variable in exception com.sshtools.sftp.SftpStatusException
There is no connection to the file system
SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK - Static variable in exception com.sshtools.sftp.SftpStatusException
 
SSH_FX_NO_MEDIA - Static variable in exception com.sshtools.sftp.SftpStatusException
There is no media available at the remote location
SSH_FX_NO_SPACE_ON_FILESYSTEM - Static variable in exception com.sshtools.sftp.SftpStatusException
 
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_NOT_A_DIRECTORY - Static variable in exception com.sshtools.sftp.SftpStatusException
 
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_OWNER_INVALID - Static variable in exception com.sshtools.sftp.SftpStatusException
 
SSH_FX_PERMISSION_DENIED - Static variable in exception com.sshtools.sftp.SftpStatusException
The user does not have permission
SSH_FX_QUOTA_EXCEEDED - Static variable in exception com.sshtools.sftp.SftpStatusException
 
SSH_FX_UNKNOWN_PRINCIPAL - Static variable in exception com.sshtools.sftp.SftpStatusException
 
SSH_FX_WRITE_PROTECT - Static variable in exception com.sshtools.sftp.SftpStatusException
Cannot write to remote location
SSH_MSG_USERAUTH_REQUEST - Static variable in class com.sshtools.ssh2.AuthenticationProtocol
 
SshAbstractChannel - Class in com.sshtools.ssh.message
 
SshAbstractChannel() - Constructor for class com.sshtools.ssh.message.SshAbstractChannel
 
SshAuthentication - Interface in com.sshtools.ssh
The base interface for all SSH authentication mechanisms and authentication result constants.
SshChannel - Interface in com.sshtools.ssh
The base interface for all SSH channels.
SshChannelMessage - Class in com.sshtools.ssh.message
 
SshChannelMessage(int, byte[], int, int) - Constructor for class com.sshtools.ssh.message.SshChannelMessage
 
SshChannelMessage(byte[]) - Constructor for class com.sshtools.ssh.message.SshChannelMessage
 
SshCipher - Class in com.sshtools.ssh.components
Base class for all SSH protocol ciphers.
SshCipher(String) - Constructor for class com.sshtools.ssh.components.SshCipher
 
SshClient - Interface in com.sshtools.ssh
This interface defines the general contract for an SSH client that is compatible for both the SSH1 and SSH2 protocols.
SshCompression - Interface in com.sshtools.ssh.compression
Compression interface which can be implemented to provide the SSH Transport Protocol with compression.
SshConnector - Class in com.sshtools.ssh
This utility class establishes a connection with an SSH server, determines which SSH protocol versions are supported and creates an initialized connection ready for authentication.
SshContext - Interface in com.sshtools.ssh
This interface defines the general configuration items available to both SSH1 and SSH2.
SshDsaPrivateKey - Interface in com.sshtools.ssh.components
This interface should be implemented by all DSA private key implementations.
SshDsaPublicKey - Interface in com.sshtools.ssh.components
This interface should be implemented by all DSA public key implementations.
SshException - Exception in com.sshtools.ssh
Generic exception for J2SSH Maverick exception handling.
SshException(String, int) - Constructor for exception com.sshtools.ssh.SshException
Create an exception with the given description and reason.
SshException(int, Throwable) - Constructor for exception com.sshtools.ssh.SshException
Create an exception with the given cause and reason.
SshException(Throwable, int) - Constructor for exception com.sshtools.ssh.SshException
 
SshException(String, Throwable) - Constructor for exception com.sshtools.ssh.SshException
Create an exception with the given description and cause.
SshException(Throwable) - Constructor for exception com.sshtools.ssh.SshException
Create an exception by providing the cause of the error.
SshException(String, int, Throwable) - Constructor for exception com.sshtools.ssh.SshException
Create an exception with the given description cause, reason.
SshHmac - Interface in com.sshtools.ssh.components
This interface should be implemented by all message authentication implementations.
SshIO - Interface in com.sshtools.ssh
Base interface for all SSH related IO interfaces.
SshIOException - Exception in com.sshtools.ssh
This class is provided so that when a channel InputStream/OutputStream interface has to throw an IOException; the real SshException cause can be retrieved.
SshIOException(SshException) - Constructor for exception com.sshtools.ssh.SshIOException
Construct the exception with the real exception.
SshKeyExchange - Interface in com.sshtools.ssh.components
Base interface for SSH2 key exchange implementations.
SshKeyExchangeClient - Class in com.sshtools.ssh.components
Abstract representation of an SSH key exchange.
SshKeyExchangeClient(String) - Constructor for class com.sshtools.ssh.components.SshKeyExchangeClient
 
SshKeyExchangeClient() - Constructor for class com.sshtools.ssh.components.SshKeyExchangeClient
Contruct an uninitialized key exchange
SshKeyFingerprint - Class in com.sshtools.ssh
Utility methods to generate an SSH public key fingerprint.
SshKeyFingerprint() - Constructor for class com.sshtools.ssh.SshKeyFingerprint
 
SshKeyPair - Class in com.sshtools.ssh.components
Storage class for a public/private key pair.
SshKeyPair() - Constructor for class com.sshtools.ssh.components.SshKeyPair
 
SshKeyPairGenerator - Class in com.sshtools.publickey
Generate public/private key pairs.
SshKeyPairGenerator() - Constructor for class com.sshtools.publickey.SshKeyPairGenerator
 
SshMessage - Class in com.sshtools.ssh.message
 
SshMessage(byte[], int, int) - Constructor for class com.sshtools.ssh.message.SshMessage
 
SshMessage(byte[]) - Constructor for class com.sshtools.ssh.message.SshMessage
 
SshMessageReader - Interface in com.sshtools.ssh.message
 
SshMessageRouter - Class in com.sshtools.ssh.message
This abstract class provides a synchronized message routing framework.
SshMessageRouter(SshMessageReader, int, boolean) - Constructor for class com.sshtools.ssh.message.SshMessageRouter
 
SshMessageStore - Class in com.sshtools.ssh.message
This class is the central storage location for channel messages; each channel has its own message store and the message pump delivers them here where they are stored in a lightweight linked list.
SshMessageStore(SshMessageRouter, SshAbstractChannel, MessageObserver) - Constructor for class com.sshtools.ssh.message.SshMessageStore
 
SshPrivateKey - Interface in com.sshtools.ssh.components
Interface for SSH supported private keys.
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
 
SshPublicKey - Interface in com.sshtools.ssh.components
Interface for SSH supported public keys.
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
 
SshRsaPrivateCrtKey - Interface in com.sshtools.ssh.components
This interface should be implemented by all RSA private co-efficient private key implementations.
SshRsaPrivateKey - Interface in com.sshtools.ssh.components
This interface should be implemented by all RSA private key implementations.
SshRsaPublicKey - Interface in com.sshtools.ssh.components
This interface should be implemented by all RSA public key implementations.
SshSecureRandomGenerator - Interface in com.sshtools.ssh.components
This interface should be implemented by all secure random number generator implementations.
SshSession - Interface in com.sshtools.ssh
Base interface for SSH sessions supporting all the features common to both SSH1 and SSH2.
SSHTOOLS_FORMAT - Static variable in class com.sshtools.publickey.SshPrivateKeyFileFactory
 
SshTransport - Interface in com.sshtools.ssh
Simple interface wrapper for transport layer communication.
SshTunnel - Interface in com.sshtools.ssh
Interface defining the contract for SSH forwarding channels.
SshX509DsaPublicKey - Class in com.sshtools.ssh.components.jce
Basic implementation of X509 certificate support.
SshX509DsaPublicKey() - Constructor for class com.sshtools.ssh.components.jce.SshX509DsaPublicKey
 
SshX509DsaPublicKey(X509Certificate) - Constructor for class com.sshtools.ssh.components.jce.SshX509DsaPublicKey
 
SshX509RsaPublicKey - Class in com.sshtools.ssh.components.jce
Basic implementation of X509 certificate support.
SshX509RsaPublicKey() - Constructor for class com.sshtools.ssh.components.jce.SshX509RsaPublicKey
 
SshX509RsaPublicKey(X509Certificate) - Constructor for class com.sshtools.ssh.components.jce.SshX509RsaPublicKey
 
SshX509RsaSha1PublicKey - Class in com.sshtools.ssh.components.jce
Basic implementation of X509 certificate support.
SshX509RsaSha1PublicKey() - Constructor for class com.sshtools.ssh.components.jce.SshX509RsaSha1PublicKey
 
SshX509RsaSha1PublicKey(X509Certificate) - Constructor for class com.sshtools.ssh.components.jce.SshX509RsaSha1PublicKey
 
start() - Method in class com.sshtools.net.ForwardingClient.SocketListener
 
start() - Method in class com.sshtools.ssh.message.SshMessageRouter
 
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.
startService(String) - Method in class com.sshtools.ssh2.TransportProtocol
Request that the remote server starts a transport protocol service.
startShell() - Method in interface com.sshtools.ssh.SshSession
Start the users default shell.
startShell() - Method in class com.sshtools.ssh2.Ssh2Session
 
startSubsystem(String) - Method in class com.sshtools.ssh2.Ssh2Session
SSH2 supports special subsystems that are identified by a name rather than a command string, an example of an SSH2 subsystem is SFTP.
startTransportProtocol(SshTransport, Ssh2Context, String, String, Ssh2Client) - Method in class com.sshtools.ssh2.TransportProtocol
Starts the protocol on the provider.
stat(String) - Method in class com.sshtools.sftp.SftpClient
Returns the attributes of the file from the remote computer.
state - Variable in class com.sshtools.ssh.message.SshAbstractChannel
 
statLink(String) - Method in class com.sshtools.sftp.SftpClient
Returns the attributes of a link on 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.
stop() - Method in class com.sshtools.net.ForwardingClient.SocketListener
 
stop() - Method in class com.sshtools.ssh.message.SshMessageRouter
 
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
 
SubsystemChannel - Class in com.sshtools.ssh
This class provides useful methods for implementing an SSH2 subsystem.
SubsystemChannel(SshChannel) - Constructor for class com.sshtools.ssh.SubsystemChannel
Create a new subsystem channel.
supported - Variable in class com.sshtools.ssh.components.ComponentFactory
The supported components stored in a Hashtable with a String key as the component name such as "3des-cbc" and a Class value storing the implementation class.
supportedChannelTypes() - Method in interface com.sshtools.ssh2.ChannelFactory
Return the supported channel types.
supportedCiphersCS() - Method in class com.sshtools.ssh2.Ssh2Context
 
supportedCiphersSC() - Method in class com.sshtools.ssh2.Ssh2Context
Returns this context's supported cipher algorithms.
supportedCompressionsCS() - Method in class com.sshtools.ssh2.Ssh2Context
Get this context's supported CS compression algorithms.
supportedCompressionsSC() - Method in class com.sshtools.ssh2.Ssh2Context
Get this context's supported SC compression algorithms.
supportedDigests() - Method in class com.sshtools.ssh.components.ComponentManager
The supported digests
supportedHMacsCS() - Method in class com.sshtools.ssh.components.ComponentManager
The supported SSH2 Hmacs.
supportedHMacsSC() - Method in class com.sshtools.ssh.components.ComponentManager
The supported SSH2 Hmacs.
supportedKeyExchanges() - Method in class com.sshtools.ssh.components.ComponentManager
The supported SSH2 key exchanges.
supportedKeyExchanges() - Method in class com.sshtools.ssh2.Ssh2Context
Get this context's supported key exchange methods.
supportedMacsCS() - Method in class com.sshtools.ssh2.Ssh2Context
Get this context's supported message authentication algorithms CS.
supportedMacsSC() - Method in class com.sshtools.ssh2.Ssh2Context
Get this context's supported message authentication algorithms SC.
supportedPublicKeys() - Method in class com.sshtools.ssh.components.ComponentManager
The supported public keys
supportedPublicKeys() - Method in class com.sshtools.ssh2.Ssh2Context
Get this context's supported public keys.
supportedRequests() - Method in interface com.sshtools.ssh2.GlobalRequestHandler
Return the supported request types.
supportedSsh2CiphersCS() - Method in class com.sshtools.ssh.components.ComponentManager
The supported SSH2 ciphers.
supportedSsh2CiphersSC() - Method in class com.sshtools.ssh.components.ComponentManager
The supported SSH2 ciphers.
supportsExtension(String) - Method in class com.sshtools.sftp.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.SftpClient
Create a symbolic link on the remote computer.

T

TEXT_ALL - Static variable in class com.sshtools.util.EOLProcessor
This input style instructs the conversion to strip all line ending type characters and replace with the output style line ending
TEXT_ALL - Static variable in class com.sshtools.util.TextConversionStream
This input style instructs the conversion to strip all line ending type characters and replace with the output style line ending
TEXT_CR - Static variable in class com.sshtools.util.EOLProcessor
This indicates a CR line ending style and can be used for either input or output style parameters
TEXT_CR - Static variable in class com.sshtools.util.TextConversionStream
This indicates a CR line ending style and can be used for either input or output style parameters
TEXT_CRLF - Static variable in class com.sshtools.util.EOLProcessor
 
TEXT_CRLF - Static variable in class com.sshtools.util.TextConversionStream
 
TEXT_DOS - Static variable in class com.sshtools.util.EOLProcessor
This indicates a CRLF line ending combinarion and can be used for both input and output style parameters.
TEXT_DOS - Static variable in class com.sshtools.util.TextConversionStream
This indicates a CRLF line ending combinarion and can be used for both input and output style parameters.
TEXT_LF - Static variable in class com.sshtools.util.EOLProcessor
This indicates a single LF line ending style and can be used for either input or output style parameters
TEXT_LF - Static variable in class com.sshtools.util.TextConversionStream
This indicates a single LF line ending style and can be used for either input or output style parameters
TEXT_MAC - Static variable in class com.sshtools.util.EOLProcessor
This indicates a MAC line ending and can be used in either the input or output style parameters
TEXT_MAC - Static variable in class com.sshtools.util.TextConversionStream
This indicates a MAC line ending and can be used in either the input or output style parameters
TEXT_SYSTEM - Static variable in class com.sshtools.util.EOLProcessor
This output style specifies that the text will have line endings set to the current system setting.
TEXT_SYSTEM - Static variable in class com.sshtools.util.TextConversionStream
This output style specifies that the text will have line endings set to the current system setting.
TEXT_UNIX - Static variable in class com.sshtools.util.EOLProcessor
This indicates a LF line ending style and can be used for either input or output style parameters
TEXT_UNIX - Static variable in class com.sshtools.util.TextConversionStream
This indicates a LF line ending style and can be used for either input or output style parameters
TEXT_WINDOWS - Static variable in class com.sshtools.util.EOLProcessor
This indicates a CRLF line ending combinarion and can be used for both input and output style parameters.
TEXT_WINDOWS - Static variable in class com.sshtools.util.TextConversionStream
This indicates a CRLF line ending combinarion and can be used for both input and output style parameters.
TextConversionStream - Class in com.sshtools.util
This class processes text data and corrects line endings according to the settings provided.
TextConversionStream(int, int, OutputStream) - Constructor for class com.sshtools.util.TextConversionStream
 
ThreadSynchronizer - Class in com.sshtools.ssh.message
 
ThreadSynchronizer(boolean) - Constructor for class com.sshtools.ssh.message.ThreadSynchronizer
 
toArray() - Method in class com.sshtools.ssh.components.ComponentFactory
 
toByteArray() - Method in class com.sshtools.sftp.SftpFileAttributes
Returns a formatted byte array suitable for encoding into SFTP subsystem messages.
toByteArray() - Method in class com.sshtools.ssh.PseudoTerminalModes
Returns the encoded modes for use by the SshSession.
toByteArray() - Method in class com.sshtools.util.SimpleASNWriter
 
toByteArray() - Method in class com.sshtools.util.UnsignedInteger64
Returns a byte array encoded with the unsigned integer.
toKeyPair(String) - Method in interface com.sshtools.publickey.SshPrivateKeyFile
Decode the private key using the users passphrase.
TOO_MANY_CONNECTIONS - Static variable in class com.sshtools.ssh2.TransportProtocol
Disconnect reason: Too many connections, try later
toPublicKey() - Method in class com.sshtools.publickey.OpenSSHPublicKeyFile
 
toPublicKey() - Method in class com.sshtools.publickey.SECSHPublicKeyFile
 
toPublicKey() - Method in interface com.sshtools.publickey.SshPublicKeyFile
Convert the key file into a usable SshPublicKey.
TOSTOP - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Stop background jobs from output.
toString() - Method in class com.sshtools.events.EventObject
Returns a String representation of this EventObject.
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
 
toString() - Method in class com.sshtools.ssh2.Ssh2Client
 
toString() - Method in class com.sshtools.util.UnsignedInteger32
Returns a String representation of the unsigned integer.
toString() - Method in class com.sshtools.util.UnsignedInteger64
Return a String representation of the unsigned integer
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.
transform(byte[], int, byte[], int, int) - Method in class com.sshtools.ssh.components.jce.AbstractJCECipher
 
transform(byte[], int, byte[], int, int) - Method in class com.sshtools.ssh.components.NoneCipher
Transform the byte array according to the cipher mode; it is legal for the source and destination arrays to reference the same physical array so care should be taken in the transformation process to safeguard this rule.
transform(byte[]) - Method in class com.sshtools.ssh.components.SshCipher
Transform the byte array according to the cipher mode.
transform(byte[], int, byte[], int, int) - Method in class com.sshtools.ssh.components.SshCipher
Transform the byte array according to the cipher mode; it is legal for the source and destination arrays to reference the same physical array so care should be taken in the transformation process to safeguard this rule.
transport - Variable in class com.sshtools.ssh.components.SshKeyExchangeClient
The transport protocol for sending/receiving messages
TransportProtocol - Class in com.sshtools.ssh2
Main implementation of the SSH Transport Protocol.
TransportProtocol() - Constructor for class com.sshtools.ssh2.TransportProtocol
Create a default transport protocol instance in CLIENT_MODE.
TransportProtocolListener - Interface in com.sshtools.ssh2
 
TripleDesCbc - Class in com.sshtools.ssh.components.jce
An implementation of the 3DES cipher using a JCE provider.
TripleDesCbc() - Constructor for class com.sshtools.ssh.components.jce.TripleDesCbc
 
TripleDesCtr - Class in com.sshtools.ssh.components.jce
An implementation of the 3DES cipher using a JCE provider.
TripleDesCtr() - Constructor for class com.sshtools.ssh.components.jce.TripleDesCtr
 
TTY_OP_ISPEED - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Specifies the input baud rate in bits per second.
TTY_OP_OSPEED - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Specifies the output baud rate in bits per second.

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 interface com.sshtools.ssh.compression.SshCompression
Uncompress a block of data.
uncompress(byte[], int, int) - Method in class com.sshtools.zlib.ZLibCompression
 
UNEXPECTED_TERMINATION - Static variable in exception com.sshtools.ssh.SshException
The connection unexpectedly terminated and so the connection can no longer be used.
UNKNOWN_CHANNEL_TYPE - Static variable in exception com.sshtools.ssh.ChannelOpenException
The channel type is unknown
UnsignedInteger32 - Class in com.sshtools.util
This class provides a 32bit unsigned integer.
UnsignedInteger32(long) - Constructor for class com.sshtools.util.UnsignedInteger32
Creates a new UnsignedInteger32 object.
UnsignedInteger32(String) - Constructor for class com.sshtools.util.UnsignedInteger32
Creates a new UnsignedInteger32 object.
UnsignedInteger64 - Class in com.sshtools.util
This class provides a 64bit unsigned integer.
UnsignedInteger64(String) - Constructor for class com.sshtools.util.UnsignedInteger64
Creates a new UnsignedInteger64 object.
UnsignedInteger64(byte[]) - Constructor for class com.sshtools.util.UnsignedInteger64
Creates a new UnsignedInteger64 object.
UnsignedInteger64(long) - Constructor for class com.sshtools.util.UnsignedInteger64
 
UnsignedInteger64(BigInteger) - Constructor for class com.sshtools.util.UnsignedInteger64
Creates a new UnsignedInteger64 object.
UNSUPPORTED_ALGORITHM - Static variable in exception com.sshtools.ssh.SshException
In setting up a context an algorithm was specified that is not supported by the API.
update(byte[]) - Method in class com.sshtools.ssh.components.jce.AbstractHmac
 
update(byte[]) - Method in class com.sshtools.ssh.components.NoneHmac
 
update(byte[]) - Method in interface com.sshtools.ssh.components.SshHmac
 
URLUTF8Encoder - Class in com.sshtools.util
Provides a method to encode any string into a URL-safe form.
URLUTF8Encoder() - Constructor for class com.sshtools.util.URLUTF8Encoder
 

V

valueOf(String) - Static method in enum com.sshtools.logging.LoggerLevel
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.sshtools.logging.LoggerLevel
Returns an array containing the constants of this enum type, in the order they are declared.
VDISCARD - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Toggles the flushing of terminal output.
VDSUSP - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Another suspend character.
VEOF - Static variable in class com.sshtools.ssh.PseudoTerminalModes
End-of-file character (sends EOF from the terminal).
VEOL - Static variable in class com.sshtools.ssh.PseudoTerminalModes
End-of-line character in addition to carriage return and/or linefeed.
VEOL2 - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Additional end-of-line character.
VERASE - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Erase the character to left of the cursor.
verify(long, byte[], int, int, byte[], int) - Method in class com.sshtools.ssh.components.jce.AbstractHmac
 
verify(long, byte[], int, int, byte[], int) - Method in class com.sshtools.ssh.components.NoneHmac
 
verify(long, byte[], int, int, byte[], int) - Method in interface com.sshtools.ssh.components.SshHmac
 
verifyHost(String, SshPublicKey) - Method in class com.sshtools.publickey.AbstractKnownHostsKeyVerification
Verifies a host key against the list of known_hosts.
verifyHost(String, SshPublicKey) - Method in interface com.sshtools.ssh.HostKeyVerification
Verify that the public key is acceptable for the host.
verifySignature(byte[], byte[]) - Method in class com.sshtools.ssh.components.jce.Ssh2DsaPublicKey
Verify the signature.
verifySignature(byte[], byte[]) - Method in class com.sshtools.ssh.components.jce.Ssh2RsaPublicKey
 
verifySignature(byte[], byte[]) - Method in interface com.sshtools.ssh.components.SshPublicKey
Verify the signature.
VFLUSH - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Character to flush output.
VINTR - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Interrupt character; 255 if none.
VKILL - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Kill the current input line.
VLNEXT - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Enter the next character typed literally, even if it is a special character
VQUIT - Static variable in class com.sshtools.ssh.PseudoTerminalModes
The quit character (sends SIGQUIT signal on POSIX systems).
VREPRINT - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Reprints the current input line.
VSTART - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Continues paused output (normally control-Q).
VSTATUS - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Prints system status line (load, command, pid, etc).
VSTOP - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Pauses output (normally control-S).
VSUSP - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Suspends the current program.
VSWITCH - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Switch to a different shell layer.
VWERASE - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Erases a word left of cursor.

W

waitForResponse() - Method in class com.sshtools.scp.ScpClientIO.ScpEngineIO
 
wantsNotification(Message) - Method in interface com.sshtools.ssh.message.MessageObserver
 
white_SPACE - Static variable in class com.sshtools.net.HttpHeader
 
write(byte[], int, int) - Method in class com.sshtools.sftp.SftpFileOutputStream
 
write(int) - Method in class com.sshtools.sftp.SftpFileOutputStream
 
write(int) - Method in class com.sshtools.util.Base64.OutputStream
 
write(byte[], int, int) - Method in class com.sshtools.util.Base64.OutputStream
 
write(int) - Method in class com.sshtools.util.DynamicBuffer
Write a byte array to the buffer
write(byte[], int, int) - Method in class com.sshtools.util.DynamicBuffer
 
write(int) - Method in class com.sshtools.util.TextConversionStream
 
write(byte[], int, int) - Method in class com.sshtools.util.TextConversionStream
 
writeBigInteger(BigInteger) - Method in class com.sshtools.util.ByteArrayWriter
Write a BigInteger to the array.
writeBinaryString(byte[]) - Method in class com.sshtools.util.ByteArrayWriter
Write a binary string to the array.
writeBinaryString(byte[], int, int) - Method in class com.sshtools.util.ByteArrayWriter
Write a binary string to the array.
writeBoolean(boolean) - Method in class com.sshtools.util.ByteArrayWriter
Write a boolean value to the array.
writeByte(int) - Method in class com.sshtools.util.SimpleASNWriter
 
writeCompleteFile(InputStream, long, FileTransferProgress) - Method in class com.sshtools.scp.ScpClientIO.ScpEngineIO
 
writeData(byte[]) - Method in class com.sshtools.util.SimpleASNWriter
 
writeError(String) - Method in class com.sshtools.scp.ScpClientIO.ScpEngineIO
 
writeFile(byte[], UnsignedInteger64, byte[], int, int) - Method in class com.sshtools.sftp.SftpSubsystemChannel
Write a block of data to an open file.
writeInt(long) - Method in class com.sshtools.util.ByteArrayWriter
Write an integer to the array
writeInt(int) - Method in class com.sshtools.util.ByteArrayWriter
Write an integer to the array.
writeLength(int) - Method in class com.sshtools.util.SimpleASNWriter
 
writeMPINT(BigInteger) - Method in class com.sshtools.util.ByteArrayWriter
 
writeOk() - Method in class com.sshtools.scp.ScpClientIO.ScpEngineIO
 
writepos - Variable in class com.sshtools.util.DynamicBuffer
The current write position
writeShort(short) - Method in class com.sshtools.util.ByteArrayWriter
 
writeStreamToRemote(InputStream, long, String, FileTransferProgress) - Method in class com.sshtools.scp.ScpClientIO.ScpEngineIO
Write a stream as a file to the remote server.
writeString(String) - Method in class com.sshtools.util.ByteArrayWriter
Write a string to the byte array.
writeString(String, String) - Method in class com.sshtools.util.ByteArrayWriter
Write a String to the byte array converting the bytes using the given character set.
writeUINT32(UnsignedInteger32) - Method in class com.sshtools.util.ByteArrayWriter
 
writeUINT64(UnsignedInteger64) - Method in class com.sshtools.util.ByteArrayWriter
 
writeUINT64(long) - Method in class com.sshtools.util.ByteArrayWriter
 

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
X509V3_SIGN_DSA - Static variable in class com.sshtools.ssh.components.jce.SshX509DsaPublicKey
 
X509V3_SIGN_RSA - Static variable in class com.sshtools.ssh.components.jce.SshX509RsaPublicKey
 
X509V3_SIGN_RSA_SHA1 - Static variable in class com.sshtools.ssh.components.jce.SshX509RsaSha1PublicKey
 
XCASE - Static variable in class com.sshtools.ssh.PseudoTerminalModes
Enable input and output of uppercase characters by preceding their lowercase equivalents with "\".

Z

ZLibCompression - Class in com.sshtools.zlib
 
ZLibCompression() - Constructor for class com.sshtools.zlib.ZLibCompression
 
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 

Copyright © 2014. All rights reserved.