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

A

AbstractCommandTask - Class in com.sshtools.client.tasks
An abstract task for executing commands.
AbstractCommandTask(SshConnection, String, String) - Constructor for class com.sshtools.client.tasks.AbstractCommandTask
 
AbstractCommandTask(SshConnection, String, String, ChannelRequestFuture) - Constructor for class com.sshtools.client.tasks.AbstractCommandTask
 
AbstractCommandTask(SshConnection, String) - Constructor for class com.sshtools.client.tasks.AbstractCommandTask
 
AbstractCommandTask(SshConnection, String, ChannelRequestFuture) - Constructor for class com.sshtools.client.tasks.AbstractCommandTask
 
AbstractKeyboardInteractiveCallback - Class in com.sshtools.client
 
AbstractKeyboardInteractiveCallback() - Constructor for class com.sshtools.client.AbstractKeyboardInteractiveCallback
 
AbstractSessionChannel - Class in com.sshtools.client
Implements the client side of the SSH Connection protocol session channel
AbstractSessionChannel(int, int, int, int, boolean) - Constructor for class com.sshtools.client.AbstractSessionChannel
 
AbstractSessionChannel(int, int, int, int, ChannelRequestFuture, boolean) - Constructor for class com.sshtools.client.AbstractSessionChannel
 
AbstractSessionTask<T extends AbstractSessionChannel> - Class in com.sshtools.client.tasks
An abstract task for using the SSH session
AbstractSessionTask(SshClient, ChannelRequestFuture) - Constructor for class com.sshtools.client.tasks.AbstractSessionTask
 
AbstractSessionTask(SshConnection, ChannelRequestFuture) - Constructor for class com.sshtools.client.tasks.AbstractSessionTask
 
AbstractSessionTask(SshConnection) - Constructor for class com.sshtools.client.tasks.AbstractSessionTask
 
AbstractShellTask<T extends AbstractSessionChannel> - Class in com.sshtools.client.tasks
An abstract task for starting the shell.
AbstractShellTask(SshConnection) - Constructor for class com.sshtools.client.tasks.AbstractShellTask
 
AbstractShellTask(SshClient) - Constructor for class com.sshtools.client.tasks.AbstractShellTask
 
AbstractSubsystem - Class in com.sshtools.client.tasks
An abstract task for connecting to an SSH subsystem.
AbstractSubsystem(SshConnection) - Constructor for class com.sshtools.client.tasks.AbstractSubsystem
 
AbstractSubsystemTask - Class in com.sshtools.client.tasks
An abstract task for connecting to an SSH subsystem.
AbstractSubsystemTask(SshConnection) - Constructor for class com.sshtools.client.tasks.AbstractSubsystemTask
 
addAuthentication(Collection<ClientAuthenticator>) - Method in class com.sshtools.client.AuthenticationProtocolClient
 
addAuthentication(ClientAuthenticator) - Method in class com.sshtools.client.AuthenticationProtocolClient
 
addAuthenticator(ClientAuthenticator) - Method in class com.sshtools.client.SshClientContext
 
addCustomRoot(String) - Method in class com.sshtools.client.sftp.SftpClient
Add a custom file system root path such as "flash:"
addCustomRoot(String) - Method in class com.sshtools.client.sftp.SftpClientTask
Add a custom file system root path such as "flash:"
addDirectoryOperation(DirectoryOperation, AbstractFile) - Method in class com.sshtools.client.sftp.DirectoryOperation
Add the contents of another directory operation.
addDirectoryOperation(DirectoryOperation, String) - Method in class com.sshtools.client.sftp.DirectoryOperation
Add the contents of another directory operation.
addGlobalRequestHandler(GlobalRequestHandler<SshClientContext>) - Method in class com.sshtools.client.SshClientContext
 
addStateListener(ClientStateListener) - Method in class com.sshtools.client.SshClientContext
 
addTask(Task) - Method in class com.sshtools.client.SshClient
 
allocatePseudoTerminal(String) - Method in class com.sshtools.client.AbstractSessionChannel
 
allocatePseudoTerminal(String, int, int) - Method in class com.sshtools.client.AbstractSessionChannel
 
allocatePseudoTerminal(String, int, int, PseudoTerminalModes) - Method in class com.sshtools.client.AbstractSessionChannel
 
allocatePseudoTerminal(String, int, int, int, int, PseudoTerminalModes) - Method in class com.sshtools.client.AbstractSessionChannel
 
append(InputStream, String) - Method in class com.sshtools.client.sftp.SftpClient
 
append(InputStream, String, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClient
 
append(String, String) - Method in class com.sshtools.client.sftp.SftpClient
 
append(String, String, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClient
 
AsyncSessionTask - Class in com.sshtools.client.tasks
An task for using the SSH session asynchronously
AsyncSessionTask(Connection<SshClientContext>, ChannelRequestFuture) - Constructor for class com.sshtools.client.tasks.AsyncSessionTask
 
AsyncSessionTask(Connection<SshClientContext>) - Constructor for class com.sshtools.client.tasks.AsyncSessionTask
 
authenticate(TransportProtocolClient, String) - Method in interface com.sshtools.client.ClientAuthenticator
Start the authentication
authenticate(AuthenticationProtocolClient, SshConnection, Set<String>, boolean) - Method in interface com.sshtools.client.ClientStateListener
 
authenticate(TransportProtocolClient, String) - Method in class com.sshtools.client.ExternalKeyAuthenticator
 
authenticate(TransportProtocolClient, String) - Method in class com.sshtools.client.KeyboardInteractiveAuthenticator
 
authenticate(TransportProtocolClient, String) - Method in class com.sshtools.client.KeyPairAuthenticator
 
authenticate(TransportProtocolClient, String) - Method in class com.sshtools.client.NoneAuthenticator
 
authenticate(TransportProtocolClient, String) - Method in class com.sshtools.client.PasswordAuthenticator
 
authenticate(TransportProtocolClient, String) - Method in class com.sshtools.client.PrivateKeyFileAuthenticator
 
authenticate(TransportProtocolClient, String) - Method in class com.sshtools.client.PublicKeyAuthenticator
 
authenticate(ClientAuthenticator, long) - Method in class com.sshtools.client.SshClient
 
AuthenticationMessage - Class in com.sshtools.client
 
AuthenticationMessage(String, String, String) - Constructor for class com.sshtools.client.AuthenticationMessage
 
AuthenticationProtocolClient - Class in com.sshtools.client
Implements the client side of the SSH authentication protocol.
AuthenticationProtocolClient(TransportProtocolClient, SshClientContext, String) - Constructor for class com.sshtools.client.AuthenticationProtocolClient
 
authenticationStarted(AuthenticationProtocolClient, SshConnection) - Method in interface com.sshtools.client.ClientStateListener
 
available() - Method in class com.sshtools.client.sftp.SftpFileInputStream
 

B

BannerDisplay - Interface in com.sshtools.client
Callback interface to display authentication banner messages.
beforeExecuteCommand(SessionChannelNG) - Method in class com.sshtools.client.tasks.AbstractCommandTask
 
beforeStartShell(T) - Method in class com.sshtools.client.tasks.AbstractShellTask
 
beforeStartShell(SessionChannelNG) - Method in class com.sshtools.client.tasks.ShellTask
 
buffer - Variable in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
 

C

calculateExchangeHash() - Method in class com.sshtools.client.components.Curve25519SHA256Client
 
calculateExchangeHash() - Method in class com.sshtools.client.components.DiffieHellmanEcdh
 
calculateExchangeHash() - Method in class com.sshtools.client.components.DiffieHellmanGroupExchange
Calculates the exchange hash as an SHA1 hash of the following data.
calculateExchangeHash() - Method in class com.sshtools.client.components.Rsa1024Sha1
Calculates the exchange hash as an SHA1 hash of the following data.
calculateExchangeHash() - Method in class com.sshtools.client.components.Rsa2048Sha256
Calculates the exchange hash as an SHA1 hash of the following data.
calculateExchangeHash() - Method in class com.sshtools.client.SshKeyExchangeClient
Calculates the exchange hash as an SHA1 hash of the following data.
cancel() - Method in interface com.sshtools.client.ClientAuthenticator
 
cancel() - Method in interface com.sshtools.client.KeyboardInteractivePromptCompletor
 
cancel() - Method in class com.sshtools.client.SimpleClientAuthenticator
 
canConnect(SocketConnection) - Method in class com.sshtools.client.TransportProtocolClient
 
canRead() - Method in class com.sshtools.client.sftp.SftpFile
Determine whether the user has read access to the file.
canStartShell(String, ShellWriter) - Method in class com.sshtools.client.shell.ShellStartupPasswordTrigger
 
canStartShell(String, ShellWriter) - Method in interface com.sshtools.client.shell.ShellStartupTrigger
 
canWrite() - Method in class com.sshtools.client.sftp.SftpFile
Determine whether the user has write access to the file.
carriageReturn() - Method in class com.sshtools.client.shell.ShellController
 
carriageReturn() - Method in interface com.sshtools.client.shell.ShellWriter
Send a carriage return to the remote command.
cd(String) - Method in class com.sshtools.client.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.
cd(String) - Method in class com.sshtools.client.sftp.SftpClientTask
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.client.sftp.SftpClient
Change the working directory to the parent directory
cdup() - Method in class com.sshtools.client.sftp.SftpClientTask
Change the working directory to the parent directory
changePermissions(SftpFile, int) - Method in class com.sshtools.client.sftp.SftpChannel
Change the permissions of a file.
changePermissions(String, int) - Method in class com.sshtools.client.sftp.SftpChannel
Change the permissions of a file.
changePermissions(String, String) - Method in class com.sshtools.client.sftp.SftpChannel
Change the permissions of a file.
changeTerminalDimensions(int, int, int, int) - Method in class com.sshtools.client.AbstractSessionChannel
 
changeTerminalDimensions(int, int, int, int) - Method in class com.sshtools.client.tasks.AbstractSessionTask
 
checkWindowSpace() - Method in class com.sshtools.client.SessionChannelNG
 
chgrp(String, String) - Method in class com.sshtools.client.sftp.SftpClient
Sets the group ID for the file or directory.
chgrp(String, String) - Method in class com.sshtools.client.sftp.SftpClientTask
Sets the group ID for the file or directory.
chmod(int, String) - Method in class com.sshtools.client.sftp.SftpClient
Changes the access permissions or modes of the specified file or directory.
chmod(int, String) - Method in class com.sshtools.client.sftp.SftpClientTask
Changes the access permissions or modes of the specified file or directory.
chown(String, String) - Method in class com.sshtools.client.sftp.SftpClient
Sets the user ID to owner for the file or directory.
chown(String, String) - Method in class com.sshtools.client.sftp.SftpClientTask
Sets the user ID to owner for the file or directory.
ClientAuthenticator - Interface in com.sshtools.client
Base interface for all client authentication methods.
ClientEventCodes - Class in com.sshtools.client.events
List of unique Client Event codes
ClientEventCodes() - Constructor for class com.sshtools.client.events.ClientEventCodes
 
clientId - Variable in class com.sshtools.client.SshKeyExchangeClient
 
clientKexInit - Variable in class com.sshtools.client.SshKeyExchangeClient
 
ClientStateListener - Interface in com.sshtools.client
 
close() - Method in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
Close the SCP engine and underlying session.
close() - Method in class com.sshtools.client.sftp.SftpChannel
 
close() - Method in class com.sshtools.client.sftp.SftpFile
Close the file.
close() - Method in class com.sshtools.client.sftp.SftpFileInputStream
Closes the SFTP file handle.
close() - Method in class com.sshtools.client.sftp.SftpFileOutputStream
Closes the file's handle
close() - Method in class com.sshtools.client.shell.ExpectShell
 
close() - Method in class com.sshtools.client.SshClient
 
close() - Method in class com.sshtools.client.tasks.AbstractSessionTask
 
close() - Method in class com.sshtools.client.tasks.AsyncSessionTask
 
closeFile(SftpFile) - Method in class com.sshtools.client.sftp.SftpChannel
Close a file or directory.
cmd - Variable in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
 
com.sshtools.client - package com.sshtools.client
 
com.sshtools.client.components - package com.sshtools.client.components
 
com.sshtools.client.events - package com.sshtools.client.events
 
com.sshtools.client.scp - package com.sshtools.client.scp
 
com.sshtools.client.sftp - package com.sshtools.client.sftp
 
com.sshtools.client.shell - package com.sshtools.client.shell
 
com.sshtools.client.tasks - package com.sshtools.client.tasks
 
complete() - Method in interface com.sshtools.client.KeyboardInteractivePromptCompletor
 
completed() - Method in interface com.sshtools.client.tasks.FileTransferProgress
The transfer has completed.
completeKeyExchange(SshKeyExchange<SshClientContext>) - Method in class com.sshtools.client.TransportProtocolClient
 
con - Variable in class com.sshtools.client.tasks.AbstractSubsystem
 
configure(SshClientContext) - Method in class com.sshtools.client.SshClient
 
configureKeyExchanges() - Method in class com.sshtools.client.SshClientContext
 
connection - Variable in class com.sshtools.client.AbstractKeyboardInteractiveCallback
 
ConnectionProtocolClient - Class in com.sshtools.client
Implements the client side of the SSH connection prototocol
ConnectionProtocolClient(TransportProtocol<SshClientContext>, String) - Constructor for class com.sshtools.client.ConnectionProtocolClient
 
containsFile(AbstractFile) - Method in class com.sshtools.client.sftp.DirectoryOperation
Determine whether the operation contains a file.
containsFile(SftpFile) - Method in class com.sshtools.client.sftp.DirectoryOperation
Determine whether the directory operation contains an SftpFile
copyRemoteData(SftpFile, UnsignedInteger64, UnsignedInteger64, SftpFile, UnsignedInteger64) - Method in class com.sshtools.client.sftp.SftpClient
 
copyRemoteFile(String, String, boolean) - Method in class com.sshtools.client.sftp.SftpClient
 
createChannel() - Method in class com.sshtools.client.AbstractSessionChannel
 
createChannel(String, Connection<SshClientContext>) - Method in class com.sshtools.client.ConnectionProtocolClient
Create an SSH channel.
createChannel(String, SshConnection) - Method in class com.sshtools.client.DefaultClientChannelFactory
Called when a channel needs to be created.
createChannel(String, SshConnection, String, int, SocketChannel, SshClientContext) - Method in class com.sshtools.client.LocalForwardingFactoryImpl
 
createEngine(ConnectRequestFuture) - Method in class com.sshtools.client.SshClientContext
 
createLink(String, String, boolean) - Method in class com.sshtools.client.sftp.SftpChannel
Create a symbolic link.
createPacket() - Method in class com.sshtools.client.sftp.SftpChannel
Get a packet from the available pool or create if non available
createSession(SshConnection) - Method in class com.sshtools.client.tasks.AbstractCommandTask
 
createSession(SshConnection) - Method in class com.sshtools.client.tasks.AbstractSessionTask
 
createSession() - Method in class com.sshtools.client.tasks.AbstractSubsystemTask
 
createSession(SshConnection) - Method in class com.sshtools.client.tasks.ShellTask
 
createSubsystem(String, SessionChannel) - Method in class com.sshtools.client.DefaultClientChannelFactory
Request to create a subsystem.
createSymbolicLink(String, String) - Method in class com.sshtools.client.sftp.SftpChannel
Create a symbolic link.
CS7 - Static variable in class com.sshtools.client.PseudoTerminalModes
7 bit mode.
CS8 - Static variable in class com.sshtools.client.PseudoTerminalModes
8 bit mode.
CURVE25519_SHA2 - Static variable in class com.sshtools.client.components.Curve25519SHA256Client
 
CURVE25519_SHA2_AT_LIBSSH_ORG - Static variable in class com.sshtools.client.components.Curve25519SHA256LibSshClient
 
Curve25519SHA256Client - Class in com.sshtools.client.components
 
Curve25519SHA256Client() - Constructor for class com.sshtools.client.components.Curve25519SHA256Client
 
Curve25519SHA256Client(String) - Constructor for class com.sshtools.client.components.Curve25519SHA256Client
 
Curve25519SHA256LibSshClient - Class in com.sshtools.client.components
 
Curve25519SHA256LibSshClient() - Constructor for class com.sshtools.client.components.Curve25519SHA256LibSshClient
 

D

DefaultClientChannelFactory - Class in com.sshtools.client
Implements a default ChannelFactory for an SSH client.
DefaultClientChannelFactory() - Constructor for class com.sshtools.client.DefaultClientChannelFactory
 
delete() - Method in class com.sshtools.client.sftp.SftpFile
Delete this file/directory from the remote server.
DIFFIE_HELLMAN_GROUP14_SHA1 - Static variable in class com.sshtools.client.components.DiffieHellmanGroup14Sha1JCE
Constant for the algorithm name "diffie-hellman-group14-sha1".
DIFFIE_HELLMAN_GROUP14_SHA256 - Static variable in class com.sshtools.client.components.DiffieHellmanGroup14Sha256JCE
Constant for the algorithm name "diffie-hellman-group14-sha256".
DIFFIE_HELLMAN_GROUP15_SHA512 - Static variable in class com.sshtools.client.components.DiffieHellmanGroup15Sha512JCE
Constant for the algorithm name "diffie-hellman-group15-sha512".
DIFFIE_HELLMAN_GROUP16_SHA512 - Static variable in class com.sshtools.client.components.DiffieHellmanGroup16Sha512JCE
Constant for the algorithm name "diffie-hellman-group16-sha512".
DIFFIE_HELLMAN_GROUP17_SHA512 - Static variable in class com.sshtools.client.components.DiffieHellmanGroup17Sha512JCE
Constant for the algorithm name "diffie-hellman-group16-sha512".
DIFFIE_HELLMAN_GROUP18_SHA512 - Static variable in class com.sshtools.client.components.DiffieHellmanGroup18Sha512JCE
Constant for the algorithm name "diffie-hellman-group16-sha512".
DIFFIE_HELLMAN_GROUP1_SHA1 - Static variable in class com.sshtools.client.components.DiffieHellmanGroup1Sha1JCE
Constant for the algorithm name "diffie-hellman-group1-sha1".
DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA1 - Static variable in class com.sshtools.client.components.DiffieHellmanGroupExchangeSha1JCE
Constant for the algorithm name "diffie-hellman-group1-sha1".
DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA256 - Static variable in class com.sshtools.client.components.DiffieHellmanGroupExchangeSha256JCE
Constant for the algorithm name "diffie-hellman-exchange-sha256".
DiffieHellmanEcdh - Class in com.sshtools.client.components
 
DiffieHellmanEcdh(String, String, String, SecurityLevel, int) - Constructor for class com.sshtools.client.components.DiffieHellmanEcdh
 
DiffieHellmanEcdhNistp256 - Class in com.sshtools.client.components
 
DiffieHellmanEcdhNistp256() - Constructor for class com.sshtools.client.components.DiffieHellmanEcdhNistp256
 
DiffieHellmanEcdhNistp384 - Class in com.sshtools.client.components
 
DiffieHellmanEcdhNistp384() - Constructor for class com.sshtools.client.components.DiffieHellmanEcdhNistp384
 
DiffieHellmanEcdhNistp521 - Class in com.sshtools.client.components
 
DiffieHellmanEcdhNistp521() - Constructor for class com.sshtools.client.components.DiffieHellmanEcdhNistp521
 
DiffieHellmanGroup - Class in com.sshtools.client.components
Implementation of the required SSH Transport Protocol key exchange method "diffie-hellman-group14-sha1".
DiffieHellmanGroup14Sha1JCE - Class in com.sshtools.client.components
Implementation of the required SSH Transport Protocol key exchange method "diffie-hellman-group14-sha1".
DiffieHellmanGroup14Sha1JCE() - Constructor for class com.sshtools.client.components.DiffieHellmanGroup14Sha1JCE
 
DiffieHellmanGroup14Sha256JCE - Class in com.sshtools.client.components
Implementation of the required SSH Transport Protocol key exchange method "diffie-hellman-group14-sha1".
DiffieHellmanGroup14Sha256JCE() - Constructor for class com.sshtools.client.components.DiffieHellmanGroup14Sha256JCE
 
DiffieHellmanGroup15Sha512JCE - Class in com.sshtools.client.components
Implementation of the required SSH Transport Protocol key exchange method "diffie-hellman-group14-sha1".
DiffieHellmanGroup15Sha512JCE() - Constructor for class com.sshtools.client.components.DiffieHellmanGroup15Sha512JCE
 
DiffieHellmanGroup16Sha512JCE - Class in com.sshtools.client.components
Implementation of the required SSH Transport Protocol key exchange method "diffie-hellman-group14-sha1".
DiffieHellmanGroup16Sha512JCE() - Constructor for class com.sshtools.client.components.DiffieHellmanGroup16Sha512JCE
 
DiffieHellmanGroup17Sha512JCE - Class in com.sshtools.client.components
Implementation of the required SSH Transport Protocol key exchange method "diffie-hellman-group14-sha1".
DiffieHellmanGroup17Sha512JCE() - Constructor for class com.sshtools.client.components.DiffieHellmanGroup17Sha512JCE
 
DiffieHellmanGroup18Sha512JCE - Class in com.sshtools.client.components
Implementation of the required SSH Transport Protocol key exchange method "diffie-hellman-group14-sha1".
DiffieHellmanGroup18Sha512JCE() - Constructor for class com.sshtools.client.components.DiffieHellmanGroup18Sha512JCE
 
DiffieHellmanGroup1Sha1JCE - Class in com.sshtools.client.components
Implementation of the required SSH Transport Protocol key exchange method "diffie-hellman-group1-sha1".
DiffieHellmanGroup1Sha1JCE() - Constructor for class com.sshtools.client.components.DiffieHellmanGroup1Sha1JCE
Construct an uninitialized instance.
DiffieHellmanGroupExchange - Class in com.sshtools.client.components
Implementation of the required SSH Transport Protocol key exchange method "diffie-hellman-group-exchange-sha1".
DiffieHellmanGroupExchange(String, String, SecurityLevel, int) - Constructor for class com.sshtools.client.components.DiffieHellmanGroupExchange
Construct an uninitialized instance.
DiffieHellmanGroupExchangeSha1JCE - Class in com.sshtools.client.components
Implementation of the required SSH Transport Protocol key exchange method "diffie-hellman-group-exchange-sha1".
DiffieHellmanGroupExchangeSha1JCE() - Constructor for class com.sshtools.client.components.DiffieHellmanGroupExchangeSha1JCE
Construct an uninitialized instance.
DiffieHellmanGroupExchangeSha256JCE - Class in com.sshtools.client.components
Implementation of the required SSH Transport Protocol key exchange method "diffie-hellman-group-exchange-sha1".
DiffieHellmanGroupExchangeSha256JCE() - Constructor for class com.sshtools.client.components.DiffieHellmanGroupExchangeSha256JCE
Construct an uninitialized instance.
DirectoryOperation - Class in com.sshtools.client.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.client.sftp.DirectoryOperation
Construct a new directory operation object
disconnect() - Method in class com.sshtools.client.SshClient
 
disconnect() - Method in class com.sshtools.client.tasks.AbstractSessionTask
 
disconnect() - Method in class com.sshtools.client.tasks.AsyncSessionTask
 
disconnected() - Method in class com.sshtools.client.TransportProtocolClient
 
displayBanner(String) - Method in interface com.sshtools.client.BannerDisplay
Called when a banner message is received.
doConnect(String, int, String, SshClientContext, long) - Method in class com.sshtools.client.SshClient
 
doNextAuthentication() - Method in class com.sshtools.client.AuthenticationProtocolClient
 
doSftp() - Method in class com.sshtools.client.sftp.SftpClientTask
 
doSubsystemTask(SessionChannelNG) - Method in class com.sshtools.client.tasks.AbstractSubsystemTask
 
doTask() - Method in class com.sshtools.client.sftp.SftpClientTask
 
doTask(T, long) - Method in class com.sshtools.client.SshClient
 
doTask() - Method in class com.sshtools.client.tasks.AbstractSessionTask
 
doTask() - Method in class com.sshtools.client.tasks.AbstractSubsystemTask
 
doTask() - Method in class com.sshtools.client.tasks.DownloadFileTask
 
doTask() - Method in class com.sshtools.client.tasks.DownloadOutputStreamTask
 
doTask() - Method in class com.sshtools.client.tasks.StatTask
 
doTask() - Method in class com.sshtools.client.tasks.UploadFileContentTask
 
doTask() - Method in class com.sshtools.client.tasks.UploadFileTask
 
doTask() - Method in class com.sshtools.client.tasks.UploadInputStreamTask
 
DownloadFileTask - Class in com.sshtools.client.tasks
 
DownloadFileTask(Connection<SshClientContext>, String, File) - Constructor for class com.sshtools.client.tasks.DownloadFileTask
 
DownloadFileTask(Connection<SshClientContext>, String) - Constructor for class com.sshtools.client.tasks.DownloadFileTask
 
DownloadOutputStreamTask - Class in com.sshtools.client.tasks
 
DownloadOutputStreamTask(SshConnection, String, OutputStream) - Constructor for class com.sshtools.client.tasks.DownloadOutputStreamTask
 
DownloadOutputStreamTask(SshConnection, String) - Constructor for class com.sshtools.client.tasks.DownloadOutputStreamTask
 
drain() - Method in class com.sshtools.client.shell.ShellProcess
 

E

e - Variable in class com.sshtools.client.SshKeyExchangeClient
 
echo() - Method in class com.sshtools.client.KeyboardInteractivePrompt
true if the user response should be echo'd to the display, otherwise false.
ECHO - Static variable in class com.sshtools.client.PseudoTerminalModes
Enable echoing.
ECHOCTL - Static variable in class com.sshtools.client.PseudoTerminalModes
Echo control characters as ^(Char).
ECHOE - Static variable in class com.sshtools.client.PseudoTerminalModes
Visually erase chars.
ECHOK - Static variable in class com.sshtools.client.PseudoTerminalModes
Kill character discards current line.
ECHOKE - Static variable in class com.sshtools.client.PseudoTerminalModes
Visual erase for line kill.
ECHONL - Static variable in class com.sshtools.client.PseudoTerminalModes
Echo NL even if ECHO is off.
enableHTTPProxy(String, int, String, int, String, String, String, Map<String, String>) - Method in class com.sshtools.client.SshClientContext
 
enableSocks4Proxy(String, int, String, int, String) - Method in class com.sshtools.client.SshClientContext
 
enableSocks5Proxy(String, int, String, int, String, String, boolean) - Method in class com.sshtools.client.SshClientContext
 
EOL_CR - Static variable in class com.sshtools.client.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.client.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.client.sftp.SftpClient
Specifies that the remote server is using \n as its newline convention when used with SftpClient.setRemoteEOL(int)
equals(Object) - Method in class com.sshtools.client.sftp.SftpFile
Compares the Object to this instance and returns true if they point to the same file.
exchangeGroup(ByteArrayReader) - Method in class com.sshtools.client.components.DiffieHellmanGroupExchange
 
exchangeHash - Variable in class com.sshtools.client.SshKeyExchangeClient
The exchange hash produced during key exchange.
execute(String) - Method in class com.sshtools.client.shell.ExpectShell
 
executeCommand(String) - Method in class com.sshtools.client.AbstractSessionChannel
 
executeCommand(String, String) - Method in class com.sshtools.client.AbstractSessionChannel
 
executeCommand(SessionChannel, String[], Map<String, String>) - Method in class com.sshtools.client.DefaultClientChannelFactory
 
executeCommand(String) - Method in class com.sshtools.client.shell.ExpectShell
 
executeCommand(String, boolean) - Method in class com.sshtools.client.shell.ExpectShell
 
executeCommand(String, String) - Method in class com.sshtools.client.shell.ExpectShell
 
executeCommand(String, boolean, String) - Method in class com.sshtools.client.shell.ExpectShell
 
executeCommand(String, boolean, boolean) - Method in class com.sshtools.client.shell.ExpectShell
 
executeCommand(String, boolean, boolean, String) - Method in class com.sshtools.client.shell.ExpectShell
 
executeCommand(String) - Method in class com.sshtools.client.SshClient
 
executeCommand(String, long) - Method in class com.sshtools.client.SshClient
 
executeCommand(String, String) - Method in class com.sshtools.client.SshClient
 
executeCommand(String, long, String) - Method in class com.sshtools.client.SshClient
 
executeCommandWithResult(String, StringBuffer) - Method in class com.sshtools.client.SshClient
 
executeCommandWithResult(String, StringBuffer, long) - Method in class com.sshtools.client.SshClient
 
executeCommandWithResult(String, StringBuffer, String) - Method in class com.sshtools.client.SshClient
 
executeCommandWithResult(String, StringBuffer, long, String) - Method in class com.sshtools.client.SshClient
 
exit() - Method in class com.sshtools.client.scp.ScpClient
 
exit() - Method in class com.sshtools.client.sftp.SftpClient
Close the SFTP client.
exit() - Method in class com.sshtools.client.sftp.SftpClientTask
Close the SFTP client.
exit() - Method in class com.sshtools.client.shell.ExpectShell
 
EXIT_CODE_NOT_RECEIVED - Static variable in class com.sshtools.client.SshClient
 
EXIT_CODE_NOT_RECEIVED - Static variable in class com.sshtools.client.tasks.AbstractCommandTask
 
EXIT_CODE_PROCESS_ACTIVE - Static variable in class com.sshtools.client.shell.ExpectShell
 
EXIT_CODE_UNKNOWN - Static variable in class com.sshtools.client.shell.ExpectShell
 
EXITCODE_NOT_RECEIVED - Static variable in class com.sshtools.client.AbstractSessionChannel
 
expect(String) - Method in class com.sshtools.client.shell.ShellController
Consume the output of the command until the pattern matches.
expect(String, boolean) - Method in class com.sshtools.client.shell.ShellController
Consume the output of the command until the pattern matches.
expect(String, long) - Method in class com.sshtools.client.shell.ShellController
Consume the output of the command until the pattern matches.
expect(String, boolean, long) - Method in class com.sshtools.client.shell.ShellController
Consume the output of the command until the pattern matches.
expect(String, boolean, long, long) - Method in class com.sshtools.client.shell.ShellController
Consume the output of the command until the pattern matches.
expectNextLine(String) - Method in class com.sshtools.client.shell.ShellController
Perform expect on the next line of output only
expectNextLine(String, boolean) - Method in class com.sshtools.client.shell.ShellController
Perform expect on the next line of output only
expectNextLine(String, boolean, long) - Method in class com.sshtools.client.shell.ShellController
Perform expect on the next line of output only
ExpectShell - Class in com.sshtools.client.shell
 
ExpectShell(AbstractSessionTask<SessionChannelNG>) - Constructor for class com.sshtools.client.shell.ExpectShell
 
ExpectShell(AbstractSessionTask<SessionChannelNG>, ShellStartupTrigger) - Constructor for class com.sshtools.client.shell.ExpectShell
 
ExpectShell(AbstractSessionTask<SessionChannelNG>, ShellStartupTrigger, long) - Constructor for class com.sshtools.client.shell.ExpectShell
 
ExpectShell(AbstractSessionTask<SessionChannelNG>, ShellStartupTrigger, long, String) - Constructor for class com.sshtools.client.shell.ExpectShell
 
ExpectShell(AbstractSessionTask<SessionChannelNG>, ShellStartupTrigger, long, String, int, int) - Constructor for class com.sshtools.client.shell.ExpectShell
 
ExternalKeyAuthenticator - Class in com.sshtools.client
Implements public key authentication taking a separately loaded SshKeyPair as the private key for authentication.
ExternalKeyAuthenticator(SignatureGenerator) - Constructor for class com.sshtools.client.ExternalKeyAuthenticator
 
ExternalKeyAuthenticator() - Constructor for class com.sshtools.client.ExternalKeyAuthenticator
 

F

f - Variable in class com.sshtools.client.SshKeyExchangeClient
 
failure() - Method in interface com.sshtools.client.ClientAuthenticator
Called by the API to indicate authentication failure.
failure() - Method in class com.sshtools.client.SimpleClientAuthenticator
 
FileTransferProgress - Interface in com.sshtools.client.tasks
Interface for monitoring the state of a file transfer
finalize() - Method in class com.sshtools.client.sftp.SftpFileInputStream
This method will only be available in J2SE builds
firstPacketFollows - Variable in class com.sshtools.client.SshKeyExchangeClient
 
formatLongname(SftpFile) - Static method in class com.sshtools.client.sftp.SftpClient
Format a String with the details of the file.
formatLongname(SftpFileAttributes, String) - Static method in class com.sshtools.client.sftp.SftpClient
Format a String with the details of the file.
formatLongname(SftpFile) - Static method in class com.sshtools.client.sftp.SftpClientTask
Format a String with the details of the file.
formatLongname(SftpFileAttributes, String) - Static method in class com.sshtools.client.sftp.SftpClientTask
Format a String with the details of the file.

G

get(String, String[], boolean) - Method in class com.sshtools.client.scp.ScpClient
Downloads an array of remote files to the local computer.
get(String, String[], boolean, FileTransferProgress) - Method in class com.sshtools.client.scp.ScpClient
 
get(String, String, boolean) - Method in class com.sshtools.client.scp.ScpClient
Downloads a remote file onto the local computer.
get(String, String, boolean, FileTransferProgress) - Method in class com.sshtools.client.scp.ScpClient
 
get(String) - Method in class com.sshtools.client.scp.ScpClientIO
Gets a remote file as a java.io.InputStream.
get(String, FileTransferProgress) - Method in class com.sshtools.client.scp.ScpClientIO
Gets a remote file as a java.io.InputStream.
get(String, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote file to the local computer.
get(String, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote file to the local computer.
get(String, boolean) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote file to the local computer
get(String) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote file to the local computer
get(String, String, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote file to the local computer.
get(String, String, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote file to the local computer.
get(String, String, boolean) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote file into the local file.
get(String, String) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote file into the local file.
get(String, OutputStream, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote file writing it to the specified OutputStream.
get(String, OutputStream, FileTransferProgress, long) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote file writing it to the specified OutputStream.
get(String, OutputStream, long) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote file into an OutputStream.
get(String, OutputStream) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote file into an OutputStream.
get(String, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote file to the local computer.
get(String, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote file to the local computer.
get(String, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote file to the local computer
get(String) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote file to the local computer
get(String, String, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote file to the local computer.
get(String, String, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote file to the local computer.
get(String, String, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote file into the local file.
get(String, String) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote file into the local file.
get(String, OutputStream, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote file writing it to the specified OutputStream.
get(String, OutputStream, FileTransferProgress, long) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote file writing it to the specified OutputStream.
get(String, OutputStream, long) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote file into an OutputStream.
get(String, OutputStream) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote file into an OutputStream.
getAbsolutePath(SftpFile) - Method in class com.sshtools.client.sftp.SftpChannel
Get the absolute path of a file.
getAbsolutePath(String) - Method in class com.sshtools.client.sftp.SftpChannel
Get the absolute path of a file.
getAbsolutePath(String) - Method in class com.sshtools.client.sftp.SftpClient
Get the absolute path for a file.
getAbsolutePath(String) - Method in class com.sshtools.client.sftp.SftpClientTask
Get the absolute path for a file.
getAbsolutePath() - Method in class com.sshtools.client.sftp.SftpFile
Get the absolute path
getActiveService() - Method in class com.sshtools.client.TransportProtocolClient
 
getAlgorithm() - Method in class com.sshtools.client.components.Curve25519SHA256Client
 
getAlgorithm() - Method in class com.sshtools.client.components.DiffieHellmanEcdh
 
getAlgorithm() - Method in class com.sshtools.client.components.DiffieHellmanGroup
Get the algorithm name for this key exchange
getAlgorithm() - Method in class com.sshtools.client.components.DiffieHellmanGroupExchange
Get the algorithm name for this key exchange
getAlgorithm() - Method in class com.sshtools.client.components.Rsa1024Sha1
Get the algorithm name for this key exchange
getAlgorithm() - Method in class com.sshtools.client.components.Rsa2048Sha256
Get the algorithm name for this key exchange
getAttributes(String) - Method in class com.sshtools.client.sftp.SftpChannel
Get the attributes of a file.
getAttributes(String, int) - Method in class com.sshtools.client.sftp.SftpChannel
 
getAttributes(SftpFile) - Method in class com.sshtools.client.sftp.SftpChannel
Get the attributes of a file.
getAttributes() - Method in class com.sshtools.client.sftp.SftpFile
Get the files attributes.
getAttributes() - Method in class com.sshtools.client.tasks.StatTask
 
getAuthenticationClient() - Method in class com.sshtools.client.SshClientContext
 
getAuthenticationMethods() - Method in interface com.sshtools.client.ClientAuthenticator
 
getAuthenticationMethods() - Method in class com.sshtools.client.SimpleClientAuthenticator
 
getAuthenticationMethods() - Method in class com.sshtools.client.SshClient
 
getAuthenticators() - Method in class com.sshtools.client.SshClientContext
 
getAvail() - Method in class com.sshtools.client.sftp.StatVfs
 
getAvailBlocks() - Method in class com.sshtools.client.sftp.StatVfs
 
getAvailForNonRoot() - Method in class com.sshtools.client.sftp.StatVfs
 
getAvailINodes() - Method in class com.sshtools.client.sftp.StatVfs
 
getBannerDisplay() - Method in class com.sshtools.client.SshClientContext
 
getBlocks() - Method in class com.sshtools.client.sftp.StatVfs
 
getBlockSize() - Method in class com.sshtools.client.sftp.StatVfs
 
getBufferSize() - Method in class com.sshtools.client.tasks.AsyncSessionTask
 
getCanonicalNewline() - Method in class com.sshtools.client.sftp.SftpChannel
Returns the canonical newline convention in use when reading/writing text files.
getCapacity() - Method in class com.sshtools.client.sftp.StatVfs
 
getChannelFactory() - Method in class com.sshtools.client.SshClientContext
 
getChannelFuture() - Method in class com.sshtools.client.tasks.AbstractSessionTask
 
getChannelFuture() - Method in class com.sshtools.client.tasks.AsyncSessionTask
 
getChannelType() - Method in class com.sshtools.client.LocalForwardingFactoryImpl
 
getCharacterEncoding() - Method in class com.sshtools.client.shell.ExpectShell
 
getCharsetEncoding() - Method in class com.sshtools.client.sftp.SftpChannel
Get the current encoding being used for filename Strings.
getCommand() - Method in class com.sshtools.client.tasks.AbstractCommandTask
 
getCommandOutput() - Method in class com.sshtools.client.shell.ShellProcess
 
getConnection() - Method in class com.sshtools.client.SshClient
 
getConnectionAddress() - Method in class com.sshtools.client.TransportProtocolClient
 
getConnectionManager() - Method in class com.sshtools.client.SshClientContext
 
getContext() - Method in class com.sshtools.client.ConnectionProtocolClient
 
getContext() - Method in class com.sshtools.client.SshClient
 
getDaemonContext() - Method in class com.sshtools.client.SshClientContext
 
getDefaultDirectory() - Method in class com.sshtools.client.sftp.SftpChannel
Gets the users default directory.
getDefaultDirectory() - Method in class com.sshtools.client.sftp.SftpClient
Get the default directory (or HOME directory)
getDefaultDirectory() - Method in class com.sshtools.client.sftp.SftpClientTask
Get the default directory (or HOME directory)
getDeletedFiles() - Method in class com.sshtools.client.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.
getDownloadedFile() - Method in class com.sshtools.client.tasks.DownloadFileTask
 
getEngine() - Method in class com.sshtools.client.SshClientContext
 
getEOL(String) - Method in class com.sshtools.client.sftp.SftpClient
 
getEOL(byte[]) - Method in class com.sshtools.client.sftp.SftpClient
 
getEOL(String) - Method in class com.sshtools.client.sftp.SftpClientTask
 
getEOL(byte[]) - Method in class com.sshtools.client.sftp.SftpClientTask
 
getExchangeHash() - Method in class com.sshtools.client.SshKeyExchangeClient
Get the output of the key exchange
getExitCode() - Method in class com.sshtools.client.AbstractSessionChannel
 
getExitCode() - Method in class com.sshtools.client.shell.ShellProcess
 
getExitCode() - Method in class com.sshtools.client.tasks.AbstractCommandTask
 
getExitSignalInfo() - Method in class com.sshtools.client.AbstractSessionChannel
 
getExtension(String) - Method in class com.sshtools.client.sftp.SftpChannel
Get the data value of a supported SFTP extension.
getExtensions() - Method in class com.sshtools.client.sftp.SftpChannel
 
getFailedTransfers() - Method in class com.sshtools.client.sftp.DirectoryOperation
Returns a Hashtable of files and exceptions.
getFile(String) - Method in class com.sshtools.client.sftp.SftpChannel
Utility method to obtain an SftpFile instance for a given path.
getFile(String, int, String, char[], String, File) - Static method in class com.sshtools.client.Ssh
 
getFile(String) - Method in class com.sshtools.client.SshClient
 
getFile(String, long) - Method in class com.sshtools.client.SshClient
 
getFile(String, File) - Method in class com.sshtools.client.SshClient
 
getFile(String, File, long) - Method in class com.sshtools.client.SshClient
 
getFileCount() - Method in class com.sshtools.client.sftp.DirectoryOperation
Get the total number of new and changed files to transfer
getFilename() - Method in class com.sshtools.client.sftp.SftpFile
Get the filename.
getFiles(String) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote files to the local computer
getFiles(String, boolean) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote files to the local computer
getFiles(String, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote files to the local computer.
getFiles(String, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote files to the local computer.
getFiles(String, String) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote files into the local file.
getFiles(String, String, boolean) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote files into the local file.
getFiles(String, String, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClient
Download the remote file to the local computer.
getFiles(String) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote files to the local computer
getFiles(String, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote files to the local computer
getFiles(String, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote files to the local computer.
getFiles(String, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote files to the local computer.
getFiles(String, String) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote files into the local file.
getFiles(String, String, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote files into the local file.
getFiles(String, String, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask
Download the remote file to the local computer.
getFileSystemID() - Method in class com.sshtools.client.sftp.StatVfs
 
getForwardingManager() - Method in class com.sshtools.client.SshClientContext
 
getForwardingPolicy() - Method in class com.sshtools.client.SshClient
 
getFragmentSize() - Method in class com.sshtools.client.sftp.StatVfs
 
getFreeBlocks() - Method in class com.sshtools.client.sftp.StatVfs
 
getFreeINodes() - Method in class com.sshtools.client.sftp.StatVfs
 
getGlobalRequestHandler(String) - Method in class com.sshtools.client.SshClientContext
 
getHandle() - Method in class com.sshtools.client.sftp.SftpFile
Get the open file handle
getHandleResponse(UnsignedInteger32) - Method in class com.sshtools.client.sftp.SftpChannel
 
getHandleResponse(SftpMessage) - Method in class com.sshtools.client.sftp.SftpChannel
 
getHashAlgorithm() - Method in class com.sshtools.client.SshKeyExchangeClient
 
getHome() - Method in class com.sshtools.client.sftp.SftpClient
 
getHomeDirectory(String) - Method in class com.sshtools.client.sftp.SftpClient
 
getHost() - Method in class com.sshtools.client.SshClient
 
getHostKey() - Method in class com.sshtools.client.SshClient
 
getHostKey(String, int) - Static method in class com.sshtools.client.SshCompatibilityUtils
 
getHostKey(String, int, String) - Static method in class com.sshtools.client.SshCompatibilityUtils
 
getHostKey() - Method in class com.sshtools.client.SshKeyExchangeClient
Get the host key supplied during key exchange.
getHostKeyVerification() - Method in class com.sshtools.client.SshClientContext
 
getIdleTimeoutSeconds() - Method in class com.sshtools.client.AuthenticationProtocolClient
 
getINodes() - Method in class com.sshtools.client.sftp.StatVfs
 
getInputStream(String, long) - Method in class com.sshtools.client.sftp.SftpClient
Create an InputStream for reading a remote file.
getInputStream(String) - Method in class com.sshtools.client.sftp.SftpClient
Create an InputStream for reading a remote file.
getInputStream(String, long) - Method in class com.sshtools.client.sftp.SftpClientTask
Create an InputStream for reading a remote file.
getInputStream(String) - Method in class com.sshtools.client.sftp.SftpClientTask
Create an InputStream for reading a remote file.
getInputStream() - Method in class com.sshtools.client.shell.ShellProcess
Returns an InputStream that will contain only the output from the executed ShellProcess.
getInputStream() - Method in class com.sshtools.client.tasks.AsyncSessionTask
 
getLastError() - Method in class com.sshtools.client.tasks.AbstractSessionTask
 
getLinkAttributes(String) - Method in class com.sshtools.client.sftp.SftpChannel
Get the attributes of a file.
getLocalIdentification() - Method in class com.sshtools.client.SshClient
 
getLongname() - Method in class com.sshtools.client.sftp.SftpFile
The longname supplied by the server.
getMaximumFilenameLength() - Method in class com.sshtools.client.sftp.StatVfs
 
getMaximumLocalPacketLength() - Method in class com.sshtools.client.AbstractSessionChannel
 
getMaximumLocalPacketLength() - Method in class com.sshtools.client.sftp.SftpChannel
 
getMaximumLocalWindowSize() - Method in class com.sshtools.client.sftp.SftpChannel
 
getMaximumPacketSize() - Method in class com.sshtools.client.sftp.SftpChannel
 
getMaximumPacketSize() - Method in class com.sshtools.client.tasks.AbstractSubsystem
 
getMaximumPacketSize() - Method in class com.sshtools.client.tasks.AbstractSubsystemTask
 
getMaximumRemotePacketLength() - Method in class com.sshtools.client.AbstractSessionChannel
 
getMaximumRemotePacketLength() - Method in class com.sshtools.client.sftp.SftpChannel
 
getMaximumRemoteWindowSize() - Method in class com.sshtools.client.sftp.SftpChannel
 
getMaximumWindowSize() - Method in class com.sshtools.client.sftp.SftpChannel
 
getMaximumWindowSize() - Method in class com.sshtools.client.tasks.AbstractSubsystem
 
getMaximumWindowSize() - Method in class com.sshtools.client.tasks.AbstractSubsystemTask
 
getMaximumWindowSpace() - Method in class com.sshtools.client.SessionChannelNG
 
getMessageId() - Method in class com.sshtools.client.sftp.SftpMessage
 
getMessageId() - Method in interface com.sshtools.client.tasks.Message
 
getMinimumWindowSize() - Method in class com.sshtools.client.sftp.SftpChannel
 
getMinimumWindowSize() - Method in class com.sshtools.client.tasks.AbstractSubsystem
 
getMinimumWindowSize() - Method in class com.sshtools.client.tasks.AbstractSubsystemTask
 
getMinimumWindowSpace() - Method in class com.sshtools.client.SessionChannelNG
 
getMountFlag() - Method in class com.sshtools.client.sftp.StatVfs
 
getName() - Method in class com.sshtools.client.AuthenticationProtocolClient
 
getName() - Method in interface com.sshtools.client.ClientAuthenticator
The authentication mechanism name/.
getName() - Method in class com.sshtools.client.ConnectionProtocolClient
The name of the ssh service i.e.
getName() - Method in class com.sshtools.client.ExternalKeyAuthenticator
 
getName() - Method in class com.sshtools.client.KeyboardInteractiveAuthenticator
 
getName() - Method in class com.sshtools.client.NoneAuthenticator
 
getName() - Method in class com.sshtools.client.PasswordAuthenticator
 
getName() - Method in class com.sshtools.client.PublicKeyAuthenticator
 
getName() - Method in class com.sshtools.client.TransportProtocolClient
 
getNewFiles() - Method in class com.sshtools.client.sftp.DirectoryOperation
Returns a list of new files that will be transfered in the directory operation
getNewline() - Method in class com.sshtools.client.shell.ExpectShell
 
getNumCommandsExecuted() - Method in class com.sshtools.client.shell.ExpectShell
 
getOKRequestStatus(UnsignedInteger32) - Method in class com.sshtools.client.sftp.SftpChannel
Verify that an OK status has been returned for a request id.
getOptionalHeaders() - Method in class com.sshtools.client.SshClientContext
 
getOsDescription() - Method in class com.sshtools.client.shell.ExpectShell
 
getOsType() - Method in class com.sshtools.client.shell.ExpectShell
 
getOutputStream(String) - Method in class com.sshtools.client.sftp.SftpClient
Create an OutputStream for writing to a remote file.
getOutputStream(String) - Method in class com.sshtools.client.sftp.SftpClientTask
Create an OutputStream for writing to a remote file.
getOutputStream() - Method in class com.sshtools.client.shell.ShellProcess
 
getOutputStream() - Method in class com.sshtools.client.tasks.AsyncSessionTask
 
getParent() - Method in class com.sshtools.client.sftp.SftpFile
Get the parent of the current file.
getPassphrase() - Method in class com.sshtools.client.PrivateKeyFileAuthenticator
 
getPassword() - Method in class com.sshtools.client.PasswordAuthenticator
 
getPreferKeyboardInteractiveOverPassword() - Method in class com.sshtools.client.SshClientContext
 
getPreferredPublicKey() - Method in class com.sshtools.client.SshClientContext
 
getPriority() - Method in class com.sshtools.client.SshKeyExchangeClient
 
getProcess() - Method in class com.sshtools.client.shell.ShellProcessController
 
getPrompt() - Method in class com.sshtools.client.KeyboardInteractivePrompt
Get the prompt message to display to the user
getProperty(String) - Method in class com.sshtools.client.sftp.SftpFile
 
getProvider() - Method in class com.sshtools.client.components.Curve25519SHA256Client
 
getProvider() - Method in class com.sshtools.client.components.DiffieHellmanEcdh
 
getProvider() - Method in class com.sshtools.client.components.DiffieHellmanGroup
 
getProvider() - Method in class com.sshtools.client.components.DiffieHellmanGroupExchange
 
getProvider() - Method in class com.sshtools.client.components.Rsa1024Sha1
 
getProvider() - Method in class com.sshtools.client.components.Rsa2048Sha256
 
getProxyHostname() - Method in class com.sshtools.client.SshClientContext
 
getProxyPassword() - Method in class com.sshtools.client.SshClientContext
 
getProxyPort() - Method in class com.sshtools.client.SshClientContext
 
getProxyType() - Method in class com.sshtools.client.SshClientContext
 
getProxyUsername() - Method in class com.sshtools.client.SshClientContext
 
getPublicKeys() - Method in class com.sshtools.client.ExternalKeyAuthenticator
 
getReadlimit() - Method in class com.sshtools.client.shell.ShellController
 
getRemoteClient(String, int, String, String, boolean) - Static method in class com.sshtools.client.SshCompatibilityUtils
 
getRemoteConfiguration(String, int) - Static method in class com.sshtools.client.SshCompatibilityUtils
 
getRemoteDirectory(String, String, boolean, boolean, boolean, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClient
Copy the contents of a remote directory to a local directory
getRemoteDirectory(String, String, boolean, boolean, boolean, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClientTask
Copy the contents of a remote directory to a local directory
getRemoteEOL() - Method in class com.sshtools.client.sftp.SftpClient
 
getRemoteEOL() - Method in class com.sshtools.client.sftp.SftpClientTask
 
getRemoteHash(String) - Method in class com.sshtools.client.sftp.SftpClient
 
getRemoteHash(String, long, long, byte[]) - Method in class com.sshtools.client.sftp.SftpClient
 
getRemoteHash(byte[]) - Method in class com.sshtools.client.sftp.SftpClient
 
getRemoteHash(byte[], long, long, byte[]) - Method in class com.sshtools.client.sftp.SftpClient
 
getRemoteHostname() - Method in class com.sshtools.client.SshClientContext
 
getRemoteIdentification() - Method in class com.sshtools.client.SshClient
 
getRemoteNewline() - Method in class com.sshtools.client.sftp.SftpClient
 
getRemoteNewline() - Method in class com.sshtools.client.sftp.SftpClientTask
 
getRemotePort() - Method in class com.sshtools.client.SshClientContext
 
getRemotePublicKeys() - Method in class com.sshtools.client.SshClient
 
getResponse() - Method in class com.sshtools.client.KeyboardInteractivePrompt
Get the user's response for this prompt.
getResponse(UnsignedInteger32) - Method in class com.sshtools.client.sftp.SftpChannel
 
getSecret() - Method in class com.sshtools.client.SshKeyExchangeClient
Get the secret value produced during key exchange.
getSecurityLevel() - Method in class com.sshtools.client.SshKeyExchangeClient
 
getServerVersion() - Method in class com.sshtools.client.sftp.SftpChannel
Version 4 of the SFTP protocol allows the server to return its maximum supported version instead of the actual version to be used.
getSession() - Method in class com.sshtools.client.tasks.AbstractSessionTask
 
getSession() - Method in class com.sshtools.client.tasks.AbstractSubsystem
 
getSession() - Method in class com.sshtools.client.tasks.AbstractSubsystemTask
 
getSFTPChannel() - Method in class com.sshtools.client.sftp.SftpFile
Get the SFTP subsystem channel that created this file object.
getShell() - Method in class com.sshtools.client.shell.ShellProcess
 
getSignature() - Method in class com.sshtools.client.SshKeyExchangeClient
Get the signature produced during key exchange.
getSignatureGenerator(Connection<SshClientContext>) - Method in class com.sshtools.client.ExternalKeyAuthenticator
 
getSingleFileResponse(SftpMessage, String) - Method in class com.sshtools.client.sftp.SftpChannel
Get a single SftpFile object from a message returning SSH_FXP_NAME result.
getSize() - Method in class com.sshtools.client.sftp.StatVfs
 
getSocketConnectionFactory() - Method in class com.sshtools.client.SshClientContext
 
getStartedEventCode() - Method in class com.sshtools.client.LocalForwardingFactoryImpl
 
getStartupInputStream() - Method in class com.sshtools.client.shell.ExpectShell
 
getStartupReader() - Method in class com.sshtools.client.shell.ExpectShell
 
getStateListeners() - Method in class com.sshtools.client.SshClientContext
 
getStderrStream() - Method in class com.sshtools.client.SessionChannelNG
 
getStoppedEventCode() - Method in class com.sshtools.client.LocalForwardingFactoryImpl
 
getSubsystemCacheSize() - Method in class com.sshtools.client.SshClientContext
 
getSubsystemChannel() - Method in class com.sshtools.client.sftp.SftpClient
Returns the instance of the AbstractSftpChannel used by this class
getSubsystemChannel() - Method in class com.sshtools.client.sftp.SftpClientTask
Returns the instance of the AbstractSftpChannel used by this class
getSupportedAuthentications() - Method in class com.sshtools.client.AuthenticationProtocolClient
 
getSupportedHostKeyAlgorithms(String, int) - Static method in class com.sshtools.client.SshCompatibilityUtils
 
getSupportedHostKeys(String, int) - Static method in class com.sshtools.client.SshCompatibilityUtils
 
getSupportedPublicKeys() - Method in class com.sshtools.client.SshClientContext
 
getSymbolicLinkTarget(String) - Method in class com.sshtools.client.sftp.SftpChannel
Get the target path of a symbolic link.
getSymbolicLinkTarget(String) - Method in class com.sshtools.client.sftp.SftpClient
Get the target path of a symbolic link.
getSymbolicLinkTarget(String) - Method in class com.sshtools.client.sftp.SftpClientTask
Get the target path of a symbolic link.
getTemporaryFolder() - Method in class com.sshtools.client.sftp.SftpClient
 
getTransferMode() - Method in class com.sshtools.client.sftp.SftpClient
 
getTransferMode() - Method in class com.sshtools.client.sftp.SftpClientTask
 
getTransferSize() - Method in class com.sshtools.client.sftp.DirectoryOperation
Get the total number of bytes that this operation will transfer
getType() - Method in class com.sshtools.client.sftp.SftpMessage
 
getUnchangedFiles() - Method in class com.sshtools.client.sftp.DirectoryOperation
Returns the list of files that will not be changed during the directory operation
getUpdatedFiles() - Method in class com.sshtools.client.sftp.DirectoryOperation
Returns a list of files that will be updated in the directory operation
getUsed() - Method in class com.sshtools.client.sftp.StatVfs
 
getUserAgent() - Method in class com.sshtools.client.SshClientContext
 
getUsername() - Method in class com.sshtools.client.SshClientContext
Get the username of this connection.
getVersion() - Method in class com.sshtools.client.sftp.SftpChannel
 
GlobRegExpMatching - Class in com.sshtools.client.sftp
 
GlobRegExpMatching() - Constructor for class com.sshtools.client.sftp.GlobRegExpMatching
 
GlobSyntax - Static variable in class com.sshtools.client.sftp.SftpClient
 

H

hardlink(String, String) - Method in class com.sshtools.client.sftp.SftpClient
 
hashCode() - Method in class com.sshtools.client.sftp.SftpFile
 
hasReceivedNewKeys() - Method in class com.sshtools.client.SshKeyExchangeClient
 
hasSentNewKeys() - Method in class com.sshtools.client.SshKeyExchangeClient
 
hasSucceeded() - Method in class com.sshtools.client.shell.ShellProcess
 
hostKey - Variable in class com.sshtools.client.SshKeyExchangeClient
The server's host key.

I

ICANON - Static variable in class com.sshtools.client.PseudoTerminalModes
Canonicalize input lines.
ICRNL - Static variable in class com.sshtools.client.PseudoTerminalModes
Map CR to NL on input.
idle() - Method in class com.sshtools.client.AuthenticationProtocolClient
 
IEXTEN - Static variable in class com.sshtools.client.PseudoTerminalModes
Enable extensions.
IGNCR - Static variable in class com.sshtools.client.PseudoTerminalModes
Ignore CR on input.
IGNPAR - Static variable in class com.sshtools.client.PseudoTerminalModes
The ignore parity flag.
IMAXBEL - Static variable in class com.sshtools.client.PseudoTerminalModes
Ring bell on input queue full.
in - Variable in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
 
in - Variable in class com.sshtools.client.shell.ShellController
 
init(SshConnection) - Method in class com.sshtools.client.AbstractKeyboardInteractiveCallback
 
init(SshTransport<SshClientContext>, String, String, byte[], byte[], SshPrivateKey, SshPublicKey, boolean, boolean) - Method in class com.sshtools.client.components.Curve25519SHA256Client
 
init(SshTransport<SshClientContext>, String, String, byte[], byte[], SshPrivateKey, SshPublicKey, boolean, boolean) - Method in class com.sshtools.client.components.DiffieHellmanEcdh
 
init(SshTransport<SshClientContext>, String, String, byte[], byte[], SshPrivateKey, SshPublicKey, boolean, boolean) - Method in class com.sshtools.client.components.DiffieHellmanGroup
 
init(SshTransport<SshClientContext>, String, String, byte[], byte[], boolean, boolean) - Method in class com.sshtools.client.components.DiffieHellmanGroupExchange
 
init(SshTransport<SshClientContext>, String, String, byte[], byte[], SshPrivateKey, SshPublicKey, boolean, boolean) - Method in class com.sshtools.client.components.DiffieHellmanGroupExchange
 
init(SshTransport<SshClientContext>, String, String, byte[], byte[], SshPrivateKey, SshPublicKey, boolean, boolean) - Method in class com.sshtools.client.components.Rsa1024Sha1
 
init(SshTransport<SshClientContext>, String, String, byte[], byte[], SshPrivateKey, SshPublicKey, boolean, boolean) - Method in class com.sshtools.client.components.Rsa2048Sha256
 
init(SshConnection) - Method in interface com.sshtools.client.KeyboardInteractiveCallback
 
init(SshConnection) - Method in class com.sshtools.client.PasswordOverKeyboardInteractiveCallback
 
initializeKeyExchange(SshKeyExchange<SshClientContext>, boolean, boolean) - Method in class com.sshtools.client.TransportProtocolClient
 
INLCR - Static variable in class com.sshtools.client.PseudoTerminalModes
Map NL into CR on input.
INPCK - Static variable in class com.sshtools.client.PseudoTerminalModes
Enable checking of parity errors.
inStartup() - Method in class com.sshtools.client.shell.ExpectShell
 
interrupt() - Method in class com.sshtools.client.shell.ShellController
 
interrupt() - Method in interface com.sshtools.client.shell.ShellWriter
Interrupt the process by sending a Ctrl+C to the process.
isActive() - Method in class com.sshtools.client.shell.ShellController
 
isActive() - Method in class com.sshtools.client.shell.ShellProcess
 
isActive() - Method in class com.sshtools.client.shell.ShellProcessController
 
isAllocatePseudoTerminal() - Method in class com.sshtools.client.tasks.AsyncSessionTask
 
isAuthenticated() - Method in class com.sshtools.client.SshClient
 
isBlock() - Method in class com.sshtools.client.sftp.SftpFile
Determine whether the file is pointing to a block special file.
isCancelled() - Method in interface com.sshtools.client.ClientAuthenticator
 
isCancelled() - Method in class com.sshtools.client.SimpleClientAuthenticator
 
isCancelled() - Method in interface com.sshtools.client.tasks.FileTransferProgress
The transfer is cancelled.
isCharacter() - Method in class com.sshtools.client.sftp.SftpFile
Determine whether the file is pointing to a character mode device.
isClient() - Method in class com.sshtools.client.ConnectionProtocolClient
 
isClosed() - Method in class com.sshtools.client.sftp.SftpChannel
 
isClosed() - Method in class com.sshtools.client.sftp.SftpClient
Returns the state of the SFTP client.
isClosed() - Method in class com.sshtools.client.sftp.SftpClientTask
Returns the state of the SFTP client.
isClosed() - Method in class com.sshtools.client.shell.ExpectShell
 
isClosed() - Method in class com.sshtools.client.tasks.AbstractSessionTask
 
isComplete() - Method in class com.sshtools.client.SshKeyExchangeClient
 
isConnected() - Method in class com.sshtools.client.sftp.SftpClient
 
isConnected() - Method in class com.sshtools.client.SshClient
 
isDirectory() - Method in class com.sshtools.client.sftp.SftpFile
Determine whether the file object is pointing to a directory.
isDirectoryOrLinkedDirectory(SftpFile) - Method in class com.sshtools.client.sftp.SftpClient
Determine whether the file object is pointing to a symbolic link that is pointing to a directory.
isDirectoryOrLinkedDirectory(SftpFile) - Method in class com.sshtools.client.sftp.SftpClientTask
Determine whether the file object is pointing to a symbolic link that is pointing to a directory.
isFifo() - Method in class com.sshtools.client.sftp.SftpFile
Determine whether the file is pointing to a pipe.
isFile() - Method in class com.sshtools.client.sftp.SftpFile
Determine whether the file object is pointing to a file.
isFlowControlEnabled() - Method in class com.sshtools.client.AbstractSessionChannel
 
ISIG - Static variable in class com.sshtools.client.PseudoTerminalModes
Enable signals INTR, QUIT, [D]SUSP.
isKeyExchangeMessage(int) - Method in class com.sshtools.client.components.DiffieHellmanGroup
 
isKeyExchangeMessage(int) - Method in class com.sshtools.client.components.DiffieHellmanGroupExchange
 
isKeyExchangeMessage(int) - Method in class com.sshtools.client.components.Rsa1024Sha1
 
isLink() - Method in class com.sshtools.client.sftp.SftpFile
Determine whether the file object is a symbolic link.
isMoreAuthenticationRequired() - Method in interface com.sshtools.client.ClientAuthenticator
 
isMoreAuthenticationRequired() - Method in class com.sshtools.client.SimpleClientAuthenticator
 
isOpen() - Method in class com.sshtools.client.sftp.SftpFile
Determine whether the file is open.
isProxyEnabled() - Method in class com.sshtools.client.SshClientContext
 
isResolveLocally() - Method in class com.sshtools.client.SshClientContext
 
isSocket() - Method in class com.sshtools.client.sftp.SftpFile
Determine whether the file is pointing to a socket.
ISTRIP - Static variable in class com.sshtools.client.PseudoTerminalModes
Strip 8th bit off characters.
IUCLC - Static variable in class com.sshtools.client.PseudoTerminalModes
Translate uppercase characters to lowercase.
IXANY - Static variable in class com.sshtools.client.PseudoTerminalModes
Any char will restart after stop.
IXOFF - Static variable in class com.sshtools.client.PseudoTerminalModes
Enable input flow control.
IXON - Static variable in class com.sshtools.client.PseudoTerminalModes
Enable output flow control.

K

key - Variable in class com.sshtools.client.SshKeyExchangeClient
 
KeyboardInteractiveAuthenticator - Class in com.sshtools.client
Implements the keyboard-interactive authentication method.
KeyboardInteractiveAuthenticator(KeyboardInteractiveCallback) - Constructor for class com.sshtools.client.KeyboardInteractiveAuthenticator
 
KeyboardInteractiveCallback - Interface in com.sshtools.client
Callback interface for keyboard-interactive authentication.
KeyboardInteractivePrompt - Class in com.sshtools.client
Represents a keyboard-interactive prompt.
KeyboardInteractivePrompt(String, boolean) - Constructor for class com.sshtools.client.KeyboardInteractivePrompt
Creates a new KBIPrompt object.
KeyboardInteractivePromptCompletor - Interface in com.sshtools.client
 
KeyPairAuthenticator - Class in com.sshtools.client
Implements public key authentication, taking a com.sshtools.publickey.SshKeyPair object as the source private key.
KeyPairAuthenticator(SshKeyPair) - Constructor for class com.sshtools.client.KeyPairAuthenticator
 
keysExchanged(boolean) - Method in class com.sshtools.client.SshClientContext
 

L

lcd(String) - Method in class com.sshtools.client.sftp.SftpClient
Changes the local working directory.
lcd(String) - Method in class com.sshtools.client.sftp.SftpClientTask
Changes the local working directory.
listChildren(SftpFile, List<SftpFile>) - Method in class com.sshtools.client.sftp.SftpChannel
List the children of a directory.
LocalForwardingFactoryImpl - Class in com.sshtools.client
Implements the configuration of a local forwarding listening socket.
LocalForwardingFactoryImpl(String, int) - Constructor for class com.sshtools.client.LocalForwardingFactoryImpl
 
lockFile(byte[], long, long, int) - Method in class com.sshtools.client.sftp.SftpChannel
 
lpwd() - Method in class com.sshtools.client.sftp.SftpClient
Returns the absolute path to the local working directory.
lpwd() - Method in class com.sshtools.client.sftp.SftpClientTask
Returns the absolute path to the local working directory.
ls() - Method in class com.sshtools.client.sftp.SftpClient
List the contents of the current remote working directory.
ls(String) - Method in class com.sshtools.client.sftp.SftpClient
List the contents remote directory.
ls(String, boolean, int) - Method in class com.sshtools.client.sftp.SftpClient
 
ls(String, String, boolean, int) - Method in class com.sshtools.client.sftp.SftpClient
 
ls() - Method in class com.sshtools.client.sftp.SftpClientTask
List the contents of the current remote working directory.
ls(String) - Method in class com.sshtools.client.sftp.SftpClientTask
List the contents remote directory.
lsIterator() - Method in class com.sshtools.client.sftp.SftpClient
Return an iterator for the current working directory.
lsIterator(String) - Method in class com.sshtools.client.sftp.SftpClient
Return an iterator for the path provided.

M

main(String[]) - Static method in class com.sshtools.client.SecurityReporter
 
main(String[]) - Static method in class com.sshtools.client.SshReporter
 
makeDirectory(String) - Method in class com.sshtools.client.sftp.SftpChannel
Make a directory.
makeDirectory(String, SftpFileAttributes) - Method in class com.sshtools.client.sftp.SftpChannel
Make a directory.
makeTemporaryFolder() - Method in class com.sshtools.client.sftp.SftpClient
 
mark(int) - Method in class com.sshtools.client.shell.ShellProcess
 
matcher - Variable in class com.sshtools.client.shell.ShellController
 
matches(String, String) - Method in class com.sshtools.client.shell.ShellDefaultMatcher
 
matches(String, String) - Method in interface com.sshtools.client.shell.ShellMatcher
Match a command output line against a defined pattern.
matchFileNamesWithPattern(AbstractFile[], String) - Method in class com.sshtools.client.sftp.GlobRegExpMatching
 
matchFileNamesWithPattern(AbstractFile[], String) - Method in class com.sshtools.client.sftp.NoRegExpMatching
opens and returns the requested filename string
matchFileNamesWithPattern(AbstractFile[], String) - Method in class com.sshtools.client.sftp.RegExpMatching
 
matchFileNamesWithPattern(AbstractFile[], String) - Method in interface com.sshtools.client.sftp.RegularExpressionMatching
returns each of the files that match the pattern fileNameRegExp
matchFilesWithPattern(SftpFile[], String) - Method in class com.sshtools.client.sftp.GlobRegExpMatching
 
matchFilesWithPattern(SftpFile[], String) - Method in class com.sshtools.client.sftp.NoRegExpMatching
returns files
matchFilesWithPattern(SftpFile[], String) - Method in class com.sshtools.client.sftp.RegExpMatching
 
matchFilesWithPattern(SftpFile[], String) - Method in interface com.sshtools.client.sftp.RegularExpressionMatching
returns each of the SftpFiles that match the pattern fileNameRegExp
matchRemoteFiles(String) - Method in class com.sshtools.client.sftp.SftpClient
Called by getFileMatches() to do regular expression pattern matching on the files in 'remote''s parent directory.
matchRemoteFiles(String) - Method in class com.sshtools.client.sftp.SftpClientTask
Called by getFileMatches() to do regular expression pattern matching on the files in 'remote''s parent directory.
MAX_VERSION - Static variable in class com.sshtools.client.sftp.SftpChannel
 
Message - Interface in com.sshtools.client.tasks
 
messageAttributes - Static variable in class com.sshtools.client.events.ClientEventCodes
 
messageCodes - Static variable in class com.sshtools.client.events.ClientEventCodes
 
MessageHolder - Class in com.sshtools.client.tasks
 
MessageHolder() - Constructor for class com.sshtools.client.tasks.MessageHolder
 
messageSent(Long) - Method in class com.sshtools.client.AuthenticationMessage
 
mkdir(String) - Method in class com.sshtools.client.sftp.SftpClient
Creates a new directory on the remote server.
mkdir(String) - Method in class com.sshtools.client.sftp.SftpClientTask
Creates a new directory on the remote server.
mkdirs(String) - Method in class com.sshtools.client.sftp.SftpClient
Create a directory or set of directories.
mkdirs(String) - Method in class com.sshtools.client.sftp.SftpClientTask
Create a directory or set of directories.
MODE_BINARY - Static variable in class com.sshtools.client.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.client.sftp.SftpClient
Instructs the client to use a text transfer mode when used with SftpClient.setTransferMode(int).
msg - Variable in class com.sshtools.client.tasks.MessageHolder
 

N

name - Variable in class com.sshtools.client.components.Curve25519SHA256Client
 
nextMessage() - Method in class com.sshtools.client.tasks.AbstractSubsystem
 
nextMessage() - Method in class com.sshtools.client.tasks.AbstractSubsystemTask
 
NOFLSH - Static variable in class com.sshtools.client.PseudoTerminalModes
Don't flush after interrupt.
NoneAuthenticator - Class in com.sshtools.client
 
NoneAuthenticator() - Constructor for class com.sshtools.client.NoneAuthenticator
 
NoRegExpMatching - Class in com.sshtools.client.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.client.sftp.NoRegExpMatching
 
NoSyntax - Static variable in class com.sshtools.client.sftp.SftpClient
constants for setting the regular expression syntax.

O

OCRNL - Static variable in class com.sshtools.client.PseudoTerminalModes
Translate carriage return to newline (output).
OLCUC - Static variable in class com.sshtools.client.PseudoTerminalModes
Convert lowercase to uppercase.
onChannelClosed() - Method in class com.sshtools.client.AbstractSessionChannel
 
onChannelClosing() - Method in class com.sshtools.client.AbstractSessionChannel
 
onChannelError(Throwable) - Method in class com.sshtools.client.AbstractSessionChannel
 
onChannelFree() - Method in class com.sshtools.client.AbstractSessionChannel
 
onChannelOpen() - Method in class com.sshtools.client.AbstractSessionChannel
 
onChannelOpenConfirmation() - Method in class com.sshtools.client.AbstractSessionChannel
 
onChannelRequest(String, boolean, byte[]) - Method in class com.sshtools.client.AbstractSessionChannel
 
onCloseSession(SessionChannelNG) - Method in class com.sshtools.client.tasks.AbstractCommandTask
 
onCloseSession(T) - Method in class com.sshtools.client.tasks.AbstractSessionTask
 
onCloseSession(SessionChannelNG) - Method in class com.sshtools.client.tasks.AbstractSubsystem
 
onCloseSession(SessionChannelNG) - Method in class com.sshtools.client.tasks.AbstractSubsystemTask
 
onCloseSession(SessionChannel) - Method in class com.sshtools.client.tasks.AsyncSessionTask
 
onCloseSession(SessionChannelNG) - Method in class com.sshtools.client.tasks.ShellTask
 
onConnected() - Method in class com.sshtools.client.TransportProtocolClient
 
onCreateChannel(String, SshConnection) - Method in class com.sshtools.client.DefaultClientChannelFactory
 
onDisconnected() - Method in class com.sshtools.client.TransportProtocolClient
 
onExtendedData(ByteBuffer, int) - Method in class com.sshtools.client.SessionChannelNG
 
onKeyExchangeInit() - Method in class com.sshtools.client.TransportProtocolClient
 
ONLCR - Static variable in class com.sshtools.client.PseudoTerminalModes
Map NL to CR-NL.
onLocalEOF() - Method in class com.sshtools.client.AbstractSessionChannel
 
ONLRET - Static variable in class com.sshtools.client.PseudoTerminalModes
Newline performs a carriage return (output).
onNewKeysReceived() - Method in class com.sshtools.client.TransportProtocolClient
 
onNewKeysSent() - Method in class com.sshtools.client.TransportProtocolClient
 
ONOCR - Static variable in class com.sshtools.client.PseudoTerminalModes
Translate newline to carriage return-newline (output).
onOpenSession(T) - Method in class com.sshtools.client.tasks.AbstractSessionTask
 
onOpenSession(SessionChannel) - Method in class com.sshtools.client.tasks.AsyncSessionTask
 
onRemoteEOF() - Method in class com.sshtools.client.AbstractSessionChannel
 
onSessionOpen() - Method in class com.sshtools.client.SessionChannelNG
 
onSocketConnect(SocketConnection) - Method in class com.sshtools.client.TransportProtocolClient
 
onSocketRead(ByteBuffer) - Method in class com.sshtools.client.TransportProtocolClient
 
onStart() - Method in class com.sshtools.client.ConnectionProtocolClient
 
onStartAuthentication(Connection<SshClientContext>) - Method in class com.sshtools.client.ExternalKeyAuthenticator
 
onStartAuthentication(Connection<SshClientContext>) - Method in class com.sshtools.client.PublicKeyAuthenticator
 
onStop() - Method in class com.sshtools.client.ConnectionProtocolClient
 
OPEN_APPEND - Static variable in class com.sshtools.client.sftp.SftpChannel
File open flag, forces all writes to append data at the end of the file.
OPEN_CREATE - Static variable in class com.sshtools.client.sftp.SftpChannel
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.client.sftp.SftpChannel
File open flag, causes an open request to fail if the named file already exists.
OPEN_READ - Static variable in class com.sshtools.client.sftp.SftpChannel
File open flag, opens the file for reading.
OPEN_TEXT - Static variable in class com.sshtools.client.sftp.SftpChannel
File open flag, causes the file to be opened in text mode.
OPEN_TRUNCATE - Static variable in class com.sshtools.client.sftp.SftpChannel
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.client.sftp.SftpChannel
File open flag, opens the file for writing.
openChannel(byte[]) - Method in class com.sshtools.client.AbstractSessionChannel
 
openDirectory(String) - Method in class com.sshtools.client.sftp.SftpChannel
Open a directory.
openDirectory(String) - Method in class com.sshtools.client.sftp.SftpClient
 
openDirectory(String) - Method in class com.sshtools.client.sftp.SftpClientTask
 
openFile(String, int) - Method in class com.sshtools.client.sftp.SftpChannel
Open a file.
openFile(String, int, SftpFileAttributes) - Method in class com.sshtools.client.sftp.SftpChannel
Open a file.
openFile(String) - Method in class com.sshtools.client.sftp.SftpClient
 
openFile(String, int) - Method in class com.sshtools.client.sftp.SftpClient
 
openFile(String) - Method in class com.sshtools.client.sftp.SftpClientTask
 
openFile(String, int) - Method in class com.sshtools.client.sftp.SftpClientTask
 
openFileVersion5(String, int, int, SftpFileAttributes) - Method in class com.sshtools.client.sftp.SftpChannel
 
openSessionChannel() - Method in class com.sshtools.client.SshClient
 
openSessionChannel(long) - Method in class com.sshtools.client.SshClient
 
openSessionChannel(boolean) - Method in class com.sshtools.client.SshClient
 
openSessionChannel(long, boolean) - Method in class com.sshtools.client.SshClient
 
OPOST - Static variable in class com.sshtools.client.PseudoTerminalModes
Enable output processing.
OS_AIX - Static variable in class com.sshtools.client.shell.ExpectShell
AIX operating system
OS_DARWIN - Static variable in class com.sshtools.client.shell.ExpectShell
Darwin (MAC) operating system
OS_FREEBSD - Static variable in class com.sshtools.client.shell.ExpectShell
FreeBSD operating system
OS_HPUX - Static variable in class com.sshtools.client.shell.ExpectShell
HP-UX operating system
OS_LINUX - Static variable in class com.sshtools.client.shell.ExpectShell
Linux operating system
OS_NETBSD - Static variable in class com.sshtools.client.shell.ExpectShell
NetBSD operating system
OS_OPENBSD - Static variable in class com.sshtools.client.shell.ExpectShell
OpenBSD operating system
OS_OPENVMS - Static variable in class com.sshtools.client.shell.ExpectShell
OpenVMS operating system
OS_SOLARIS - Static variable in class com.sshtools.client.shell.ExpectShell
Solaris operating system
OS_UNIX - Static variable in class com.sshtools.client.shell.ExpectShell
Unix OS if less than this value.
OS_UNKNOWN - Static variable in class com.sshtools.client.shell.ExpectShell
The operating system is unknown
OS_WINDOWS - Static variable in class com.sshtools.client.shell.ExpectShell
Windows operating system
out - Variable in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
 

P

PARENB - Static variable in class com.sshtools.client.PseudoTerminalModes
Parity enable.
PARMRK - Static variable in class com.sshtools.client.PseudoTerminalModes
Mark parity and framing errors.
PARODD - Static variable in class com.sshtools.client.PseudoTerminalModes
Odd parity, else even.
parseCommand(String, String[]) - Method in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
Parse an SCP command
PasswordAuthenticator - Class in com.sshtools.client
Implements the password authentication method.
PasswordAuthenticator() - Constructor for class com.sshtools.client.PasswordAuthenticator
 
PasswordAuthenticator(String) - Constructor for class com.sshtools.client.PasswordAuthenticator
 
PasswordAuthenticator(char[]) - Constructor for class com.sshtools.client.PasswordAuthenticator
 
PasswordOverKeyboardInteractiveCallback - Class in com.sshtools.client
Implements a keyboard-interactive callback that answers a single password prompt.
PasswordOverKeyboardInteractiveCallback(PasswordAuthenticator) - Constructor for class com.sshtools.client.PasswordOverKeyboardInteractiveCallback
 
PENDIN - Static variable in class com.sshtools.client.PseudoTerminalModes
Retype pending input.
performOptimizedRead(String, byte[], long, int, OutputStream, int, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpChannel
Performs an optimized read of a file through use of asynchronous messages.
performOptimizedRead(String, byte[], long, int, OutputStream, int, FileTransferProgress, long) - Method in class com.sshtools.client.sftp.SftpChannel
Performs an optimized read of a file through use of asynchronous messages.
performOptimizedWrite(String, byte[], int, int, InputStream, int, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpChannel
Performs an optimized write of a file through asynchronous messaging and through buffering the local file into memory.
performOptimizedWrite(String, byte[], int, int, InputStream, int, FileTransferProgress, long) - Method in class com.sshtools.client.sftp.SftpChannel
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.client.sftp.SftpChannel
Perform a synchronous read of a file from the remote file system.
Perl5Syntax - Static variable in class com.sshtools.client.sftp.SftpClient
 
postReadRequest(byte[], long, int) - Method in class com.sshtools.client.sftp.SftpChannel
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.client.sftp.SftpChannel
Send a write request for an open file but do not wait for the response from the server.
PrivateKeyFileAuthenticator - Class in com.sshtools.client
Implements public key authentication, taking a java.io.File object as the source private key.
PrivateKeyFileAuthenticator(File, String) - Constructor for class com.sshtools.client.PrivateKeyFileAuthenticator
 
PrivateKeyFileAuthenticator(File) - Constructor for class com.sshtools.client.PrivateKeyFileAuthenticator
 
processMessage(byte[]) - Method in class com.sshtools.client.AuthenticationProtocolClient
 
processMessage(ByteArrayReader) - Method in interface com.sshtools.client.ClientAuthenticator
Process an authentication message.
processMessage(byte[]) - Method in class com.sshtools.client.components.Curve25519SHA256Client
 
processMessage(byte[]) - Method in class com.sshtools.client.components.DiffieHellmanEcdh
 
processMessage(byte[]) - Method in class com.sshtools.client.components.DiffieHellmanGroup
 
processMessage(byte[]) - Method in class com.sshtools.client.components.DiffieHellmanGroupExchange
 
processMessage(byte[]) - Method in class com.sshtools.client.components.Rsa1024Sha1
 
processMessage(byte[]) - Method in class com.sshtools.client.components.Rsa2048Sha256
 
processMessage(ByteArrayReader) - Method in class com.sshtools.client.ExternalKeyAuthenticator
 
processMessage(ByteArrayReader) - Method in class com.sshtools.client.KeyboardInteractiveAuthenticator
 
processMessage(ByteArrayReader) - Method in class com.sshtools.client.PublicKeyAuthenticator
 
processMessage(ByteArrayReader) - Method in class com.sshtools.client.SimpleClientAuthenticator
 
processMessage(byte[]) - Method in class com.sshtools.client.SshKeyExchangeClient
Process a key exchange message
processSupported(byte[]) - Method in class com.sshtools.client.sftp.SftpChannel
 
processSupported2(byte[]) - Method in class com.sshtools.client.sftp.SftpChannel
 
processTCPIPCancel(ByteArrayReader, ByteArrayWriter) - Method in class com.sshtools.client.ConnectionProtocolClient
Process remote forwarding cancel request.
processTCPIPForward(ByteArrayReader, ByteArrayWriter) - Method in class com.sshtools.client.ConnectionProtocolClient
Process a request for remote forwarding.
processTransportMessage(int, byte[]) - Method in class com.sshtools.client.TransportProtocolClient
 
progressed(long) - Method in interface com.sshtools.client.tasks.FileTransferProgress
The transfer has progressed
ProxyType - Enum in com.sshtools.client
 
PseudoTerminalModes - Class in com.sshtools.client
When a client requests a pseudo terminal it informs the server of any terminal modes that it knows of.
PseudoTerminalModes() - Constructor for class com.sshtools.client.PseudoTerminalModes
 
PseudoTerminalModes(byte[]) - Constructor for class com.sshtools.client.PseudoTerminalModes
 
PublicKeyAuthenticator - Class in com.sshtools.client
Implements public key authentication taking a separately loaded SshKeyPair as the private key for authentication.
PublicKeyAuthenticator() - Constructor for class com.sshtools.client.PublicKeyAuthenticator
 
PublicKeyAuthenticator(SshKeyPair...) - Constructor for class com.sshtools.client.PublicKeyAuthenticator
 
put(String, String, boolean) - Method in class com.sshtools.client.scp.ScpClient
Uploads a local file onto the remote server.
put(String, String, boolean, FileTransferProgress, boolean) - Method in class com.sshtools.client.scp.ScpClient
 
put(String, String, boolean, FileTransferProgress) - Method in class com.sshtools.client.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.client.scp.ScpClient
Uploads an array of local files onto the remote server.
put(String[], String, boolean, FileTransferProgress) - Method in class com.sshtools.client.scp.ScpClient
Uploads an array of local files onto the remote server.
put(InputStream, long, String, String) - Method in class com.sshtools.client.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.client.scp.ScpClientIO
Uploads a java.io.InputStream to a remote server as a file.
put(InputStream, long, String, String, boolean, FileTransferProgress) - Method in class com.sshtools.client.scp.ScpClientIO
 
put(String, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClient
Upload a file to the remote computer.
put(String, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClient
Upload a file to the remote computer.
put(String) - Method in class com.sshtools.client.sftp.SftpClient
Upload a file to the remote computer
put(String, boolean) - Method in class com.sshtools.client.sftp.SftpClient
Upload a file to the remote computer
put(String, String, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClient
Upload a file to the remote computer.
put(String, String, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClient
Upload a file to the remote computer.
put(String, String, boolean) - Method in class com.sshtools.client.sftp.SftpClient
Upload a file to the remote computer
put(String, String) - Method in class com.sshtools.client.sftp.SftpClient
Upload a file to the remote computer
put(InputStream, String, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClient
Upload a file to the remote computer reading from the specified InputStream.
put(InputStream, String, FileTransferProgress, long) - Method in class com.sshtools.client.sftp.SftpClient
 
put(InputStream, String, long) - Method in class com.sshtools.client.sftp.SftpClient
Upload the contents of an InputStream to the remote computer.
put(InputStream, String) - Method in class com.sshtools.client.sftp.SftpClient
Upload the contents of an InputStream to the remote computer.
put(String, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask
Upload a file to the remote computer.
put(String, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClientTask
Upload a file to the remote computer.
put(String) - Method in class com.sshtools.client.sftp.SftpClientTask
Upload a file to the remote computer
put(String, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask
Upload a file to the remote computer
put(String, String, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClientTask
Upload a file to the remote computer.
put(String, String, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask
Upload a file to the remote computer.
put(String, String, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask
Upload a file to the remote computer
put(String, String) - Method in class com.sshtools.client.sftp.SftpClientTask
Upload a file to the remote computer
put(InputStream, String, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClientTask
Upload a file to the remote computer reading from the specified InputStream.
put(InputStream, String, FileTransferProgress, long) - Method in class com.sshtools.client.sftp.SftpClientTask
 
put(InputStream, String, long) - Method in class com.sshtools.client.sftp.SftpClientTask
Upload the contents of an InputStream to the remote computer.
put(InputStream, String) - Method in class com.sshtools.client.sftp.SftpClientTask
Upload the contents of an InputStream to the remote computer.
putFile(String, String, boolean, FileTransferProgress, boolean) - Method in class com.sshtools.client.scp.ScpClient
Deprecated.
Use put method instead.
putFile(String, int, String, char[], File, String) - Static method in class com.sshtools.client.Ssh
 
putFile(File) - Method in class com.sshtools.client.SshClient
 
putFile(File, String) - Method in class com.sshtools.client.SshClient
 
putFile(File, String, long) - Method in class com.sshtools.client.SshClient
 
putFiles(String) - Method in class com.sshtools.client.sftp.SftpClient
Upload the contents of an InputStream to the remote computer.
putFiles(String, boolean) - Method in class com.sshtools.client.sftp.SftpClient
Upload files to the remote computer
putFiles(String, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClient
Upload files to the remote computer
putFiles(String, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClient
Upload files to the remote computer
putFiles(String, String) - Method in class com.sshtools.client.sftp.SftpClient
Upload files to the remote computer
putFiles(String, String, boolean) - Method in class com.sshtools.client.sftp.SftpClient
Upload files to the remote computer
putFiles(String, String, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClient
Upload files to the remote computer.
putFiles(String, String, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClient
make local copies of some of the variables, then call putfilematches, which calls "put" on each file that matches the regexp local.
putFiles(String) - Method in class com.sshtools.client.sftp.SftpClientTask
Upload the contents of an InputStream to the remote computer.
putFiles(String, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask
Upload files to the remote computer
putFiles(String, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClientTask
Upload files to the remote computer
putFiles(String, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask
Upload files to the remote computer
putFiles(String, String) - Method in class com.sshtools.client.sftp.SftpClientTask
Upload files to the remote computer
putFiles(String, String, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask
Upload files to the remote computer
putFiles(String, String, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClientTask
Upload files to the remote computer.
putFiles(String, String, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask
make local copies of some of the variables, then call putfilematches, which calls "put" on each file that matches the regexp local.
putLocalDirectory(String, String, boolean, boolean, boolean, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClient
Copy the contents of a local directory into a remote directory.
putLocalDirectory(String, String, boolean, boolean, boolean, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClientTask
Copy the contents of a local directory into a remote directory.
pwd() - Method in class com.sshtools.client.sftp.SftpClient
Returns the absolute path name of the current remote working directory.
pwd() - Method in class com.sshtools.client.sftp.SftpClientTask
Returns the absolute path name of the current remote working directory.

Q

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

R

read(long, byte[], int, int) - Method in class com.sshtools.client.sftp.SftpFile
Read bytes directly from this file.
read(byte[], int, int) - Method in class com.sshtools.client.sftp.SftpFileInputStream
 
read() - Method in class com.sshtools.client.sftp.SftpFileInputStream
 
readCompleteFile(OutputStream, long, FileTransferProgress) - Method in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
 
readDirectory(SftpFile) - Method in class com.sshtools.client.sftp.SftpClient
 
readDirectory(SftpFile) - Method in class com.sshtools.client.sftp.SftpClientTask
 
readFile(byte[], UnsignedInteger64, byte[], int, int) - Method in class com.sshtools.client.sftp.SftpChannel
Read a block of data from an open file.
readlimit - Variable in class com.sshtools.client.shell.ShellController
 
readLine() - Method in class com.sshtools.client.shell.ShellController
 
readLine(long) - Method in class com.sshtools.client.shell.ShellController
 
readLine() - Method in interface com.sshtools.client.shell.ShellReader
Read a line of output from the process.
readLine(long) - Method in interface com.sshtools.client.shell.ShellReader
Read a line of output from the process.
readStreamFromRemote(String, FileTransferProgress) - Method in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
Open an InputStream.
readString() - Method in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
read the inputstream until come to an end of line character '\n', and return the bytes read as a string
recurseMakeDirectory(String) - Method in class com.sshtools.client.sftp.SftpChannel
Recurse through a hierarchy of directories creating them as necessary.
RegExpMatching - Class in com.sshtools.client.sftp
 
RegExpMatching() - Constructor for class com.sshtools.client.sftp.RegExpMatching
 
RegularExpressionMatching - Interface in com.sshtools.client.sftp
Interface for treating a filename as a regular expression and returning the list of files that match.
release() - Method in class com.sshtools.client.sftp.SftpMessage
 
RemoteForwardingClientChannel - Class in com.sshtools.client
Concrete implementation of a remote forwarding channel for the client implementation.
RemoteForwardingClientChannel(SshConnection) - Constructor for class com.sshtools.client.RemoteForwardingClientChannel
 
removeCustomRoot(String) - Method in class com.sshtools.client.sftp.SftpClient
Remove a custom file system root path such as "flash:"
removeCustomRoot(String) - Method in class com.sshtools.client.sftp.SftpClientTask
Remove a custom file system root path such as "flash:"
removeDirectory(String) - Method in class com.sshtools.client.sftp.SftpChannel
Remove an empty directory.
removeFile(String) - Method in class com.sshtools.client.sftp.SftpChannel
Remove a file.
rename(String, String, boolean) - Method in class com.sshtools.client.sftp.SftpClient
Rename a file on the remote computer, optionally using posix semantics that allow files to be renamed even if the destination path exists.
rename(String, String) - Method in class com.sshtools.client.sftp.SftpClient
Rename a file on the remote computer.
rename(String, String) - Method in class com.sshtools.client.sftp.SftpClientTask
Rename a file on the remote computer.
renameFile(String, String) - Method in class com.sshtools.client.sftp.SftpChannel
Rename an existing file.
renameFile(String, String, int) - Method in class com.sshtools.client.sftp.SftpChannel
 
reset() - Method in class com.sshtools.client.PseudoTerminalModes
Clear the modes
reset() - Method in class com.sshtools.client.shell.ShellProcess
 
reset() - Method in class com.sshtools.client.SshKeyExchangeClient
Reset the key exchange.
rm(String) - Method in class com.sshtools.client.sftp.SftpClient
Remove a file or directory from the remote computer.
rm(String, boolean, boolean) - Method in class com.sshtools.client.sftp.SftpClient
Remove a file or directory on the remote computer with options to force deletion of existing files and recursion.
rm(String) - Method in class com.sshtools.client.sftp.SftpClientTask
Remove a file or directory from the remote computer.
rm(String, boolean, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask
Remove a file or directory on the remote computer with options to force deletion of existing files and recursion.
Rsa1024Sha1 - Class in com.sshtools.client.components
Implementation of RFC 4432 https://tools.ietf.org/html/rfc4432
Rsa1024Sha1() - Constructor for class com.sshtools.client.components.Rsa1024Sha1
Construct an uninitialized instance.
Rsa2048Sha256 - Class in com.sshtools.client.components
Implementation of RFC 4432 https://tools.ietf.org/html/rfc4432
Rsa2048Sha256() - Constructor for class com.sshtools.client.components.Rsa2048Sha256
Construct an uninitialized instance.
RSA_1024_SHA1 - Static variable in class com.sshtools.client.components.Rsa1024Sha1
Constant for the algorithm name "rsa1024-sha1".
RSA_2048_SHA256 - Static variable in class com.sshtools.client.components.Rsa2048Sha256
Constant for the algorithm name "rsa2048-sha256".
run() - Method in class com.sshtools.client.tasks.AsyncSessionTask
 
runTask(T, long) - Method in class com.sshtools.client.SshClient
 
runTask(T) - Method in class com.sshtools.client.SshClient
 

S

ScpClient - Class in com.sshtools.client.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.client.scp.ScpClient
Creates an SCP client.
ScpClient(File, SshClient) - Constructor for class com.sshtools.client.scp.ScpClient
 
ScpClient(AbstractFileFactory<?>, SshClient) - Constructor for class com.sshtools.client.scp.ScpClient
Creates an SCP client.
ScpClient.ScpEngine - Class in com.sshtools.client.scp
Implements an SCP Engine by extending J2SSH Mavericjs ScpEngineIO
ScpClientIO - Class in com.sshtools.client.scp
Implements the IO of a Secure Copy (SCP) client.
ScpClientIO(SshClient) - Constructor for class com.sshtools.client.scp.ScpClientIO
Creates an SCP client.
ScpClientIO.ScpEngineIO - Class in com.sshtools.client.scp
Implements an SCP engine.
ScpEngine(String, SessionChannelNG) - Constructor for class com.sshtools.client.scp.ScpClient.ScpEngine
Contruct the channel with the specified scp command.
ScpEngineIO(String, SessionChannelNG) - Constructor for class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
Contruct the channel with the specified scp command.
secret - Variable in class com.sshtools.client.SshKeyExchangeClient
The secret value produced during key exchange.
SecurityReporter - Class in com.sshtools.client
 
SecurityReporter() - Constructor for class com.sshtools.client.SecurityReporter
 
selectNegotiatedComponent(String, String) - Method in class com.sshtools.client.TransportProtocolClient
 
sendExtensionMessage(String, byte[]) - Method in class com.sshtools.client.sftp.SftpChannel
Send an extension message and return the response.
sendMessage(Packet) - Method in class com.sshtools.client.tasks.AbstractSubsystem
 
sendMessage(Packet) - Method in class com.sshtools.client.tasks.AbstractSubsystemTask
 
serverId - Variable in class com.sshtools.client.SshKeyExchangeClient
 
serverKexInit - Variable in class com.sshtools.client.SshKeyExchangeClient
 
session - Variable in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
 
session - Variable in class com.sshtools.client.tasks.AbstractSubsystem
 
SessionChannelNG - Class in com.sshtools.client
Implements the client side of the SSH Connection protocol session channel
SessionChannelNG(SshConnection) - Constructor for class com.sshtools.client.SessionChannelNG
 
SessionChannelNG(SshConnection, boolean) - Constructor for class com.sshtools.client.SessionChannelNG
 
SessionChannelNG(int, int, int, int, ChannelRequestFuture, boolean) - Constructor for class com.sshtools.client.SessionChannelNG
 
SessionChannelNG(int, int, int, int, boolean) - Constructor for class com.sshtools.client.SessionChannelNG
 
SessionChannelNG(int, int, int, int) - Constructor for class com.sshtools.client.SessionChannelNG
 
setActiveService(Service) - Method in class com.sshtools.client.TransportProtocolClient
 
setAttributes(String, SftpFileAttributes) - Method in class com.sshtools.client.sftp.SftpChannel
Sets the attributes of a file.
setAttributes(SftpFile, SftpFileAttributes) - Method in class com.sshtools.client.sftp.SftpChannel
Sets the attributes of a file.
setBannerDisplay(BannerDisplay) - Method in class com.sshtools.client.SshClientContext
 
setBlockSize(int) - Method in class com.sshtools.client.sftp.SftpClient
Sets the block size used when transferring files, defaults to the optimized setting of 32768.
setBlockSize(int) - Method in class com.sshtools.client.sftp.SftpClientTask
Sets the block size used when transferring files, defaults to the optimized setting of 32768.
setBufferSize(int) - Method in class com.sshtools.client.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.client.sftp.SftpClientTask
Set the size of the buffer which is used to read from the local file system.
setChannelFactory(ChannelFactory<SshClientContext>) - Method in class com.sshtools.client.SshClientContext
 
setCharacterEncoding(String) - Method in class com.sshtools.client.shell.ExpectShell
 
setCharsetEncoding(String) - Method in class com.sshtools.client.sftp.SftpChannel
Allows the default character encoding to be overriden for filename strings.
setConnectionManager(ConnectionManager<SshClientContext>) - Method in class com.sshtools.client.SshClientContext
 
setEnvironmentVariable(String, String) - Method in class com.sshtools.client.AbstractSessionChannel
 
setForceRemoteEOL(boolean) - Method in class com.sshtools.client.sftp.SftpClient
Override automatic detection of the remote EOL (any SFTP version).
setForceRemoteEOL(boolean) - Method in class com.sshtools.client.sftp.SftpClientTask
Override automatic detection of the remote EOL (any SFTP version).
setForwardingManager(ForwardingManager<SshClientContext>) - Method in class com.sshtools.client.SshClientContext
 
setHostKeyVerification(HostKeyVerification) - Method in class com.sshtools.client.SshClientContext
 
setKeyPair(SshKeyPair...) - Method in class com.sshtools.client.PublicKeyAuthenticator
 
setLocalEOL(int) - Method in class com.sshtools.client.sftp.SftpClient
Override the default local system EOL for text mode files.
setLocalEOL(int) - Method in class com.sshtools.client.sftp.SftpClientTask
Override the default local system EOL for text mode files.
setMatcher(ShellMatcher) - Method in class com.sshtools.client.shell.ShellController
 
setMaxAsyncRequests(int) - Method in class com.sshtools.client.sftp.SftpClient
Set the maximum number of asynchronous requests that are outstanding at any one time.
setMaxAsyncRequests(int) - Method in class com.sshtools.client.sftp.SftpClientTask
Set the maximum number of asynchronous requests that are outstanding at any one time.
setPacketSize(int) - Method in class com.sshtools.client.scp.ScpClient
 
setPasswordErrorText(String) - Method in class com.sshtools.client.shell.ExpectShell
 
setPasswordPrompt(String) - Method in class com.sshtools.client.shell.ExpectShell
 
setPreferKeyboardInteractiveOverPassword(boolean) - Method in class com.sshtools.client.SshClientContext
 
setPreferredPublicKey(String) - Method in class com.sshtools.client.SshClientContext
 
setProperty(String, Object) - Method in class com.sshtools.client.sftp.SftpFile
 
setReadlimit(int) - Method in class com.sshtools.client.shell.ShellController
 
setReceivedNewKeys(boolean) - Method in class com.sshtools.client.SshKeyExchangeClient
 
setRegularExpressionSyntax(int) - Method in class com.sshtools.client.sftp.SftpClient
sets the type of regular expression matching to perform on gets and puts
setRegularExpressionSyntax(int) - Method in class com.sshtools.client.sftp.SftpClientTask
sets the type of regular expression matching to perform on gets and puts
setRemoteEOL(int) - Method in class com.sshtools.client.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.
setRemoteEOL(int) - Method in class com.sshtools.client.sftp.SftpClientTask
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.client.KeyboardInteractivePrompt
Set the user's response for this prompt.
setSentNewKeys(boolean) - Method in class com.sshtools.client.SshKeyExchangeClient
 
setShellInitTimeout(int) - Static method in class com.sshtools.client.shell.ExpectShell
 
setStripEOL(boolean) - Method in class com.sshtools.client.sftp.SftpClient
Strip all line endings in preference of the target system EOL setting.
setSubsystemCacheSize(int) - Method in class com.sshtools.client.SshClientContext
 
setTerminalMode(int, int) - Method in class com.sshtools.client.PseudoTerminalModes
Set an integer value mode
setTerminalMode(int, boolean) - Method in class com.sshtools.client.PseudoTerminalModes
Set a boolean value mode
setTransferMode(int) - Method in class com.sshtools.client.sftp.SftpClient
Sets the transfer mode for current operations.
setTransferMode(int) - Method in class com.sshtools.client.sftp.SftpClientTask
Sets the transfer mode for current operations.
setupSession(SessionChannelNG) - Method in class com.sshtools.client.tasks.AbstractCommandTask
 
setupSession(T) - Method in class com.sshtools.client.tasks.AbstractSessionTask
 
setupSession(T) - Method in class com.sshtools.client.tasks.AbstractShellTask
 
setupSession(SessionChannel) - Method in class com.sshtools.client.tasks.AsyncSessionTask
 
setUsername(String) - Method in class com.sshtools.client.SshClientContext
Set the username for this connection.
setWindowSpace(int) - Method in class com.sshtools.client.scp.ScpClient
 
SftpChannel - Class in com.sshtools.client.sftp
Abstract task implementing SFTP operations.
SftpChannel(SshConnection) - Constructor for class com.sshtools.client.sftp.SftpChannel
 
SftpClient - Class in com.sshtools.client.sftp
An abstract task that implements an SFTP client.
SftpClient(SshConnection) - Constructor for class com.sshtools.client.sftp.SftpClient
 
SftpClient(SshConnection, AbstractFileFactory<?>) - Constructor for class com.sshtools.client.sftp.SftpClient
 
SftpClient(SshClient) - Constructor for class com.sshtools.client.sftp.SftpClient
 
SftpClient(SshClient, AbstractFileFactory<?>) - Constructor for class com.sshtools.client.sftp.SftpClient
 
SftpClientTask - Class in com.sshtools.client.sftp
An abstract task that implements an SFTP client.
SftpClientTask(SshConnection) - Constructor for class com.sshtools.client.sftp.SftpClientTask
 
SftpClientTask(SshClient) - Constructor for class com.sshtools.client.sftp.SftpClientTask
 
SftpFile - Class in com.sshtools.client.sftp
Represents an SFTP file object.
SftpFile(String, SftpFileAttributes) - Constructor for class com.sshtools.client.sftp.SftpFile
Creates a new SftpFile object.
SftpFileInputStream - Class in com.sshtools.client.sftp
An InputStream to read the contents of a remote file.
SftpFileInputStream(SftpFile) - Constructor for class com.sshtools.client.sftp.SftpFileInputStream
 
SftpFileInputStream(SftpFile, long) - Constructor for class com.sshtools.client.sftp.SftpFileInputStream
Creates a new SftpFileInputStream object.
SftpFileOutputStream - Class in com.sshtools.client.sftp
An OutputStream to write data to a remote file.
SftpFileOutputStream(SftpFile) - Constructor for class com.sshtools.client.sftp.SftpFileOutputStream
Creates a new SftpFileOutputStream object.
SftpMessage - Class in com.sshtools.client.sftp
 
shell - Variable in class com.sshtools.client.shell.ShellController
 
ShellController - Class in com.sshtools.client.shell
 
ShellDefaultMatcher - Class in com.sshtools.client.shell
 
ShellDefaultMatcher() - Constructor for class com.sshtools.client.shell.ShellDefaultMatcher
 
ShellMatcher - Interface in com.sshtools.client.shell
 
ShellMatcher.Continue - Enum in com.sshtools.client.shell
 
ShellProcess - Class in com.sshtools.client.shell
 
ShellProcessController - Class in com.sshtools.client.shell
 
ShellProcessController(ShellProcess) - Constructor for class com.sshtools.client.shell.ShellProcessController
 
ShellProcessController(ShellProcess, ShellMatcher) - Constructor for class com.sshtools.client.shell.ShellProcessController
 
ShellReader - Interface in com.sshtools.client.shell
 
ShellStartupPasswordTrigger - Class in com.sshtools.client.shell
 
ShellStartupPasswordTrigger(String, String) - Constructor for class com.sshtools.client.shell.ShellStartupPasswordTrigger
 
ShellStartupPasswordTrigger(String, String, ShellMatcher) - Constructor for class com.sshtools.client.shell.ShellStartupPasswordTrigger
 
ShellStartupTrigger - Interface in com.sshtools.client.shell
 
ShellTask - Class in com.sshtools.client.tasks
 
ShellTask(SshConnection) - Constructor for class com.sshtools.client.tasks.ShellTask
 
ShellTask(SshClient) - Constructor for class com.sshtools.client.tasks.ShellTask
 
ShellTimeoutException - Exception in com.sshtools.client.shell
Exception thrown when an operation times out.
ShellWriter - Interface in com.sshtools.client.shell
 
showPrompts(String, String, KeyboardInteractivePrompt[], KeyboardInteractivePromptCompletor) - Method in interface com.sshtools.client.KeyboardInteractiveCallback
 
showPrompts(String, String, KeyboardInteractivePrompt[], KeyboardInteractivePromptCompletor) - Method in class com.sshtools.client.PasswordOverKeyboardInteractiveCallback
Called by the keyboard-interactive authentication mechanism when the server requests information from the user.
sign(SshPublicKey, String, byte[]) - Method in class com.sshtools.client.ExternalKeyAuthenticator
 
sign(SshPrivateKey, String, byte[]) - Method in class com.sshtools.client.PublicKeyAuthenticator
 
signal(String) - Method in class com.sshtools.client.AbstractSessionChannel
Send a signal to the remote process.
signature - Variable in class com.sshtools.client.SshKeyExchangeClient
The signature generated over the exchange hash
SimpleClientAuthenticator - Class in com.sshtools.client
A simple base class for implementing non-interactive authentication methods.
SimpleClientAuthenticator() - Constructor for class com.sshtools.client.SimpleClientAuthenticator
 
ssh - Variable in class com.sshtools.client.scp.ScpClientIO
 
Ssh - Class in com.sshtools.client
 
Ssh() - Constructor for class com.sshtools.client.Ssh
 
SSH_EXTENDED_DATA_STDERR - Static variable in class com.sshtools.client.AbstractSessionChannel
 
SSH_FXE_STATVFS_ST_NOSUID - Static variable in class com.sshtools.client.sftp.StatVfs
 
SSH_FXE_STATVFS_ST_RDONLY - Static variable in class com.sshtools.client.sftp.StatVfs
 
SSH_FXF_ACCESS_APPEND_DATA - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXF_ACCESS_APPEND_DATA_ATOMIC - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXF_ACCESS_AUDIT_ALARM_INFO - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXF_ACCESS_BACKUP - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXF_ACCESS_BLOCK_ADVISORY - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXF_ACCESS_BLOCK_DELETE - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXF_ACCESS_BLOCK_READ - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXF_ACCESS_BLOCK_WRITE - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXF_ACCESS_DISPOSITION - Static variable in class com.sshtools.client.sftp.SftpChannel
Version 5 new flags
SSH_FXF_ACCESS_TEXT_MODE - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXF_BACKUP_STREAM - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXF_CREATE_NEW - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXF_CREATE_TRUNCATE - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXF_DELETE_ON_CLOSE - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXF_NOFOLLOW - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXF_OPEN_EXISTING - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXF_OPEN_OR_CREATE - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXF_OVERRIDE_OWNER - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXF_TRUNCATE_EXISTING - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXP_ATTRS - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXP_DATA - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXP_EXTENDED - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXP_EXTENDED_REPLY - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXP_HANDLE - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXP_NAME - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXP_RENAME_ATOMIC - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXP_RENAME_NATIVE - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXP_RENAME_OVERWRITE - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_FXP_STATUS - Static variable in class com.sshtools.client.sftp.SftpChannel
 
SSH_MSG_KEX_ECDH_INIT - Static variable in class com.sshtools.client.components.Curve25519SHA256Client
 
SSH_MSG_KEX_ECDH_INIT - Static variable in class com.sshtools.client.components.DiffieHellmanEcdh
 
SSH_MSG_KEX_ECDH_REPLY - Static variable in class com.sshtools.client.components.Curve25519SHA256Client
 
SSH_MSG_KEX_ECDH_REPLY - Static variable in class com.sshtools.client.components.DiffieHellmanEcdh
 
SSH_MSG_USERAUTH_BANNER - Static variable in class com.sshtools.client.AuthenticationProtocolClient
 
SSH_MSG_USERAUTH_FAILURE - Static variable in class com.sshtools.client.AuthenticationProtocolClient
 
SSH_MSG_USERAUTH_PK_OK - Static variable in class com.sshtools.client.ExternalKeyAuthenticator
 
SSH_MSG_USERAUTH_PK_OK - Static variable in class com.sshtools.client.PublicKeyAuthenticator
 
SSH_MSG_USERAUTH_REQUEST - Static variable in class com.sshtools.client.AuthenticationProtocolClient
 
SSH_MSG_USERAUTH_SUCCESS - Static variable in class com.sshtools.client.AuthenticationProtocolClient
 
SshClient - Class in com.sshtools.client
 
SshClient(String, int, String, long, char[]) - Constructor for class com.sshtools.client.SshClient
 
SshClient(String, int, String, char[]) - Constructor for class com.sshtools.client.SshClient
 
SshClient(String, int, String, long, File) - Constructor for class com.sshtools.client.SshClient
 
SshClient(String, int, String, File) - Constructor for class com.sshtools.client.SshClient
 
SshClient(String, int, String, long, File, String) - Constructor for class com.sshtools.client.SshClient
 
SshClient(String, int, String, File, String) - Constructor for class com.sshtools.client.SshClient
 
SshClient(String, int, String, long, SshKeyPair...) - Constructor for class com.sshtools.client.SshClient
 
SshClient(String, int, String, SshKeyPair...) - Constructor for class com.sshtools.client.SshClient
 
SshClient(String, int, String, SshClientContext, long, SshKeyPair...) - Constructor for class com.sshtools.client.SshClient
 
SshClient(String, int, String, SshClientContext, SshKeyPair...) - Constructor for class com.sshtools.client.SshClient
 
SshClient(String, int, String, long, char[], SshKeyPair...) - Constructor for class com.sshtools.client.SshClient
 
SshClient(String, int, String, char[], SshKeyPair...) - Constructor for class com.sshtools.client.SshClient
 
SshClient(String, Integer, String, long, char[], File, String) - Constructor for class com.sshtools.client.SshClient
 
SshClient(String, Integer, String, char[], File, String) - Constructor for class com.sshtools.client.SshClient
 
SshClient(String, Integer, String, long) - Constructor for class com.sshtools.client.SshClient
 
SshClient(String, Integer, String) - Constructor for class com.sshtools.client.SshClient
 
SshClient(String, Integer, String, SshClientContext, long) - Constructor for class com.sshtools.client.SshClient
 
SshClient(String, Integer, String, SshClientContext) - Constructor for class com.sshtools.client.SshClient
 
SshClient(String, int, String, SshClientContext, long, char[], SshKeyPair...) - Constructor for class com.sshtools.client.SshClient
 
SshClientContext - Class in com.sshtools.client
Holds the configuration for an SSH connection.
SshClientContext() - Constructor for class com.sshtools.client.SshClientContext
 
SshClientContext(SshEngine, ComponentManager, SecurityLevel) - Constructor for class com.sshtools.client.SshClientContext
 
SshClientContext(SshEngine) - Constructor for class com.sshtools.client.SshClientContext
 
SshClientContext(SshEngine, SecurityLevel) - Constructor for class com.sshtools.client.SshClientContext
 
SshClientContext(SecurityLevel) - Constructor for class com.sshtools.client.SshClientContext
 
SshCompatibilityUtils - Class in com.sshtools.client
 
SshCompatibilityUtils() - Constructor for class com.sshtools.client.SshCompatibilityUtils
 
SshKeyExchangeClient - Class in com.sshtools.client
An abstract base class for all key exchange implementations.
SshKeyExchangeClient(String, SecurityLevel, int) - Constructor for class com.sshtools.client.SshKeyExchangeClient
Contruct an uninitialized key exchange
SshReporter - Class in com.sshtools.client
 
SshReporter() - Constructor for class com.sshtools.client.SshReporter
 
start() - Method in class com.sshtools.client.AuthenticationProtocolClient
 
started(long, String) - Method in interface com.sshtools.client.tasks.FileTransferProgress
The transfer has started
startLocalForwarding(String, int, String, int) - Method in class com.sshtools.client.ConnectionProtocolClient
Start local port forwarding.
startLocalForwarding(String, int, String, int) - Method in class com.sshtools.client.SshClient
 
startRemoteForwarding(String, int, String, int) - Method in class com.sshtools.client.ConnectionProtocolClient
Start remote port forwarding.
startRemoteForwarding(String, int, String, int) - Method in class com.sshtools.client.SshClient
 
startService(Service) - Method in class com.sshtools.client.TransportProtocolClient
 
startShell() - Method in class com.sshtools.client.AbstractSessionChannel
 
startSubsystem(String) - Method in class com.sshtools.client.AbstractSessionChannel
 
stat(String) - Method in class com.sshtools.client.sftp.SftpClient
Returns the attributes of the file from the remote computer.
stat(String) - Method in class com.sshtools.client.sftp.SftpClientTask
Returns the attributes of the file from the remote computer.
statLink(String) - Method in class com.sshtools.client.sftp.SftpClient
Returns the attributes of the link from the remote computer.
statLink(String) - Method in class com.sshtools.client.sftp.SftpClientTask
Returns the attributes of the link from the remote computer.
StatTask - Class in com.sshtools.client.tasks
 
StatTask(Connection<SshClientContext>, String) - Constructor for class com.sshtools.client.tasks.StatTask
 
statVFS(String) - Method in class com.sshtools.client.sftp.SftpClient
 
StatVfs - Class in com.sshtools.client.sftp
 
stop() - Method in class com.sshtools.client.AuthenticationProtocolClient
 
stopLocalForwarding() - Method in class com.sshtools.client.ConnectionProtocolClient
 
stopLocalForwarding(String, int) - Method in class com.sshtools.client.ConnectionProtocolClient
 
stopLocalForwarding(String) - Method in class com.sshtools.client.ConnectionProtocolClient
 
stopLocalForwarding(String, int) - Method in class com.sshtools.client.SshClient
 
stopLocalForwarding() - Method in class com.sshtools.client.SshClient
 
stopRemoteForwarding(String, int) - Method in class com.sshtools.client.ConnectionProtocolClient
 
stopRemoteForwarding() - Method in class com.sshtools.client.ConnectionProtocolClient
 
stopRemoteForwarding(String, int) - Method in class com.sshtools.client.SshClient
 
stopRemoteForwarding() - Method in class com.sshtools.client.SshClient
 
su(String, String) - Method in class com.sshtools.client.shell.ExpectShell
 
su(String, String, String) - Method in class com.sshtools.client.shell.ExpectShell
 
su(String) - Method in class com.sshtools.client.shell.ExpectShell
 
su(String, String, String, ShellMatcher) - Method in class com.sshtools.client.shell.ExpectShell
 
success() - Method in interface com.sshtools.client.ClientAuthenticator
Called by the API to indicate authentication success.
success(boolean, String[]) - Method in interface com.sshtools.client.ClientAuthenticator
 
success() - Method in class com.sshtools.client.SimpleClientAuthenticator
 
success(boolean, String[]) - Method in class com.sshtools.client.SimpleClientAuthenticator
 
sudo(String, String) - Method in class com.sshtools.client.shell.ExpectShell
 
sudo(String, String, String) - Method in class com.sshtools.client.shell.ExpectShell
 
sudo(String, String, String, ShellMatcher) - Method in class com.sshtools.client.shell.ExpectShell
 
supportedCommands() - Method in class com.sshtools.client.DefaultClientChannelFactory
 
supportedKeyExchanges() - Method in class com.sshtools.client.SshClientContext
 
supportsExtension(String) - Method in class com.sshtools.client.sftp.SftpChannel
Does the server support an SFTP extension? This checks the extensions returned by the server during the SFTP version negotiation.
symlink(String, String) - Method in class com.sshtools.client.sftp.SftpClient
Create a symbolic link on the remote computer.
symlink(String, String) - Method in class com.sshtools.client.sftp.SftpClientTask
Create a symbolic link on the remote computer.

T

Task - Class in com.sshtools.client.tasks
 
Task(SshConnection) - Constructor for class com.sshtools.client.tasks.Task
 
Task(SshClient) - Constructor for class com.sshtools.client.tasks.Task
 
test() - Method in class com.sshtools.client.components.Curve25519SHA256Client
 
test() - Method in class com.sshtools.client.components.DiffieHellmanEcdh
 
test() - Method in class com.sshtools.client.components.DiffieHellmanGroup
 
test() - Method in class com.sshtools.client.components.DiffieHellmanGroupExchange
 
test() - Method in class com.sshtools.client.components.Rsa1024Sha1
 
test() - Method in class com.sshtools.client.components.Rsa2048Sha256
 
testClientKeyExchangeAlgorithm(String, Class<? extends SshKeyExchange<? extends SshContext>>) - Method in class com.sshtools.client.SshClientContext
 
timeout - Variable in class com.sshtools.client.tasks.AbstractSubsystem
 
timeout - Variable in class com.sshtools.client.tasks.AbstractSubsystemTask
 
toByteArray() - Method in class com.sshtools.client.PseudoTerminalModes
Returns the encoded modes for use by the SshSession.
TOSTOP - Static variable in class com.sshtools.client.PseudoTerminalModes
Stop background jobs from output.
toString() - Method in class com.sshtools.client.sftp.SftpFile
 
TransferCancelledException - Exception in com.sshtools.client.sftp
Exception thrown when a file transfer is cancelled.
TransferCancelledException() - Constructor for exception com.sshtools.client.sftp.TransferCancelledException
Creates a new TransferCancelledException object.
transport - Variable in class com.sshtools.client.SshClientContext
 
transport - Variable in class com.sshtools.client.SshKeyExchangeClient
The transport protocol for sending/receiving messages
TransportProtocolClient - Class in com.sshtools.client
The implementation of the client side of the SSH transport protocol.
TransportProtocolClient(SshClientContext, ConnectRequestFuture) - Constructor for class com.sshtools.client.TransportProtocolClient
 
TTY_OP_ISPEED - Static variable in class com.sshtools.client.PseudoTerminalModes
Specifies the input baud rate in bits per second.
TTY_OP_OSPEED - Static variable in class com.sshtools.client.PseudoTerminalModes
Specifies the output baud rate in bits per second.
type(String) - Method in class com.sshtools.client.shell.ShellController
 
type(String) - Method in interface com.sshtools.client.shell.ShellWriter
Send data to the remote command just like the user had typed it.
typeAndReturn(String) - Method in class com.sshtools.client.shell.ShellController
 
typeAndReturn(String) - Method in interface com.sshtools.client.shell.ShellWriter
Send data to the remote command and finish with a carriage return.

U

umask(int) - Method in class com.sshtools.client.sftp.SftpClient
Sets the umask used by this client.
umask(String) - Method in class com.sshtools.client.sftp.SftpClient
Sets the umask for this client.
umask(int) - Method in class com.sshtools.client.sftp.SftpClientTask
Sets the umask used by this client.
umask(String) - Method in class com.sshtools.client.sftp.SftpClientTask
Sets the umask for this client.
unlockFile(byte[], long, long) - Method in class com.sshtools.client.sftp.SftpChannel
 
UploadFileContentTask - Class in com.sshtools.client.tasks
 
UploadFileContentTask(SshClient, String, String, String) - Constructor for class com.sshtools.client.tasks.UploadFileContentTask
 
UploadFileContentTask(Connection<SshClientContext>, String, String, String) - Constructor for class com.sshtools.client.tasks.UploadFileContentTask
 
UploadFileTask - Class in com.sshtools.client.tasks
 
UploadFileTask(Connection<SshClientContext>, File, String) - Constructor for class com.sshtools.client.tasks.UploadFileTask
 
UploadFileTask(Connection<SshClientContext>, File) - Constructor for class com.sshtools.client.tasks.UploadFileTask
 
UploadInputStreamTask - Class in com.sshtools.client.tasks
 
UploadInputStreamTask(SshClient, InputStream, String) - Constructor for class com.sshtools.client.tasks.UploadInputStreamTask
 
UploadInputStreamTask(SshConnection, InputStream, String) - Constructor for class com.sshtools.client.tasks.UploadInputStreamTask
 
useFirstPacket - Variable in class com.sshtools.client.SshKeyExchangeClient
 

V

valueOf(String) - Static method in enum com.sshtools.client.ProxyType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.sshtools.client.shell.ShellMatcher.Continue
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.sshtools.client.ProxyType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.sshtools.client.shell.ShellMatcher.Continue
Returns an array containing the constants of this enum type, in the order they are declared.
VDISCARD - Static variable in class com.sshtools.client.PseudoTerminalModes
Toggles the flushing of terminal output.
VDSUSP - Static variable in class com.sshtools.client.PseudoTerminalModes
Another suspend character.
VEOF - Static variable in class com.sshtools.client.PseudoTerminalModes
End-of-file character (sends EOF from the terminal).
VEOL - Static variable in class com.sshtools.client.PseudoTerminalModes
End-of-line character in addition to carriage return and/or linefeed.
VEOL2 - Static variable in class com.sshtools.client.PseudoTerminalModes
Additional end-of-line character.
VERASE - Static variable in class com.sshtools.client.PseudoTerminalModes
Erase the character to left of the cursor.
verifyFiles(String, String) - Method in class com.sshtools.client.sftp.SftpClient
Verify a local and remote file.
verifyFiles(String, String, long, long) - Method in class com.sshtools.client.sftp.SftpClient
Verify a local and remote file.
verifyFiles(String, String) - Method in class com.sshtools.client.sftp.SftpClientTask
Verify a local and remote file.
verifyFiles(String, String, long, long) - Method in class com.sshtools.client.sftp.SftpClientTask
Verify a local and remote file.
VFLUSH - Static variable in class com.sshtools.client.PseudoTerminalModes
Character to flush output.
VINTR - Static variable in class com.sshtools.client.PseudoTerminalModes
Interrupt character; 255 if none.
VKILL - Static variable in class com.sshtools.client.PseudoTerminalModes
Kill the current input line.
VLNEXT - Static variable in class com.sshtools.client.PseudoTerminalModes
Enter the next character typed literally, even if it is a special character
VQUIT - Static variable in class com.sshtools.client.PseudoTerminalModes
The quit character (sends SIGQUIT signal on POSIX systems).
VREPRINT - Static variable in class com.sshtools.client.PseudoTerminalModes
Reprints the current input line.
VSTART - Static variable in class com.sshtools.client.PseudoTerminalModes
Continues paused output (normally control-Q).
VSTATUS - Static variable in class com.sshtools.client.PseudoTerminalModes
Prints system status line (load, command, pid, etc).
VSTOP - Static variable in class com.sshtools.client.PseudoTerminalModes
Pauses output (normally control-S).
VSUSP - Static variable in class com.sshtools.client.PseudoTerminalModes
Suspends the current program.
VSWITCH - Static variable in class com.sshtools.client.PseudoTerminalModes
Switch to a different shell layer.
VWERASE - Static variable in class com.sshtools.client.PseudoTerminalModes
Erases a word left of cursor.

W

waitForResponse() - Method in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
 
write(long, byte[], int, int) - Method in class com.sshtools.client.sftp.SftpFile
Write bytes directly to this file.
write(byte[], int, int) - Method in class com.sshtools.client.sftp.SftpFileOutputStream
 
write(int) - Method in class com.sshtools.client.sftp.SftpFileOutputStream
 
writeCompleteFile(InputStream, long, FileTransferProgress) - Method in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
 
writeError(String) - Method in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
 
writeFile(byte[], UnsignedInteger64, byte[], int, int) - Method in class com.sshtools.client.sftp.SftpChannel
Write a block of data to an open file.
writeMessageIntoBuffer(ByteBuffer) - Method in class com.sshtools.client.AuthenticationMessage
 
writeOk() - Method in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
 
writeStreamToRemote(InputStream, long, String, FileTransferProgress) - Method in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
Write a stream as a file to the remote server.

X

XCASE - Static variable in class com.sshtools.client.PseudoTerminalModes
Enable input and output of uppercase characters by preceding their lowercase equivalents with "\".
A B C D E F G H I K L M N O P Q R S T U V W X 
Skip navigation links

Copyright © 2021. All rights reserved.