Index (Client API 3.1.2 API)

A B C D E F G H I K L M N O P Q R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractCommandTask - Class in com.sshtools.client.tasks: Deprecated.
AbstractCommandTask(AbstractSessionTask.AbstractSessionTaskBuilder<?, SessionChannelNG, ?>, String, String, boolean) - Constructor for class com.sshtools.client.tasks.AbstractCommandTask: Deprecated.
AbstractCommandTask(SshConnection, String) - Constructor for class com.sshtools.client.tasks.AbstractCommandTask: Deprecated, for removal: This API element is subject to removal in a future version.
AbstractCommandTask(SshConnection, String, ChannelRequestFuture) - Constructor for class com.sshtools.client.tasks.AbstractCommandTask: Deprecated, for removal: This API element is subject to removal in a future version.
AbstractCommandTask(SshConnection, String, String) - Constructor for class com.sshtools.client.tasks.AbstractCommandTask: Deprecated, for removal: This API element is subject to removal in a future version.
AbstractCommandTask(SshConnection, String, String, ChannelRequestFuture) - Constructor for class com.sshtools.client.tasks.AbstractCommandTask: Deprecated, for removal: This API element is subject to removal in a future version.
AbstractConnectionTask - Class in com.sshtools.client.tasks
AbstractConnectionTask(SshClient) - Constructor for class com.sshtools.client.tasks.AbstractConnectionTask: Deprecated, for removal: This API element is subject to removal in a future version.
AbstractConnectionTask(AbstractConnectionTask.AbstractConnectionTaskBuilder<?, ?>) - Constructor for class com.sshtools.client.tasks.AbstractConnectionTask
AbstractConnectionTask(SshConnection) - Constructor for class com.sshtools.client.tasks.AbstractConnectionTask: Deprecated, for removal: This API element is subject to removal in a future version.
AbstractConnectionTask.AbstractConnectionTaskBuilder<B extends AbstractConnectionTask.AbstractConnectionTaskBuilder<B,T>,T extends AbstractConnectionTask> - Class in com.sshtools.client.tasks
AbstractConnectionTaskBuilder() - Constructor for class com.sshtools.client.tasks.AbstractConnectionTask.AbstractConnectionTaskBuilder
AbstractFileTask - Class in com.sshtools.client.tasks
AbstractFileTask(AbstractFileTask.AbstractFileTaskBuilder<?, ?>) - Constructor for class com.sshtools.client.tasks.AbstractFileTask
AbstractFileTask.AbstractFileTaskBuilder<B extends AbstractFileTask.AbstractFileTaskBuilder<B,T>,T extends AbstractConnectionTask> - Class in com.sshtools.client.tasks
AbstractFileTaskBuilder() - Constructor for class com.sshtools.client.tasks.AbstractFileTask.AbstractFileTaskBuilder
AbstractKeyboardInteractiveCallback - Class in com.sshtools.client
AbstractKeyboardInteractiveCallback() - Constructor for class com.sshtools.client.AbstractKeyboardInteractiveCallback
AbstractOptimisedTask<TARGET,LOCALFILE> - Class in com.sshtools.client.tasks
AbstractOptimisedTask(AbstractOptimisedTask.AbstractOptimisedTaskBuilder<?, ?, LOCALFILE>) - Constructor for class com.sshtools.client.tasks.AbstractOptimisedTask
AbstractOptimisedTask.AbstractOptimisedTaskBuilder<B extends AbstractOptimisedTask.AbstractOptimisedTaskBuilder<B,T,LOCALFILE>,T extends AbstractOptimisedTask<?,?>,LOCALFILE> - Class in com.sshtools.client.tasks
AbstractOptimisedTask.FileTransferProgressWrapper - Class in com.sshtools.client.tasks
AbstractOptimisedTask.ProgressMessages - Interface in com.sshtools.client.tasks: Interface to be implemented by classes that monitor the progress of file transfers and output feedback.
AbstractOptimisedTaskBuilder() - Constructor for class com.sshtools.client.tasks.AbstractOptimisedTask.AbstractOptimisedTaskBuilder
AbstractSessionChannel - Class in com.sshtools.client: Implements the client side of the SSH Connection protocol session channel
AbstractSessionChannel(int, UnsignedInteger32, UnsignedInteger32, UnsignedInteger32, boolean) - Constructor for class com.sshtools.client.AbstractSessionChannel
AbstractSessionChannel(int, UnsignedInteger32, UnsignedInteger32, UnsignedInteger32, 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: Deprecated.
AbstractSessionTask(AbstractSessionTask.AbstractSessionTaskBuilder<?, T, ?>) - Constructor for class com.sshtools.client.tasks.AbstractSessionTask
AbstractSessionTask(SshConnection) - Constructor for class com.sshtools.client.tasks.AbstractSessionTask
AbstractSessionTask(SshConnection, ChannelRequestFuture) - Constructor for class com.sshtools.client.tasks.AbstractSessionTask: Deprecated.
AbstractSessionTask.AbstractSessionTaskBuilder<B extends AbstractSessionTask.AbstractSessionTaskBuilder<B,SC,TT>,SC extends AbstractSessionChannel,TT extends AbstractSessionTask<SC>> - Class in com.sshtools.client.tasks: Builder for AbstractSessionTask.
AbstractSessionTaskBuilder() - Constructor for class com.sshtools.client.tasks.AbstractSessionTask.AbstractSessionTaskBuilder
AbstractShellTask<T extends AbstractSessionChannel> - Class in com.sshtools.client.tasks: An abstract task for starting the shell.
AbstractShellTask(SshClient) - Constructor for class com.sshtools.client.tasks.AbstractShellTask: Deprecated, for removal: This API element is subject to removal in a future version.
AbstractShellTask(AbstractSessionTask.AbstractSessionTaskBuilder<?, T, ?>) - Constructor for class com.sshtools.client.tasks.AbstractShellTask
AbstractShellTask(SshConnection) - Constructor for class com.sshtools.client.tasks.AbstractShellTask: Deprecated, for removal: This API element is subject to removal in a future version.
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
accept(SshClientContext) - Method in interface com.sshtools.client.SshClient.OnConfiguration
acceptedKey(Path, SshPublicKey) - Method in interface com.sshtools.client.PublicKeyAcceptable
addAbstactFiles(Collection<AbstractFile>) - Method in class com.sshtools.client.tasks.PushTask.PushTaskBuilder: Add a collection of AbstractFile objects to transfer.
addAuthentication(ClientAuthenticator) - Method in class com.sshtools.client.AuthenticationProtocolClient
addAuthentication(Collection<ClientAuthenticator>) - Method in class com.sshtools.client.AuthenticationProtocolClient
addAuthenticator(ClientAuthenticator) - Method in class com.sshtools.client.SshClientContext
addAuthenticators(ClientAuthenticator...) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Add one or more ClientAuthenticator instances that will be presented to the server one at a time.
addAuthenticators(Collection<ClientAuthenticator>) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Add one or more ClientAuthenticator instances that will be presented to the server one at a time.
addCustomRoot(String) - Method in class com.sshtools.client.sftp.SftpClient: Deprecated, for removal: This API element is subject to removal in a future version.
addCustomRoot(String) - Method in class com.sshtools.client.sftp.SftpClientTask: Deprecated, for removal: This API element is subject to removal in a future version.
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.
addFilePaths(Collection<String>) - Method in class com.sshtools.client.tasks.PushTask.PushTaskBuilder: Add a collection of paths to transfer.
addFiles(Collection<File>) - Method in class com.sshtools.client.tasks.PushTask.PushTaskBuilder: Add a collection of files to transfer.
addGlobalRequestHandler(GlobalRequestHandler<SshClientContext>) - Method in class com.sshtools.client.SshClientContext
addIdentities(SshKeyPair...) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Add on more identities (key pairs) to use for authentication.
addIdentities(Collection<SshKeyPair>) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Add a key pair to use for authentication.
addPaths(String...) - Method in class com.sshtools.client.tasks.PullTask.PullTaskBuilder: Add a collection of paths to transfer.
addPaths(Collection<String>) - Method in class com.sshtools.client.tasks.PullTask.PullTaskBuilder: Add a collection of paths to transfer.
addPaths(Collection<Path>) - Method in class com.sshtools.client.tasks.PushTask.PushTaskBuilder: Add a collection of paths to transfer.
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, int, int, PseudoTerminalModes) - Method in class com.sshtools.client.AbstractSessionChannel: Deprecated, for removal: This API element is subject to removal in a future version.
allocatePseudoTerminal(String, int, int, int, int, TerminalModes) - Method in class com.sshtools.client.AbstractSessionChannel
allocatePseudoTerminal(String, 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: Deprecated.
append(InputStream, String, FileTransferProgress, long) - 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: Deprecated.
append(String, String, FileTransferProgress, long) - 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>) - Constructor for class com.sshtools.client.tasks.AsyncSessionTask
AsyncSessionTask(Connection<SshClientContext>, ChannelRequestFuture) - Constructor for class com.sshtools.client.tasks.AsyncSessionTask
attributes() - Method in class com.sshtools.client.sftp.SftpFile: Get the attributes for this file as they were when this file object was obtained.
attributes(SftpFileAttributes) - Method in class com.sshtools.client.sftp.SftpFile: Set the given attributes on the remote file represented by this SftpFile.
authenticate(AuthenticationProtocolClient, SshConnection, Set<String>, boolean) - Method in interface com.sshtools.client.ClientStateListener
authenticate(ClientAuthenticator, long) - Method in class com.sshtools.client.SshClient
authenticate(TransportProtocolClient, String) - Method in interface com.sshtools.client.ClientAuthenticator: Start the authentication
authenticate(TransportProtocolClient, String) - Method in class com.sshtools.client.KeyboardInteractiveAuthenticator
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.PublicKeyAuthenticator
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.ChunkInputStream
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: Deprecated, for removal: This API element is subject to removal in a future version.
beforeExecuteCommand(SessionChannelNG) - Method in class com.sshtools.client.tasks.CommandTask
beforeStartShell(SessionChannelNG) - Method in class com.sshtools.client.tasks.ShellTask: Deprecated.
beforeStartShell(T) - Method in class com.sshtools.client.tasks.AbstractShellTask
blocksize - Variable in class com.sshtools.client.tasks.AbstractOptimisedTask
buffer - Variable in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
buffersize - Variable in class com.sshtools.client.tasks.AbstractOptimisedTask
build() - Method in class com.sshtools.client.PseudoTerminalModes.PseudoTerminalModesBuilder: Deprecated.

Build a new PseudoTerminalModes.
build() - Method in class com.sshtools.client.sftp.SftpClient.SftpClientBuilder: Build a new SftpClient.
build() - Method in class com.sshtools.client.SshClient.PreConnectedSshClientBuilder: Build a new SshClient.SshClientBuilder set.
build() - Method in class com.sshtools.client.SshClient.SshClientBuilder: Build a new SshClient.SshClientBuilder set.
build() - Method in class com.sshtools.client.tasks.AbstractConnectionTask.AbstractConnectionTaskBuilder
build() - Method in class com.sshtools.client.tasks.AbstractFileTask.AbstractFileTaskBuilder
build() - Method in class com.sshtools.client.tasks.CommandTask.CommandTaskBuilder
build() - Method in class com.sshtools.client.tasks.DownloadFileTask.DownloadFileTaskBuilder
build() - Method in class com.sshtools.client.tasks.DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder
build() - Method in class com.sshtools.client.tasks.PullTask.PullTaskBuilder: Build a new PullTask that may be scheduled for execution (e.g.
build() - Method in class com.sshtools.client.tasks.PushTask.PushTaskBuilder: Build a new PushTask that may be scheduled for execution (e.g.
build() - Method in class com.sshtools.client.tasks.ShellTask.ShellTaskBuilder
build() - Method in class com.sshtools.client.tasks.StatTask.StatTaskBuilder
build() - Method in class com.sshtools.client.tasks.UploadFileContentTask.UploadFileContentTaskBuilder
build() - Method in class com.sshtools.client.tasks.UploadFileTask.UploadFileTaskBuilder
build() - Method in class com.sshtools.client.tasks.UploadInputStreamTask.UploadInputStreamTaskBuilder

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: Deprecated, for removal: This API element is subject to removal in a future version.
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: Deprecated, for removal: This API element is subject to removal in a future version.
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(byte[], int) - Method in class com.sshtools.client.sftp.SftpChannel: Deprecated, for removal: This API element is subject to removal in a future version.
changePermissions(byte[], PosixPermissions) - 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: Deprecated, for removal: This API element is subject to removal in a future version.
changePermissions(String, PosixPermissions) - 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
checkErrors(Collection<Throwable>) - Method in class com.sshtools.client.tasks.AbstractOptimisedTask
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: Deprecated.
chmod(int, String) - Method in class com.sshtools.client.sftp.SftpClientTask: Deprecated.
chmod(PosixPermissions, String) - Method in class com.sshtools.client.sftp.SftpClient: Changes the access permissions or modes of the specified file or directory.
chmod(PosixPermissions, 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.
chown(String, String, String) - Method in class com.sshtools.client.sftp.SftpClient: Sets the user ID to owner for the file or directory.
ChunkInputStream - Class in com.sshtools.client
ChunkInputStream(AbstractFileRandomAccess, long) - Constructor for class com.sshtools.client.ChunkInputStream
chunkProgress - Variable in class com.sshtools.client.tasks.AbstractOptimisedTask
chunks - Variable in class com.sshtools.client.tasks.AbstractOptimisedTask
clearOutput() - Method in class com.sshtools.client.shell.ShellProcess
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
clients - Variable in class com.sshtools.client.tasks.AbstractOptimisedTask
ClientStateListener - Interface in com.sshtools.client
clientSupplier - Variable in class com.sshtools.client.tasks.AbstractConnectionTask.AbstractConnectionTaskBuilder
clientSupplier - Variable in class com.sshtools.client.tasks.AbstractConnectionTask
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.SftpClient
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.sftp.SftpHandle: Close the 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(SftpHandle) - Method in class com.sshtools.client.sftp.SftpChannel: Deprecated.
closeHandle(byte[]) - Method in class com.sshtools.client.sftp.SftpChannel: Deprecated.
closeOnTaskComplete() - Method in class com.sshtools.client.tasks.AbstractSessionTask: Deprecated.
closeOnTaskComplete() - Method in class com.sshtools.client.tasks.CommandTask: Deprecated, for removal: This API element is subject to removal in a future version.
closeOnTaskComplete() - Method in class com.sshtools.client.tasks.ShellTask: Deprecated, for removal: This API element is subject to removal in a future version.
cmd - Variable in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
collectIdentities(boolean) - Static method in class com.sshtools.client.IdentityFileAuthenticator
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
commandEvent(CommandTask, SessionChannelNG) - Method in interface com.sshtools.client.tasks.CommandTask.CommandTaskEvent: Command task event occurred.
CommandTask - Class in com.sshtools.client.tasks: Task for executing commands.
CommandTask.CommandTaskBuilder - Class in com.sshtools.client.tasks: Builder for CommandTask.
CommandTask.CommandTaskEvent - Interface in com.sshtools.client.tasks: Functional interface for tasks run on certain command task events.
complete() - Method in interface com.sshtools.client.KeyboardInteractivePromptCompletor
completed() - Method in class com.sshtools.client.tasks.AbstractOptimisedTask.FileTransferProgressWrapper
completed() - Method in interface com.sshtools.client.tasks.FileTransferProgress: The transfer has completed.
completed(boolean, String, ClientAuthenticator) - Method in interface com.sshtools.client.NotifiedPrompt
completed(boolean, String, ClientAuthenticator) - Method in interface com.sshtools.client.PassphrasePrompt
completed(boolean, String, ClientAuthenticator) - Method in interface com.sshtools.client.PasswordAuthenticator.PasswordPrompt
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: Deprecated, for removal: This API element is subject to removal in a future version.
configureConnections() - Method in class com.sshtools.client.tasks.AbstractOptimisedTask
configureKeyExchanges() - Method in class com.sshtools.client.SshClientContext
configureTargetFolder() - Method in class com.sshtools.client.tasks.AbstractOptimisedTask
configureTargetFolder() - Method in class com.sshtools.client.tasks.PullTask
configureTargetFolder() - Method in class com.sshtools.client.tasks.PushTask
connection - Variable in class com.sshtools.client.AbstractKeyboardInteractiveCallback
connection - Variable in class com.sshtools.client.tasks.AbstractConnectionTask.AbstractConnectionTaskBuilder
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(SftpFile) - Method in class com.sshtools.client.sftp.DirectoryOperation: Determine whether the directory operation contains an SftpFile
containsFile(AbstractFile) - Method in class com.sshtools.client.sftp.DirectoryOperation: Determine whether the operation contains a file.
CONTENT_DOES_NOT_MATCH - Enum constant in enum com.sshtools.client.shell.ShellMatcher.Continue
CONTENT_MATCHES - Enum constant in enum com.sshtools.client.shell.ShellMatcher.Continue
copyRemoteData(SftpFile, UnsignedInteger64, UnsignedInteger64, SftpFile, UnsignedInteger64) - Method in class com.sshtools.client.sftp.SftpClient: Deprecated, for removal: This API element is subject to removal in a future version.
copyRemoteFile(String, String, boolean) - Method in class com.sshtools.client.sftp.SftpClient
copyTo(SftpHandle, UnsignedInteger64, UnsignedInteger64, UnsignedInteger64) - Method in class com.sshtools.client.sftp.SftpHandle
create() - Method in class com.sshtools.client.components.Curve25519SHA256Client.Curve25519SHA256ClientFactory
create() - Method in class com.sshtools.client.components.Curve25519SHA256LibSshClient.Curve25519SHA256LibSshClientFactory
create() - Method in class com.sshtools.client.components.DiffieHellmanEcdhNistp256.DiffieHellmanEcdhNistp256Factory
create() - Method in class com.sshtools.client.components.DiffieHellmanEcdhNistp384.DiffieHellmanEcdhNistp384Factory
create() - Method in class com.sshtools.client.components.DiffieHellmanEcdhNistp521.DiffieHellmanEcdhNistp521Factory
create() - Method in class com.sshtools.client.components.DiffieHellmanGroup14Sha1JCE.DiffieHellmanGroup14Sha1JCEFactory
create() - Method in class com.sshtools.client.components.DiffieHellmanGroup14Sha256JCE.DiffieHellmanGroup14Sha256JCEFactory
create() - Method in class com.sshtools.client.components.DiffieHellmanGroup15Sha512JCE.DiffieHellmanGroup15Sha512JCEFactory
create() - Method in class com.sshtools.client.components.DiffieHellmanGroup16Sha512JCE.DiffieHellmanGroup16Sha512JCEFactory
create() - Method in class com.sshtools.client.components.DiffieHellmanGroup17Sha512JCE.DiffieHellmanGroup17Sha512JCEFactory
create() - Method in class com.sshtools.client.components.DiffieHellmanGroup18Sha512JCE.DiffieHellmanGroup18Sha512JCEFactory
create() - Method in class com.sshtools.client.components.DiffieHellmanGroup1Sha1JCE.DiffieHellmanGroup1Sha1JCEFactory
create() - Method in class com.sshtools.client.components.DiffieHellmanGroupExchangeSha1JCE.DiffieHellmanGroupExchangeSha1JCEFactory
create() - Method in class com.sshtools.client.components.DiffieHellmanGroupExchangeSha256JCE.DiffieHellmanGroupExchangeSha256JCEFactory
create() - Method in class com.sshtools.client.components.Rsa1024Sha1.Rsa1024Sha1Factory
create() - Method in class com.sshtools.client.components.Rsa2048Sha256.Rsa2048Sha256Factory
create() - Static method in class com.sshtools.client.PseudoTerminalModes.PseudoTerminalModesBuilder: Deprecated.

Create a new PseudoTerminalModes.PseudoTerminalModesBuilder
create() - Static method in class com.sshtools.client.sftp.SftpClient.SftpClientBuilder: Create a new SftpClient.SftpClientBuilder.
create() - Static method in class com.sshtools.client.SshClient.SshClientBuilder: Create a new SshClient.SshClientBuilder
create() - Static method in class com.sshtools.client.tasks.CommandTask.CommandTaskBuilder: Create a new CommandTask.CommandTaskBuilder.
create() - Static method in class com.sshtools.client.tasks.DownloadFileTask.DownloadFileTaskBuilder: Create a new DownloadFileTask.DownloadFileTaskBuilder
create() - Static method in class com.sshtools.client.tasks.DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder: Create a new DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder
create() - Static method in class com.sshtools.client.tasks.PullTask.PullTaskBuilder: Create a new PullTask.PullTaskBuilder
create() - Static method in class com.sshtools.client.tasks.PushTask.PushTaskBuilder: Create a new PushTask.PushTaskBuilder
create() - Static method in class com.sshtools.client.tasks.ShellTask.ShellTaskBuilder: Create a new ShellTask.ShellTaskBuilder.
create() - Static method in class com.sshtools.client.tasks.StatTask.StatTaskBuilder: Create a new StatTask.StatTaskBuilder
create() - Static method in class com.sshtools.client.tasks.UploadFileContentTask.UploadFileContentTaskBuilder: Create a new UploadFileContentTask.UploadFileContentTaskBuilder
create() - Static method in class com.sshtools.client.tasks.UploadFileTask.UploadFileTaskBuilder: Create a new UploadFileTask.UploadFileTaskBuilder
create() - Static method in class com.sshtools.client.tasks.UploadInputStreamTask.UploadInputStreamTaskBuilder: Create a new UploadInputStreamTask.UploadInputStreamTaskBuilder
create(SshConnection) - Static method in class com.sshtools.client.SshClient.SshClientBuilder: Create a new SshClient.SshClientBuilder using an existing connection.
createChannel() - Method in class com.sshtools.client.AbstractSessionChannel
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.LocalForwardingChannelFactoryImpl
createChannel(String, Connection<SshClientContext>) - Method in class com.sshtools.client.ConnectionProtocolClient: Create an SSH channel.
createChannelFactory(String, int) - 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() - Method in class com.sshtools.client.tasks.AbstractSubsystemTask
createSession(SshConnection) - Method in class com.sshtools.client.tasks.AbstractCommandTask: Deprecated, for removal: This API element is subject to removal in a future version.
createSession(SshConnection) - Method in class com.sshtools.client.tasks.AbstractSessionTask
createSession(SshConnection) - Method in class com.sshtools.client.tasks.CommandTask
createSession(SshConnection) - Method in class com.sshtools.client.tasks.ShellTask: Deprecated.
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: Deprecated.

7 bit mode.
CS8 - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

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
Curve25519SHA256Client.Curve25519SHA256ClientFactory - Class in com.sshtools.client.components
Curve25519SHA256ClientFactory() - Constructor for class com.sshtools.client.components.Curve25519SHA256Client.Curve25519SHA256ClientFactory
Curve25519SHA256LibSshClient - Class in com.sshtools.client.components
Curve25519SHA256LibSshClient() - Constructor for class com.sshtools.client.components.Curve25519SHA256LibSshClient
Curve25519SHA256LibSshClient.Curve25519SHA256LibSshClientFactory - Class in com.sshtools.client.components
Curve25519SHA256LibSshClientFactory() - Constructor for class com.sshtools.client.components.Curve25519SHA256LibSshClient.Curve25519SHA256LibSshClientFactory

D

DEFAULT_BUFFER_SIZE - Static variable in class com.sshtools.client.sftp.SftpClient: Default buffer size
DEFAULT_CONNECT_TIMEOUT - Static variable in class com.sshtools.client.SshClient
DefaultClientChannelFactory - Class in com.sshtools.client: Implements a default ChannelFactory for an SSH client.
DefaultClientChannelFactory() - Constructor for class com.sshtools.client.DefaultClientChannelFactory
DefaultRemoteForwardRequestHandler - Class in com.sshtools.client
DefaultRemoteForwardRequestHandler() - Constructor for class com.sshtools.client.DefaultRemoteForwardRequestHandler
delete() - Method in class com.sshtools.client.sftp.SftpFile: Delete this file/directory from the remote server.
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".
DIFFIE_HELLMAN_GROUP1_SHA1 - Static variable in class com.sshtools.client.components.DiffieHellmanGroup1Sha1JCE: Constant for the algorithm name "diffie-hellman-group1-sha1".
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".
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
DiffieHellmanEcdhNistp256.DiffieHellmanEcdhNistp256Factory - Class in com.sshtools.client.components
DiffieHellmanEcdhNistp256Factory() - Constructor for class com.sshtools.client.components.DiffieHellmanEcdhNistp256.DiffieHellmanEcdhNistp256Factory
DiffieHellmanEcdhNistp384 - Class in com.sshtools.client.components
DiffieHellmanEcdhNistp384() - Constructor for class com.sshtools.client.components.DiffieHellmanEcdhNistp384
DiffieHellmanEcdhNistp384.DiffieHellmanEcdhNistp384Factory - Class in com.sshtools.client.components
DiffieHellmanEcdhNistp384Factory() - Constructor for class com.sshtools.client.components.DiffieHellmanEcdhNistp384.DiffieHellmanEcdhNistp384Factory
DiffieHellmanEcdhNistp521 - Class in com.sshtools.client.components
DiffieHellmanEcdhNistp521() - Constructor for class com.sshtools.client.components.DiffieHellmanEcdhNistp521
DiffieHellmanEcdhNistp521.DiffieHellmanEcdhNistp521Factory - Class in com.sshtools.client.components
DiffieHellmanEcdhNistp521Factory() - Constructor for class com.sshtools.client.components.DiffieHellmanEcdhNistp521.DiffieHellmanEcdhNistp521Factory
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
DiffieHellmanGroup14Sha1JCE.DiffieHellmanGroup14Sha1JCEFactory - Class in com.sshtools.client.components
DiffieHellmanGroup14Sha1JCEFactory() - Constructor for class com.sshtools.client.components.DiffieHellmanGroup14Sha1JCE.DiffieHellmanGroup14Sha1JCEFactory
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
DiffieHellmanGroup14Sha256JCE.DiffieHellmanGroup14Sha256JCEFactory - Class in com.sshtools.client.components
DiffieHellmanGroup14Sha256JCEFactory() - Constructor for class com.sshtools.client.components.DiffieHellmanGroup14Sha256JCE.DiffieHellmanGroup14Sha256JCEFactory
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
DiffieHellmanGroup15Sha512JCE.DiffieHellmanGroup15Sha512JCEFactory - Class in com.sshtools.client.components
DiffieHellmanGroup15Sha512JCEFactory() - Constructor for class com.sshtools.client.components.DiffieHellmanGroup15Sha512JCE.DiffieHellmanGroup15Sha512JCEFactory
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
DiffieHellmanGroup16Sha512JCE.DiffieHellmanGroup16Sha512JCEFactory - Class in com.sshtools.client.components
DiffieHellmanGroup16Sha512JCEFactory() - Constructor for class com.sshtools.client.components.DiffieHellmanGroup16Sha512JCE.DiffieHellmanGroup16Sha512JCEFactory
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
DiffieHellmanGroup17Sha512JCE.DiffieHellmanGroup17Sha512JCEFactory - Class in com.sshtools.client.components
DiffieHellmanGroup17Sha512JCEFactory() - Constructor for class com.sshtools.client.components.DiffieHellmanGroup17Sha512JCE.DiffieHellmanGroup17Sha512JCEFactory
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
DiffieHellmanGroup18Sha512JCE.DiffieHellmanGroup18Sha512JCEFactory - Class in com.sshtools.client.components
DiffieHellmanGroup18Sha512JCEFactory() - Constructor for class com.sshtools.client.components.DiffieHellmanGroup18Sha512JCE.DiffieHellmanGroup18Sha512JCEFactory
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.
DiffieHellmanGroup1Sha1JCE.DiffieHellmanGroup1Sha1JCEFactory - Class in com.sshtools.client.components
DiffieHellmanGroup1Sha1JCEFactory() - Constructor for class com.sshtools.client.components.DiffieHellmanGroup1Sha1JCE.DiffieHellmanGroup1Sha1JCEFactory
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.
DiffieHellmanGroupExchangeSha1JCE.DiffieHellmanGroupExchangeSha1JCEFactory - Class in com.sshtools.client.components
DiffieHellmanGroupExchangeSha1JCEFactory() - Constructor for class com.sshtools.client.components.DiffieHellmanGroupExchangeSha1JCE.DiffieHellmanGroupExchangeSha1JCEFactory
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.
DiffieHellmanGroupExchangeSha256JCE.DiffieHellmanGroupExchangeSha256JCEFactory - Class in com.sshtools.client.components
DiffieHellmanGroupExchangeSha256JCEFactory() - Constructor for class com.sshtools.client.components.DiffieHellmanGroupExchangeSha256JCE.DiffieHellmanGroupExchangeSha256JCEFactory
digest - Variable in class com.sshtools.client.tasks.AbstractOptimisedTask
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.
displayMessage(String, Object...) - Method in class com.sshtools.client.tasks.AbstractOptimisedTask
doCheckFileHandle(String, long, long, RemoteHash) - Method in class com.sshtools.client.sftp.SftpClient
doCheckHashHandle(byte[], long, long, RemoteHash) - Method in class com.sshtools.client.sftp.SftpClient
doConnect(String, int, SshClientContext, long, List<String>) - Method in class com.sshtools.client.SshClient
doMD5HashHandle(byte[], long, long, byte[]) - Method in class com.sshtools.client.sftp.SftpClient
done(boolean) - Method in class com.sshtools.client.IdentityFileAuthenticator
done(boolean) - Method in class com.sshtools.client.PasswordAuthenticator
doNextAuthentication() - Method in class com.sshtools.client.AuthenticationProtocolClient
doSftp() - Method in class com.sshtools.client.sftp.SftpClientTask: Deprecated, for removal: This API element is subject to removal in a future version.
doSubsystemTask(SessionChannelNG) - Method in class com.sshtools.client.tasks.AbstractSubsystemTask
doTask() - Method in class com.sshtools.client.sftp.SftpClientTask
doTask() - Method in class com.sshtools.client.tasks.AbstractOptimisedTask
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
doTask(T, long) - Method in class com.sshtools.client.SshClient
doTaskUntilDone(Task) - Method in class com.sshtools.client.tasks.AbstractFileTask
DownloadFileTask - Class in com.sshtools.client.tasks: An SFTP Task that downloads complete files.
DownloadFileTask(Connection<SshClientContext>, String) - Constructor for class com.sshtools.client.tasks.DownloadFileTask: Deprecated, for removal: This API element is subject to removal in a future version.
DownloadFileTask(Connection<SshClientContext>, String, File) - Constructor for class com.sshtools.client.tasks.DownloadFileTask: Deprecated, for removal: This API element is subject to removal in a future version.
DownloadFileTask.DownloadFileTaskBuilder - Class in com.sshtools.client.tasks: Builder for DownloadFileTask.
DownloadOutputStreamTask - Class in com.sshtools.client.tasks: An SFTP Task that downloads complete files to an OutputStream.
DownloadOutputStreamTask(Connection<SshClientContext>, String, OutputStream) - Constructor for class com.sshtools.client.tasks.DownloadOutputStreamTask: Deprecated.
DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder - Class in com.sshtools.client.tasks: Builder for 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: Deprecated.

Enable echoing.
ECHOCTL - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Echo control characters as ^(Char).
ECHOE - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Visually erase chars.
ECHOK - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Kill character discards current line.
ECHOKE - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Visual erase for line kill.
ECHONL - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Echo NL even if ECHO is off.
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
equals(Object) - Method in class com.sshtools.client.sftp.SftpHandle
error(String, Throwable, Object...) - Method in interface com.sshtools.client.tasks.AbstractOptimisedTask.ProgressMessages: Display an (optional) error trace along with an (optional) message.
error(Throwable) - Method in interface com.sshtools.client.tasks.AbstractOptimisedTask.ProgressMessages: Display an error.
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(SessionChannel, String[], Map<String, String>) - Method in class com.sshtools.client.DefaultClientChannelFactory
executeCommand(String) - Method in class com.sshtools.client.AbstractSessionChannel
executeCommand(String) - Method in class com.sshtools.client.shell.ExpectShell
executeCommand(String) - Method in class com.sshtools.client.SshClient
executeCommand(String, boolean) - 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, boolean, String) - Method in class com.sshtools.client.shell.ExpectShell
executeCommand(String, long) - Method in class com.sshtools.client.SshClient
executeCommand(String, long, String) - Method in class com.sshtools.client.SshClient
executeCommand(String, String) - Method in class com.sshtools.client.AbstractSessionChannel
executeCommand(String, String) - Method in class com.sshtools.client.shell.ExpectShell
executeCommand(String, String) - Method in class com.sshtools.client.SshClient
executeCommandWithResult(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, long, String) - Method in class com.sshtools.client.SshClient
executeCommandWithResult(String, StringBuffer, String) - Method in class com.sshtools.client.SshClient
executeWithExitCode(String) - Method in class com.sshtools.client.shell.ExpectShell
executeWithOutput(String) - Method in class com.sshtools.client.shell.ExpectShell
exists(String) - Method in class com.sshtools.client.sftp.SftpClient: Determine if a path exists.
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.tasks.AbstractCommandTask: Deprecated, for removal: This API element is subject to removal in a future version.
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, 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.
expect(String, 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(SessionChannelNG, int) - Constructor for class com.sshtools.client.shell.ExpectShell
ExpectShell(SessionChannelNG, ShellStartupTrigger, long, String, int, int, int) - Constructor for class com.sshtools.client.shell.ExpectShell
ExpectShell(AbstractSessionTask<SessionChannelNG>) - Constructor for class com.sshtools.client.shell.ExpectShell
ExpectShell(AbstractSessionTask<SessionChannelNG>, int) - 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: Deprecated.
ExpectShell(AbstractSessionTask<SessionChannelNG>, ShellStartupTrigger, long, String, int, int) - Constructor for class com.sshtools.client.shell.ExpectShell: Deprecated.
ExpectShell(AbstractSessionTask<SessionChannelNG>, ShellStartupTrigger, long, String, int, int, int) - Constructor for class com.sshtools.client.shell.ExpectShell: Deprecated.
ExpectShell(InputStream, OutputStream, ExpectShell) - Constructor for class com.sshtools.client.shell.ExpectShell
ExpectShell(InputStream, OutputStream, ExpectShell, 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

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
FileTransferProgressWrapper(FileTransferProgress, Optional<FileTransferProgress>, AtomicLong) - Constructor for class com.sshtools.client.tasks.AbstractOptimisedTask.FileTransferProgressWrapper
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(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.SftpClient: 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.
fromBinaryModes(byte[]) - Method in class com.sshtools.client.PseudoTerminalModes.PseudoTerminalModesBuilder: Deprecated.

G

get(String) - Method in class com.sshtools.client.scp.ScpClientIO: Gets a remote file as a java.io.InputStream.
get(String) - 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.SftpClientTask: 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, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask: Download the remote file to the local computer
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) - 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.SftpClient: 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, OutputStream) - 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.SftpClientTask: Download the remote file into an OutputStream.
get(String, OutputStream, long) - Method in class com.sshtools.client.sftp.SftpClient: Download the remote file into an OutputStream.
get(String, OutputStream, long) - Method in class com.sshtools.client.sftp.SftpClientTask: Download the remote file into an OutputStream.
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) - 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.SftpClient: 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, String) - 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.SftpClientTask: Download the remote file into the local file.
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) - Method in class com.sshtools.client.sftp.SftpClient: Download the remote file into the local file.
get(String, String, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask: Download the remote file into the local file.
get(String, String, boolean, FileTransferProgress) - Method in class com.sshtools.client.scp.ScpClient
get(String, String, FileTransferProgress) - 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.SftpClientTask: 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, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask: Download the remote file to the local computer.
getAbsolutePath() - Method in class com.sshtools.client.sftp.SftpFile: Get the absolute path
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.
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() - Method in class com.sshtools.client.sftp.SftpFile: Deprecated, for removal: This API element is subject to removal in a future version.
getAttributes() - Method in class com.sshtools.client.sftp.SftpHandle: Get the attributes of a file.
getAttributes() - Method in class com.sshtools.client.tasks.StatTask
getAttributes(SftpFile) - Method in class com.sshtools.client.sftp.SftpChannel: Deprecated, for removal: This API element is subject to removal in a future version.
getAttributes(String) - Method in class com.sshtools.client.sftp.SftpChannel: Get the attributes of a file.
getAttributes(String, int, String) - Method in class com.sshtools.client.sftp.SftpChannel
getAuthenticatingKey() - Method in class com.sshtools.client.ExternalKeyAuthenticator
getAuthenticatingKey() - Method in class com.sshtools.client.IdentityFileAuthenticator
getAuthenticatingKey() - Method in class com.sshtools.client.KeyPairAuthenticator
getAuthenticatingKey() - Method in class com.sshtools.client.PrivateKeyFileAuthenticator
getAuthenticatingKey() - Method in class com.sshtools.client.PublicKeyAuthenticator
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.LocalForwardingChannelFactoryImpl
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: Deprecated.
getCommand() - Method in class com.sshtools.client.tasks.CommandTask
getCommandOutput() - Method in class com.sshtools.client.shell.ShellProcess
getConnection() - Method in class com.sshtools.client.SshClient
getConnection() - Method in class com.sshtools.client.tasks.AbstractSubsystem
getConnectionManager() - Method in class com.sshtools.client.SshClientContext
getContext() - Method in class com.sshtools.client.ConnectionProtocolClient
getContext() - Method in class com.sshtools.client.sftp.SftpChannel
getContext() - Method in class com.sshtools.client.SshClient
getCurrentKey() - Method in class com.sshtools.client.IdentityFileAuthenticator
getCurrentPath() - Method in class com.sshtools.client.IdentityFileAuthenticator
getCurrentWorkingDirectory() - Method in class com.sshtools.client.sftp.SftpClient
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(byte[]) - Method in class com.sshtools.client.sftp.SftpClient
getEOL(byte[]) - Method in class com.sshtools.client.sftp.SftpClientTask
getEOL(String) - Method in class com.sshtools.client.sftp.SftpClient
getEOL(String) - 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: Deprecated.
getExitCode() - Method in class com.sshtools.client.tasks.CommandTask
getExitSignalInfo() - Method in class com.sshtools.client.AbstractSessionChannel
getExtendedReply(SftpMessage, String, UnsignedInteger32) - Method in class com.sshtools.client.sftp.SftpChannel
getExtendedReply(UnsignedInteger32, String) - Method in class com.sshtools.client.sftp.SftpChannel
getExtension(String) - Method in class com.sshtools.client.sftp.SftpChannel: Get the data value of a supported SFTP extension.
getExtensionNegotiationString() - Method in class com.sshtools.client.TransportProtocolClient
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() - Method in class com.sshtools.client.sftp.SftpHandle: Get the file associated with this handle.
getFile(String) - Method in class com.sshtools.client.sftp.SftpChannel: Utility method to obtain an SftpFile instance for a given path.
getFile(String) - Method in class com.sshtools.client.SshClient
getFile(String, int, String, char[], String, File) - Static method in class com.sshtools.client.Ssh
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) - 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.SftpClient: 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.SftpClient: 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.SftpClient: 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.SftpClient: Download the remote files into the local file.
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.SftpClient: 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.SftpClient: Download the remote file to the local computer.
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.SftpHandle: Get the open file handle
getHandle(UnsignedInteger32, SftpFile) - Method in class com.sshtools.client.sftp.SftpChannel
getHandleResponse(SftpMessage, SftpFile, UnsignedInteger32) - 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() - Method in class com.sshtools.client.SshKeyExchangeClient: Get the host key supplied during key exchange.
getHostKey(String, int) - Static method in class com.sshtools.client.SshCompatibilityUtils
getHostKey(String, int, String) - Static method in class com.sshtools.client.SshCompatibilityUtils
getHostKeyVerification() - Method in class com.sshtools.client.SshClientContext
getIdleLog() - Method in class com.sshtools.client.AuthenticationProtocolClient
getIdleTimeoutSeconds() - Method in class com.sshtools.client.AuthenticationProtocolClient
getINodes() - Method in class com.sshtools.client.sftp.StatVfs
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
getInputStream(String) - 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.SftpClientTask: Create an InputStream for reading a remote file.
getInputStream(String, long) - 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.
getKeys() - Method in class com.sshtools.client.components.Curve25519SHA256Client.Curve25519SHA256ClientFactory
getKeys() - Method in class com.sshtools.client.components.Curve25519SHA256LibSshClient.Curve25519SHA256LibSshClientFactory
getKeys() - Method in class com.sshtools.client.components.DiffieHellmanEcdhNistp256.DiffieHellmanEcdhNistp256Factory
getKeys() - Method in class com.sshtools.client.components.DiffieHellmanEcdhNistp384.DiffieHellmanEcdhNistp384Factory
getKeys() - Method in class com.sshtools.client.components.DiffieHellmanEcdhNistp521.DiffieHellmanEcdhNistp521Factory
getKeys() - Method in class com.sshtools.client.components.DiffieHellmanGroup14Sha1JCE.DiffieHellmanGroup14Sha1JCEFactory
getKeys() - Method in class com.sshtools.client.components.DiffieHellmanGroup14Sha256JCE.DiffieHellmanGroup14Sha256JCEFactory
getKeys() - Method in class com.sshtools.client.components.DiffieHellmanGroup15Sha512JCE.DiffieHellmanGroup15Sha512JCEFactory
getKeys() - Method in class com.sshtools.client.components.DiffieHellmanGroup16Sha512JCE.DiffieHellmanGroup16Sha512JCEFactory
getKeys() - Method in class com.sshtools.client.components.DiffieHellmanGroup17Sha512JCE.DiffieHellmanGroup17Sha512JCEFactory
getKeys() - Method in class com.sshtools.client.components.DiffieHellmanGroup18Sha512JCE.DiffieHellmanGroup18Sha512JCEFactory
getKeys() - Method in class com.sshtools.client.components.DiffieHellmanGroup1Sha1JCE.DiffieHellmanGroup1Sha1JCEFactory
getKeys() - Method in class com.sshtools.client.components.DiffieHellmanGroupExchangeSha1JCE.DiffieHellmanGroupExchangeSha1JCEFactory
getKeys() - Method in class com.sshtools.client.components.DiffieHellmanGroupExchangeSha256JCE.DiffieHellmanGroupExchangeSha256JCEFactory
getKeys() - Method in class com.sshtools.client.components.Rsa1024Sha1.Rsa1024Sha1Factory
getKeys() - Method in class com.sshtools.client.components.Rsa2048Sha256.Rsa2048Sha256Factory
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.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
getNextKey() - Method in class com.sshtools.client.ExternalKeyAuthenticator
getNextKey() - Method in class com.sshtools.client.IdentityFileAuthenticator
getNextKey() - Method in class com.sshtools.client.KeyPairAuthenticator
getNextKey() - Method in class com.sshtools.client.PrivateKeyFileAuthenticator
getNextKey() - Method in class com.sshtools.client.PublicKeyAuthenticator
getNumCommandsExecuted() - Method in class com.sshtools.client.shell.ExpectShell
getOKRequestStatus(UnsignedInteger32, String) - Method in class com.sshtools.client.sftp.SftpChannel: Verify that an OK status has been returned for a request id.
getOsDescription() - Method in class com.sshtools.client.shell.ExpectShell
getOsType() - Method in class com.sshtools.client.shell.ExpectShell
getOutputStream() - Method in class com.sshtools.client.shell.ShellProcess
getOutputStream() - Method in class com.sshtools.client.tasks.AsyncSessionTask
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.
getParent() - Method in class com.sshtools.client.sftp.SftpFile: Get the parent of the current file.
getPasshrase(String) - Method in interface com.sshtools.client.PassphrasePrompt
getPassphrase() - Method in class com.sshtools.client.PrivateKeyFileAuthenticator
getPassphrase(String) - Method in class com.sshtools.client.IdentityFileAuthenticator
getPassword() - Method in class com.sshtools.client.PasswordAuthenticator
getPort() - Method in class com.sshtools.client.SshClient
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: Deprecated, for removal: This API element is subject to removal in a future version.
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
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(byte[]) - Method in class com.sshtools.client.sftp.SftpClient: Deprecated.
getRemoteHash(byte[], long, long, byte[]) - Method in class com.sshtools.client.sftp.SftpClient: Deprecated.
getRemoteHash(byte[], long, long, RemoteHash) - Method in class com.sshtools.client.sftp.SftpClient
getRemoteHash(byte[], RemoteHash) - Method in class com.sshtools.client.sftp.SftpClient
getRemoteHash(String) - Method in class com.sshtools.client.sftp.SftpClient: Deprecated.
getRemoteHash(String, long, long, byte[]) - Method in class com.sshtools.client.sftp.SftpClient: Deprecated.
getRemoteHash(String, long, long, RemoteHash) - Method in class com.sshtools.client.sftp.SftpClient
getRemoteHash(String, RemoteHash) - Method in class com.sshtools.client.sftp.SftpClient
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
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.sftp.SftpChannel
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() - Method in class com.sshtools.client.ExternalKeyAuthenticator
getSignatureGenerator() - Method in class com.sshtools.client.PublicKeyAuthenticator
getSingleFileResponse(SftpMessage, String, String, UnsignedInteger32) - 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.LocalForwardingChannelFactoryImpl
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.LocalForwardingChannelFactoryImpl
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
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
GUEST_USERNAME - Static variable in class com.sshtools.client.SshClient

H

handle(byte[]) - Method in class com.sshtools.client.sftp.SftpFile: Create a new handle for this file given the handle data.
hardlink(String, String) - Method in class com.sshtools.client.sftp.SftpClient
hasCredentialsRemaining() - Method in class com.sshtools.client.ExternalKeyAuthenticator
hasCredentialsRemaining() - Method in class com.sshtools.client.IdentityFileAuthenticator
hasCredentialsRemaining() - Method in class com.sshtools.client.KeyPairAuthenticator
hasCredentialsRemaining() - Method in class com.sshtools.client.PrivateKeyFileAuthenticator
hasCredentialsRemaining() - Method in class com.sshtools.client.PublicKeyAuthenticator
hashCode() - Method in class com.sshtools.client.sftp.SftpFile
hashCode() - Method in class com.sshtools.client.sftp.SftpHandle
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: Deprecated.

Canonicalize input lines.
ICRNL - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Map CR to NL on input.
IdentityFileAuthenticator - Class in com.sshtools.client: Implements public key authentication, taking a java.io.File object as the source private key.
IdentityFileAuthenticator(PassphrasePrompt) - Constructor for class com.sshtools.client.IdentityFileAuthenticator
IdentityFileAuthenticator(Collection<Path>, PassphrasePrompt) - Constructor for class com.sshtools.client.IdentityFileAuthenticator
idle() - Method in class com.sshtools.client.AuthenticationProtocolClient
IEXTEN - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Enable extensions.
IGNCR - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Ignore CR on input.
ignoreIntegrity - Variable in class com.sshtools.client.tasks.AbstractOptimisedTask
IGNPAR - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

The ignore parity flag.
IMAXBEL - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

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(SshConnection) - Method in interface com.sshtools.client.KeyboardInteractiveCallback
init(SshConnection) - Method in class com.sshtools.client.PasswordOverKeyboardInteractiveCallback
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.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[], 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
initializeKeyExchange(SshKeyExchange<SshClientContext>, boolean, boolean) - Method in class com.sshtools.client.TransportProtocolClient
INLCR - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Map NL into CR on input.
INPCK - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

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: Deprecated, for removal: This API element is subject to removal in a future version.
isCancelled() - Method in interface com.sshtools.client.ClientAuthenticator
isCancelled() - Method in class com.sshtools.client.SimpleClientAuthenticator
isCancelled() - Method in class com.sshtools.client.tasks.AbstractOptimisedTask.FileTransferProgressWrapper
isCancelled() - Method in interface com.sshtools.client.tasks.FileTransferProgress: The transfer is cancelled.
isCharacter() - Method in class com.sshtools.client.sftp.SftpFile: Deprecated, for removal: This API element is subject to removal in a future version.
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: Deprecated, for removal: This API element is subject to removal in a future version.
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.
isEOF() - Method in class com.sshtools.client.shell.ShellController
isExtensionNegotiationSupported() - Method in class com.sshtools.client.TransportProtocolClient
isFifo() - Method in class com.sshtools.client.sftp.SftpFile: Deprecated, for removal: This API element is subject to removal in a future version.
isFile() - Method in class com.sshtools.client.sftp.SftpFile: Deprecated, for removal: This API element is subject to removal in a future version.
isFlowControlEnabled() - Method in class com.sshtools.client.AbstractSessionChannel
isHandled(String, int, String, int, ConnectionProtocol<SshClientContext>) - Method in class com.sshtools.client.DefaultRemoteForwardRequestHandler
ISIG - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

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.SftpHandle: Determine whether the file is open.
isServerMode() - Method in class com.sshtools.client.TransportProtocolClient
isSingleSession() - Method in class com.sshtools.client.AbstractSessionChannel
isSocket() - Method in class com.sshtools.client.sftp.SftpFile: Deprecated, for removal: This API element is subject to removal in a future version.
ISTRIP - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Strip 8th bit off characters.
IUCLC - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Translate uppercase characters to lowercase.
IUTF8 - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Output is assumed to be UTF-8
IXANY - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Any char will restart after stop.
IXOFF - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Enable input flow control.
IXON - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

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
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: Deprecated, for removal: This API element is subject to removal in a future version.
listChildren(List<SftpFile>) - Method in class com.sshtools.client.sftp.SftpHandle: List the children of a directory.
LocalForwardingChannelFactoryImpl - Class in com.sshtools.client: Implements the configuration of a local forwarding listening socket.
LocalForwardingChannelFactoryImpl(String, int) - Constructor for class com.sshtools.client.LocalForwardingChannelFactoryImpl
LocalForwardingFactoryImpl<C extends SshClientContext> - Class in com.sshtools.client
LocalForwardingFactoryImpl() - Constructor for class com.sshtools.client.LocalForwardingFactoryImpl
lock() - Method in class com.sshtools.client.sftp.SftpHandle: Lock this file.
lock(int) - Method in class com.sshtools.client.sftp.SftpHandle: Lock this file.
lock(long, long, int) - Method in class com.sshtools.client.sftp.SftpHandle: Lock this file or a region of it.
lockFile(byte[], long, long, int) - Method in class com.sshtools.client.sftp.SftpChannel: Deprecated, for removal: This API element is subject to removal in a future version.
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() - 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.SftpClient: List the contents remote directory.
ls(String) - Method in class com.sshtools.client.sftp.SftpClientTask: 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
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.SshClient
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
md5 - Enum constant in enum com.sshtools.client.sftp.RemoteHash
message(String, Object...) - Method in interface com.sshtools.client.tasks.AbstractOptimisedTask.ProgressMessages: Display a message.
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).
MORE_CONTENT_NEEDED - Enum constant in enum com.sshtools.client.shell.ShellMatcher.Continue
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: Deprecated.

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.
NotifiedPrompt - Interface in com.sshtools.client

O

OCRNL - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Translate carriage return to newline (output).
of(PasswordAuthenticator.PasswordPrompt) - Static method in class com.sshtools.client.PasswordAuthenticator
ofRunnable(SshConnection, Task.TaskRunnable<T>) - Static method in class com.sshtools.client.tasks.Task
OLCUC - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Convert lowercase to uppercase.
onBeforeExecute(CommandTask.CommandTaskEvent) - Method in class com.sshtools.client.tasks.CommandTask.CommandTaskBuilder: Set a callback to run before the command is executed.
onBeforeOpen(ShellTask.ShellTaskEvent) - Method in class com.sshtools.client.tasks.ShellTask.ShellTaskBuilder: Set a callback to run before the opening of the shell.
onBeforeTask(CommandTask.CommandTaskEvent) - Method in class com.sshtools.client.tasks.CommandTask.CommandTaskBuilder: Set a callback to run when the command has been executed.
onBeforeTask(ShellTask.ShellTaskEvent) - Method in class com.sshtools.client.tasks.ShellTask.ShellTaskBuilder: Set a callback to run when the command has been executed.
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
onClose(CommandTask.CommandTaskEvent) - Method in class com.sshtools.client.tasks.CommandTask.CommandTaskBuilder: Set a callback to run when the command is closed.
onClose(ShellTask.ShellTaskEvent) - Method in class com.sshtools.client.tasks.ShellTask.ShellTaskBuilder: Set a callback to run when the shell is closed.
onCloseSession(SessionChannelNG) - Method in class com.sshtools.client.tasks.AbstractCommandTask: Deprecated, for removal: This API element is subject to removal in a future version.
onCloseSession(SessionChannelNG) - Method in class com.sshtools.client.tasks.AbstractSubsystem
onCloseSession(SessionChannelNG) - Method in class com.sshtools.client.tasks.AbstractSubsystemTask
onCloseSession(SessionChannelNG) - Method in class com.sshtools.client.tasks.CommandTask: Deprecated, for removal: This API element is subject to removal in a future version.
onCloseSession(SessionChannelNG) - Method in class com.sshtools.client.tasks.ShellTask: Deprecated.
onCloseSession(SessionChannel) - Method in class com.sshtools.client.tasks.AsyncSessionTask
onCloseSession(T) - Method in class com.sshtools.client.tasks.AbstractSessionTask
onConfigure(SshClient.OnConfiguration) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set a Consumer that receives a SshClientContext when the connection is ready for configuration.
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: Deprecated.

Map NL to CR-NL.
onLocalEOF() - Method in class com.sshtools.client.AbstractSessionChannel
ONLRET - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

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: Deprecated.

Translate newline to carriage return-newline (output).
onOpen(ShellTask.ShellTaskEvent) - Method in class com.sshtools.client.tasks.ShellTask.ShellTaskBuilder: Deprecated.
onOpenSession(SessionChannelNG) - Method in class com.sshtools.client.tasks.CommandTask
onOpenSession(SessionChannelNG) - Method in class com.sshtools.client.tasks.ShellTask: Deprecated.
onOpenSession(SessionChannel) - Method in class com.sshtools.client.tasks.AsyncSessionTask
onOpenSession(T) - Method in class com.sshtools.client.tasks.AbstractSessionTask
onRemoteEOF() - Method in class com.sshtools.client.AbstractSessionChannel
onSessionOpen() - Method in class com.sshtools.client.SessionChannelNG
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.PublicKeyAuthenticator
onStop() - Method in class com.sshtools.client.ConnectionProtocolClient
onTask(CommandTask.CommandTaskEvent) - Method in class com.sshtools.client.tasks.CommandTask.CommandTaskBuilder: Set a callback to run when the command has been executed.
onTask(ShellTask.ShellTaskEvent) - Method in class com.sshtools.client.tasks.ShellTask.ShellTaskBuilder: Set a callback to run when the command has been executed.
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) - 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.SftpChannel: Open a file.
openFile(String, int) - Method in class com.sshtools.client.sftp.SftpClient
openFile(String, int) - Method in class com.sshtools.client.sftp.SftpClientTask
openFile(String, int, SftpFileAttributes) - Method in class com.sshtools.client.sftp.SftpChannel: Open a file.
openFileVersion5(String, int, int, SftpFileAttributes) - Method in class com.sshtools.client.sftp.SftpChannel
openRemoteClient(String, int, String) - Method in class com.sshtools.client.SshClient
openSessionChannel() - Method in class com.sshtools.client.SshClient
openSessionChannel(boolean) - Method in class com.sshtools.client.SshClient
openSessionChannel(long) - 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: Deprecated.

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_POWERSHELL - Static variable in class com.sshtools.client.shell.ExpectShell: Linux 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
outstandingRequests - Variable in class com.sshtools.client.tasks.AbstractOptimisedTask

P

PARENB - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Parity enable.
PARMRK - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Mark parity and framing errors.
PARODD - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Odd parity, else even.
parseCommand(String, String[]) - Method in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO: Parse an SCP command
PassphrasePrompt - Interface in com.sshtools.client
PasswordAuthenticator - Class in com.sshtools.client: Implements the password authentication method.
PasswordAuthenticator() - Constructor for class com.sshtools.client.PasswordAuthenticator
PasswordAuthenticator(char[]) - Constructor for class com.sshtools.client.PasswordAuthenticator
PasswordAuthenticator(String) - Constructor for class com.sshtools.client.PasswordAuthenticator
PasswordAuthenticator(Supplier<String>) - Constructor for class com.sshtools.client.PasswordAuthenticator: Deprecated.
PasswordAuthenticator.PasswordPrompt - Interface in com.sshtools.client
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: Deprecated.

Retype pending input.
performOptimizedRead(long, int, OutputStream, int, FileTransferProgress, long) - Method in class com.sshtools.client.sftp.SftpHandle: Performs an optimized read of a file through use of asynchronous messages.
performOptimizedRead(String, byte[], long, int, OutputStream, int, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpChannel: Deprecated, for removal: This API element is subject to removal in a future version.
performOptimizedRead(String, byte[], long, int, OutputStream, int, FileTransferProgress, long) - Method in class com.sshtools.client.sftp.SftpChannel: Deprecated, for removal: This API element is subject to removal in a future version.
performOptimizedRead(String, long, int, OutputStream, int, FileTransferProgress, long) - Method in class com.sshtools.client.sftp.SftpHandle: Deprecated, for removal: This API element is subject to removal in a future version.
performOptimizedWrite(String, byte[], int, int, InputStream, int, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpChannel: Deprecated.
performOptimizedWrite(String, byte[], int, int, InputStream, int, FileTransferProgress, long) - Method in class com.sshtools.client.sftp.SftpChannel: Deprecated, for removal: This API element is subject to removal in a future version.
performOptimizedWrite(String, int, int, InputStream, int, FileTransferProgress, long) - Method in class com.sshtools.client.sftp.SftpHandle: 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: Deprecated, for removal: This API element is subject to removal in a future version.
performSynchronousRead(int, OutputStream, FileTransferProgress, long) - Method in class com.sshtools.client.sftp.SftpHandle: 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: Deprecated, for removal: This API element is subject to removal in a future version.
postReadRequest(long, int) - Method in class com.sshtools.client.sftp.SftpHandle: Post a read request to the server and return the request id; this is used to optimize file downloads.
postVisitDirectory(SftpFile, IOException) - Method in interface com.sshtools.client.sftp.SftpFileVisitor
postWriteRequest(byte[], long, byte[], int, int) - Method in class com.sshtools.client.sftp.SftpChannel: Deprecated, for removal: This API element is subject to removal in a future version.
postWriteRequest(long, byte[], int, int) - Method in class com.sshtools.client.sftp.SftpHandle: Send a write request for an open file but do not wait for the response from the server.
preVisitDirectory(SftpFile, BasicFileAttributes) - Method in interface com.sshtools.client.sftp.SftpFileVisitor
primarySftpClient - Variable in class com.sshtools.client.tasks.AbstractOptimisedTask
printChunkMessages(long) - Method in class com.sshtools.client.tasks.AbstractOptimisedTask
PrivateKeyFileAuthenticator - Class in com.sshtools.client: Implements public key authentication, taking a java.io.File object as the source private key.
PrivateKeyFileAuthenticator(File) - Constructor for class com.sshtools.client.PrivateKeyFileAuthenticator
PrivateKeyFileAuthenticator(File, PassphrasePrompt) - Constructor for class com.sshtools.client.PrivateKeyFileAuthenticator
PrivateKeyFileAuthenticator(File, String) - Constructor for class com.sshtools.client.PrivateKeyFileAuthenticator
PrivateKeyFileAuthenticator(Path) - Constructor for class com.sshtools.client.PrivateKeyFileAuthenticator
PrivateKeyFileAuthenticator(Path, PassphrasePrompt) - Constructor for class com.sshtools.client.PrivateKeyFileAuthenticator
PrivateKeyFileAuthenticator(Path, String) - Constructor for class com.sshtools.client.PrivateKeyFileAuthenticator
processCheckFileResponse(SftpMessage, RemoteHash) - Method in class com.sshtools.client.sftp.SftpClient
processMessage(byte[]) - Method in class com.sshtools.client.AuthenticationProtocolClient
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(byte[]) - Method in class com.sshtools.client.SshKeyExchangeClient: Process a key exchange message
processMessage(ByteArrayReader) - Method in interface com.sshtools.client.ClientAuthenticator: Process an authentication message.
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
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
progress - Variable in class com.sshtools.client.tasks.AbstractFileTask
progressed(long) - Method in class com.sshtools.client.tasks.AbstractOptimisedTask.FileTransferProgressWrapper
progressed(long) - Method in interface com.sshtools.client.tasks.FileTransferProgress: The transfer has progressed
progressMessages - Variable in class com.sshtools.client.tasks.AbstractOptimisedTask
PseudoTerminalModes - Class in com.sshtools.client: Deprecated, for removal: This API element is subject to removal in a future version.
PseudoTerminalModes() - Constructor for class com.sshtools.client.PseudoTerminalModes: Deprecated, for removal: This API element is subject to removal in a future version.
PseudoTerminalModes(byte[]) - Constructor for class com.sshtools.client.PseudoTerminalModes: Deprecated, for removal: This API element is subject to removal in a future version.
PseudoTerminalModes.PseudoTerminalModesBuilder - Class in com.sshtools.client: Deprecated.

Builds PseudoTerminalModes.
PseudoTerminalModesBuilder() - Constructor for class com.sshtools.client.PseudoTerminalModes.PseudoTerminalModesBuilder: Deprecated.
PublicKeyAcceptable - Interface in com.sshtools.client
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
PullTask - Class in com.sshtools.client.tasks: An SFTP Task that downloads complete paths in multiple chunks concurrently.
PullTask.PullTaskBuilder - Class in com.sshtools.client.tasks: Builder for PullTask.
PushTask - Class in com.sshtools.client.tasks: An SFTP Task that uploads complete paths in multiple chunks concurrently.
PushTask.PushTaskBuilder - Class in com.sshtools.client.tasks: Builder for PushTask.
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, boolean, FileTransferProgress) - Method in class com.sshtools.client.scp.ScpClientIO
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, String) - 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.SftpClientTask: Upload the contents of an InputStream to the remote computer.
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, long) - Method in class com.sshtools.client.sftp.SftpClientTask: Upload the contents of an InputStream 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) - 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.SftpClient: Deprecated.
put(InputStream, String, FileTransferProgress, long) - Method in class com.sshtools.client.sftp.SftpClientTask: Deprecated.
put(InputStream, String, FileTransferProgress, long, long) - 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, long) - Method in class com.sshtools.client.sftp.SftpClientTask
put(String) - Method in class com.sshtools.client.sftp.SftpClient: 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[], 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(String, boolean) - 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.SftpClientTask: 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, FileTransferProgress) - Method in class com.sshtools.client.sftp.SftpClientTask: Upload a file to the remote computer.
put(String, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClient: Upload a file 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, String) - 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.SftpClientTask: Upload a file to the remote computer
put(String, String, boolean) - Method in class com.sshtools.client.scp.ScpClient: Uploads a local file onto the remote server.
put(String, String, 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.SftpClientTask: Upload a file to the remote computer
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, FileTransferProgress, boolean) - Method in class com.sshtools.client.scp.ScpClient
put(String, String, FileTransferProgress) - 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.SftpClientTask: 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, FileTransferProgress, boolean) - Method in class com.sshtools.client.sftp.SftpClientTask: Upload a file to the remote computer.
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
putFile(String, int, String, char[], File, String) - Static method in class com.sshtools.client.Ssh
putFile(String, String, boolean, FileTransferProgress, boolean) - Method in class com.sshtools.client.scp.ScpClient: Deprecated.
Use put method instead.
putFiles(String) - Method in class com.sshtools.client.sftp.SftpClient: Upload the contents of an InputStream to the remote computer.
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.SftpClient: Upload files 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.SftpClient: 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.SftpClient: 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.SftpClient: 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.SftpClient: 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.SftpClient: 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.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, 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() - Method in class com.sshtools.client.ChunkInputStream
read() - Method in class com.sshtools.client.sftp.SftpFileInputStream
read(byte[], int, int) - Method in class com.sshtools.client.ChunkInputStream
read(byte[], int, int) - Method in class com.sshtools.client.sftp.SftpFileInputStream
read(long, byte[], int, int) - Method in class com.sshtools.client.sftp.SftpHandle: Read bytes directly from this file.
readCompleteFile(OutputStream, long, FileTransferProgress) - Method in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
readDirectory(SftpHandle) - Method in class com.sshtools.client.sftp.SftpClient
readDirectory(SftpHandle) - Method in class com.sshtools.client.sftp.SftpClientTask
readFile(byte[], UnsignedInteger64, byte[], int, int) - Method in class com.sshtools.client.sftp.SftpChannel: Deprecated, for removal: This API element is subject to removal in a future version.
readFile(UnsignedInteger64, byte[], int, int) - Method in class com.sshtools.client.sftp.SftpHandle: 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() - Method in interface com.sshtools.client.shell.ShellReader: Read a line of output from the process.
readLine(long) - Method in class com.sshtools.client.shell.ShellController
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.
refresh() - Method in class com.sshtools.client.sftp.SftpFile: Refresh the SftpFileAttributes from the the remote file.
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.
relativeSymlink(String, String) - Method in class com.sshtools.client.sftp.SftpClient: Create a symbolic link on the remote computer.
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
RemoteHash - Enum in com.sshtools.client.sftp
removeCustomRoot(String) - Method in class com.sshtools.client.sftp.SftpClient: Deprecated, for removal: This API element is subject to removal in a future version.
removeCustomRoot(String) - Method in class com.sshtools.client.sftp.SftpClientTask: Deprecated, for removal: This API element is subject to removal in a future version.
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) - 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.
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.
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.PseudoTerminalModesBuilder: Deprecated.

Clear all modes set in this builder.
reset() - Method in class com.sshtools.client.PseudoTerminalModes: Deprecated, for removal: This API element is subject to removal in a future version.
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) - 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.SftpClient: Remove a file or directory on the remote computer with options to force deletion of existing files and recursion.
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.
rmdir(String) - Method in class com.sshtools.client.sftp.SftpClient: Remove a directory, will fail if the directory has contents.
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".
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.
Rsa1024Sha1.Rsa1024Sha1Factory - Class in com.sshtools.client.components
Rsa1024Sha1Factory() - Constructor for class com.sshtools.client.components.Rsa1024Sha1.Rsa1024Sha1Factory
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.
Rsa2048Sha256.Rsa2048Sha256Factory - Class in com.sshtools.client.components
Rsa2048Sha256Factory() - Constructor for class com.sshtools.client.components.Rsa2048Sha256.Rsa2048Sha256Factory
run() - Method in class com.sshtools.client.tasks.AsyncSessionTask
run(T) - Method in interface com.sshtools.client.tasks.Task.TaskRunnable
runTask(T) - Method in class com.sshtools.client.SshClient
runTask(T, long) - 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(AbstractFileFactory<?>, 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.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(int, UnsignedInteger32, UnsignedInteger32, UnsignedInteger32) - Constructor for class com.sshtools.client.SessionChannelNG
SessionChannelNG(int, UnsignedInteger32, UnsignedInteger32, UnsignedInteger32, boolean) - Constructor for class com.sshtools.client.SessionChannelNG
SessionChannelNG(int, UnsignedInteger32, UnsignedInteger32, UnsignedInteger32, ChannelRequestFuture, boolean) - Constructor for class com.sshtools.client.SessionChannelNG
SessionChannelNG(SshConnection) - Constructor for class com.sshtools.client.SessionChannelNG
SessionChannelNG(SshConnection, boolean) - Constructor for class com.sshtools.client.SessionChannelNG
setActiveService(Service) - Method in class com.sshtools.client.TransportProtocolClient
setAttributes(byte[], SftpFileAttributes) - Method in class com.sshtools.client.sftp.SftpChannel: Deprecated, for removal: This API element is subject to removal in a future version.
setAttributes(SftpFile, SftpFileAttributes) - Method in class com.sshtools.client.sftp.SftpChannel: Deprecated, for removal: This API element is subject to removal in a future version.
setAttributes(SftpFileAttributes) - Method in class com.sshtools.client.sftp.SftpHandle: Sets the attributes of a file.
setAttributes(String, SftpFileAttributes) - Method in class com.sshtools.client.sftp.SftpChannel: Sets the attributes of a file.
setAttributes(String, SftpFileAttributes) - Method in class com.sshtools.client.sftp.SftpClient: Set the attributes of a remote path.
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: Deprecated, for removal: This API element is subject to removal in a future version.
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
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: Deprecated, for removal: This API element is subject to removal in a future version.
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: Deprecated, for removal: This API element is subject to removal in a future version.
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
setSingleSession(boolean) - Method in class com.sshtools.client.AbstractSessionChannel
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, boolean) - Method in class com.sshtools.client.PseudoTerminalModes: Deprecated, for removal: This API element is subject to removal in a future version.
setTerminalMode(int, int) - Method in class com.sshtools.client.PseudoTerminalModes: Deprecated, for removal: This API element is subject to removal in a future version.
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: Deprecated.
setupSession(SessionChannel) - Method in class com.sshtools.client.tasks.AsyncSessionTask
setupSession(T) - Method in class com.sshtools.client.tasks.AbstractSessionTask
setupSession(T) - Method in class com.sshtools.client.tasks.AbstractShellTask
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(SshClient) - Constructor for class com.sshtools.client.sftp.SftpClient: Deprecated, for removal: This API element is subject to removal in a future version.
SftpClient(SshClient, AbstractFileFactory<?>) - Constructor for class com.sshtools.client.sftp.SftpClient: Deprecated, for removal: This API element is subject to removal in a future version.
SftpClient(SshConnection) - Constructor for class com.sshtools.client.sftp.SftpClient: Deprecated, for removal: This API element is subject to removal in a future version.
SftpClient(SshConnection, AbstractFileFactory<?>) - Constructor for class com.sshtools.client.sftp.SftpClient: Deprecated, for removal: This API element is subject to removal in a future version.
SftpClient.SftpClientBuilder - Class in com.sshtools.client.sftp
SftpClientBuilder() - Constructor for class com.sshtools.client.sftp.SftpClient.SftpClientBuilder
SftpClientTask - Class in com.sshtools.client.sftp: A task that implements an SFTP client.
SftpClientTask(SshClient) - Constructor for class com.sshtools.client.sftp.SftpClientTask
SftpClientTask(SshConnection) - Constructor for class com.sshtools.client.sftp.SftpClientTask: Deprecated, for removal: This API element is subject to removal in a future version.
SftpClientTask(SshConnection, Task.TaskRunnable<SftpClientTask>) - Constructor for class com.sshtools.client.sftp.SftpClientTask
SftpFile - Class in com.sshtools.client.sftp: Represents an SFTP file 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: Deprecated, for removal: This API element is subject to removal in a future version.
SftpFileInputStream(SftpFile, long) - Constructor for class com.sshtools.client.sftp.SftpFileInputStream: Deprecated, for removal: This API element is subject to removal in a future version.
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: Deprecated, for removal: This API element is subject to removal in a future version.
SftpFileVisitor - Interface in com.sshtools.client.sftp: FileVisitor for use with SftpFile.
SftpHandle - Class in com.sshtools.client.sftp
SftpMessage - Class in com.sshtools.client.sftp
sha1 - Enum constant in enum com.sshtools.client.sftp.RemoteHash
sha256 - Enum constant in enum com.sshtools.client.sftp.RemoteHash
sha512 - Enum constant in enum com.sshtools.client.sftp.RemoteHash
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
shellEvent(ShellTask, SessionChannelNG) - Method in interface com.sshtools.client.tasks.ShellTask.ShellTaskEvent: Shell event occurred.
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: A Task that starts a remote shell with an allocated PTY.
ShellTask(SshClient) - Constructor for class com.sshtools.client.tasks.ShellTask: Deprecated.
ShellTask(SshConnection) - Constructor for class com.sshtools.client.tasks.ShellTask: Deprecated.
ShellTask.ShellTaskBuilder - Class in com.sshtools.client.tasks: Builder for ShellTask.
ShellTask.ShellTaskEvent - Interface in com.sshtools.client.tasks: Functional interface for tasks run on certain shell events.
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(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.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(SshConnection) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(SshConnection, boolean) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, int, String, char[]) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, int, String, char[], SshClientContext) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, int, String, char[], SshKeyPair...) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, int, String, long, char[]) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, int, String, long, char[], SshKeyPair...) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, int, String, long, SshKeyPair...) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, int, String, long, File) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, int, String, long, File, String) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, int, String, SshClientContext, long, char[], SshKeyPair...) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, int, String, SshClientContext, long, SshKeyPair...) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, int, String, SshClientContext, SshKeyPair...) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, int, String, SshKeyPair...) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, int, String, File) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, int, String, File, String) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, Integer, String) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, Integer, String, char[], File, String) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, Integer, String, long) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, Integer, String, long, char[], File, String) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, Integer, String, SshClientContext) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String, Integer, String, SshClientContext, long) - Constructor for class com.sshtools.client.SshClient: Deprecated, for removal: This API element is subject to removal in a future version.
SshClient.OnConfiguration - Interface in com.sshtools.client
SshClient.PreConnectedSshClientBuilder - Class in com.sshtools.client
SshClient.SshClientBuilder - Class in com.sshtools.client
SshClientContext - Class in com.sshtools.client: Holds the configuration for an SSH connection.
SshClientContext() - Constructor for class com.sshtools.client.SshClientContext
SshClientContext(SecurityLevel) - Constructor for class com.sshtools.client.SshClientContext
SshClientContext(SshEngine) - Constructor for class com.sshtools.client.SshClientContext
SshClientContext(SshEngine, ComponentManager, SecurityLevel) - Constructor for class com.sshtools.client.SshClientContext
SshClientContext(SshEngine, 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
SshKeyExchangeClientFactory<T extends SshKeyExchangeClient> - Interface in com.sshtools.client
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 class com.sshtools.client.tasks.AbstractOptimisedTask.FileTransferProgressWrapper
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
startLocalForwarding(String, String) - Method in class com.sshtools.client.SshClient
startRemoteForward(String, int, String, int, ConnectionProtocol<SshClientContext>) - Method in class com.sshtools.client.DefaultRemoteForwardRequestHandler
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
startRemoteForwarding(String, String) - 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: An SFTP Task that uploads complete files.
StatTask(Connection<SshClientContext>, String) - Constructor for class com.sshtools.client.tasks.StatTask: Deprecated, for removal: This API element is subject to removal in a future version.
StatTask.StatTaskBuilder - Class in com.sshtools.client.tasks: Builder for 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() - Method in class com.sshtools.client.SshClient
stopLocalForwarding(String) - Method in class com.sshtools.client.ConnectionProtocolClient
stopLocalForwarding(String, int) - Method in class com.sshtools.client.ConnectionProtocolClient
stopLocalForwarding(String, int) - Method in class com.sshtools.client.SshClient
stopRemoteForward(String, int, String, int, ConnectionProtocol<SshClientContext>) - Method in class com.sshtools.client.DefaultRemoteForwardRequestHandler
stopRemoteForwarding() - Method in class com.sshtools.client.ConnectionProtocolClient
stopRemoteForwarding() - Method in class com.sshtools.client.SshClient
stopRemoteForwarding(String, int) - Method in class com.sshtools.client.ConnectionProtocolClient
stopRemoteForwarding(String, int) - Method in class com.sshtools.client.SshClient
su(String) - Method in class com.sshtools.client.shell.ExpectShell
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, 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() - Method in class com.sshtools.client.SimpleClientAuthenticator
success(boolean, String[]) - Method in interface com.sshtools.client.ClientAuthenticator
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(SshClient) - Constructor for class com.sshtools.client.tasks.Task
Task(SshConnection) - Constructor for class com.sshtools.client.tasks.Task
Task.TaskRunnable<T> - Interface in com.sshtools.client.tasks
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(SshKeyExchangeClientFactory<? extends SshKeyExchangeClient>) - 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: Deprecated.

Returns the encoded modes for use by the SshSession.
TOSTOP - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

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.
transferFiles(String) - Method in class com.sshtools.client.tasks.PushTask
transferFiles(Path) - Method in class com.sshtools.client.tasks.PullTask
transferFiles(TARGET) - Method in class com.sshtools.client.tasks.AbstractOptimisedTask
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: Deprecated.

Specifies the input baud rate in bits per second.
TTY_OP_OSPEED - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

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(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.SftpClient: Sets the umask for 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: Deprecated, for removal: This API element is subject to removal in a future version.
UploadFileContentTask - Class in com.sshtools.client.tasks: An SFTP Task that uploads string content to a remote file.
UploadFileContentTask(SshClient, String, String, String) - Constructor for class com.sshtools.client.tasks.UploadFileContentTask: Deprecated, for removal: This API element is subject to removal in a future version.
UploadFileContentTask(Connection<SshClientContext>, String, String, String) - Constructor for class com.sshtools.client.tasks.UploadFileContentTask: Deprecated, for removal: This API element is subject to removal in a future version.
UploadFileContentTask.UploadFileContentTaskBuilder - Class in com.sshtools.client.tasks: Builder for UploadFileContentTask.
UploadFileTask - Class in com.sshtools.client.tasks: An SFTP Task that uploads complete files.
UploadFileTask(Connection<SshClientContext>, File) - Constructor for class com.sshtools.client.tasks.UploadFileTask: Deprecated, for removal: This API element is subject to removal in a future version.
UploadFileTask(Connection<SshClientContext>, File, String) - Constructor for class com.sshtools.client.tasks.UploadFileTask: Deprecated, for removal: This API element is subject to removal in a future version.
UploadFileTask.UploadFileTaskBuilder - Class in com.sshtools.client.tasks: Builder for UploadFileTask.
UploadInputStreamTask - Class in com.sshtools.client.tasks: An SFTP Task that uploads complete files from an InputStream.
UploadInputStreamTask(SshClient, InputStream, String) - Constructor for class com.sshtools.client.tasks.UploadInputStreamTask: Deprecated, for removal: This API element is subject to removal in a future version.
UploadInputStreamTask.UploadInputStreamTaskBuilder - Class in com.sshtools.client.tasks: Builder for UploadInputStreamTask.
useFirstPacket - Variable in class com.sshtools.client.SshKeyExchangeClient

V

valueOf(String) - Static method in enum com.sshtools.client.sftp.RemoteHash: 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.sftp.RemoteHash: 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: Deprecated.

Toggles the flushing of terminal output.
VDSUSP - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Another suspend character.
VEOF - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

End-of-file character (sends EOF from the terminal).
VEOL - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

End-of-line character in addition to carriage return and/or linefeed.
VEOL2 - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Additional end-of-line character.
VERASE - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Erase the character to left of the cursor.
verboseMessage(String, Object...) - Method in class com.sshtools.client.tasks.AbstractOptimisedTask
verboseOutput - Variable in class com.sshtools.client.tasks.AbstractOptimisedTask
verifyFiles(String, String) - 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.SftpClient: 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.
verifyFiles(String, String, long, long, RemoteHash) - Method in class com.sshtools.client.sftp.SftpClient
verifyFiles(String, String, RemoteHash) - Method in class com.sshtools.client.sftp.SftpClient
verifyIntegrity - Variable in class com.sshtools.client.tasks.AbstractOptimisedTask
verifyIntegrity(Path, String) - Method in class com.sshtools.client.tasks.AbstractOptimisedTask
VFLUSH - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Character to flush output.
VINTR - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Interrupt character; 255 if none.
visit(String, FileVisitor<SftpFile>) - Method in class com.sshtools.client.sftp.SftpClient
visitFileFailed(SftpFile, IOException) - Method in interface com.sshtools.client.sftp.SftpFileVisitor
VKILL - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Kill the current input line.
VLNEXT - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Enter the next character typed literally, even if it is a special character
VQUIT - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

The quit character (sends SIGQUIT signal on POSIX systems).
VREPRINT - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Reprints the current input line.
VSTART - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Continues paused output (normally control-Q).
VSTATUS - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Prints system status line (load, command, pid, etc).
VSTOP - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Pauses output (normally control-S).
VSUSP - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Suspends the current program.
VSWITCH - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Switch to a different shell layer.
VWERASE - Static variable in class com.sshtools.client.PseudoTerminalModes: Deprecated.

Erases a word left of cursor.

W

waitForResponse() - Method in class com.sshtools.client.scp.ScpClientIO.ScpEngineIO
withAbstractFiles(AbstractFile...) - Method in class com.sshtools.client.tasks.PushTask.PushTaskBuilder: Set an array of files to transfer.
withAbstractFiles(Collection<AbstractFile>) - Method in class com.sshtools.client.tasks.PushTask.PushTaskBuilder: Set a collection of file paths to transfer.
withAsyncRequests(int) - Method in class com.sshtools.client.sftp.SftpClient.SftpClientBuilder: Set the maximum number of asynchronous requests to use for optimised reads and writes to remote files.
withAsyncRequests(int) - Method in class com.sshtools.client.tasks.AbstractOptimisedTask.AbstractOptimisedTaskBuilder: The number of SFTP messages to send asynchronously before checking for server responses.
withAuthenticators(ClientAuthenticator...) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set the list of one or more ClientAuthenticator instances that will be presented to the server one at a time.
withAuthenticators(Collection<ClientAuthenticator>) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set the list of one or more ClientAuthenticator instances that will be presented to the server one at a time.
withAutoConsume() - Method in class com.sshtools.client.tasks.CommandTask.CommandTaskBuilder: Set to auto-consume input.
withAutoConsume() - Method in class com.sshtools.client.tasks.ShellTask.ShellTaskBuilder: Set to auto-consume input.
withAutoConsume(boolean) - Method in class com.sshtools.client.tasks.CommandTask.CommandTaskBuilder: Set the whether to auto-consume input.
withAutoConsume(boolean) - Method in class com.sshtools.client.tasks.ShellTask.ShellTaskBuilder: Set the whether to auto-consume input.
withBlocksize(int) - Method in class com.sshtools.client.tasks.AbstractOptimisedTask.AbstractOptimisedTaskBuilder: The SFTP block size to use in SFTP operations.
withBlockSize(int) - Method in class com.sshtools.client.sftp.SftpClient.SftpClientBuilder: Sets the block size used when transferring files, defaults to the optimized setting of 32768.
withBufferSize(int) - Method in class com.sshtools.client.sftp.SftpClient.SftpClientBuilder: Set the size of the buffer which is used to read from the local file system.
withBufferSize(int) - Method in class com.sshtools.client.tasks.AbstractOptimisedTask.AbstractOptimisedTaskBuilder: The size of the buffer used to pre-read the file during upload.
withChunkProgress(Function<LOCALFILE, FileTransferProgress>) - Method in class com.sshtools.client.tasks.AbstractOptimisedTask.AbstractOptimisedTaskBuilder: Set a Function that can create FileTransferProgress instances given a AbstractFile.
withChunks(int) - Method in class com.sshtools.client.tasks.AbstractOptimisedTask.AbstractOptimisedTaskBuilder: Set how many chunks to split any paths into for transfer.
withClient(SshClient) - Method in class com.sshtools.client.sftp.SftpClient.SftpClientBuilder: Use an existing SshClient to create the SftpClient.
withClient(SshClient) - Method in class com.sshtools.client.tasks.AbstractConnectionTask.AbstractConnectionTaskBuilder: Set a single SshClient to use.
withClients(Function<Integer, SshClient>) - Method in class com.sshtools.client.tasks.AbstractConnectionTask.AbstractConnectionTaskBuilder: Set a Function that supplies SshClient instances.
withColumns(int) - Method in class com.sshtools.client.tasks.CommandTask.CommandTaskBuilder: Set the terminal width in columns to use when allocating a PTY.
withColumns(int) - Method in class com.sshtools.client.tasks.ShellTask.ShellTaskBuilder: Set the terminal width in columns to use when allocating a PTY.
withCommand(String) - Method in class com.sshtools.client.tasks.CommandTask.CommandTaskBuilder: Set the command to run.
withConnection(SshConnection) - Method in class com.sshtools.client.sftp.SftpClient.SftpClientBuilder: Use an existing SshConnection to create the SftpClient.
withConnection(SshConnection) - Method in class com.sshtools.client.tasks.AbstractConnectionTask.AbstractConnectionTaskBuilder: Set a single Connection to use.
withConnectTimeout(long) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set the connection timeout in milliseconds.
withConnectTimeout(Duration) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set the connection timeout.
withContent(Object) - Method in class com.sshtools.client.tasks.UploadFileContentTask.UploadFileContentTaskBuilder: Set the Object to upload.
withCurrentUsername(String) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set the username to use for authentication as currently local in local user, what is returned by System.getProperty("user.name");.
withCustomRoots(String...) - Method in class com.sshtools.client.sftp.SftpClient.SftpClientBuilder: Adds one or more custom file system root paths.
withDigest(RemoteHash) - Method in class com.sshtools.client.tasks.AbstractOptimisedTask.AbstractOptimisedTaskBuilder: The message digest algorithm to use for integrity checks (see AbstractOptimisedTask.AbstractOptimisedTaskBuilder.withVerifyIntegrity()).
withEncoding(String) - Method in class com.sshtools.client.tasks.CommandTask.CommandTaskBuilder: Set the character encoding to use for transferring string content.
withEncoding(String) - Method in class com.sshtools.client.tasks.UploadFileContentTask.UploadFileContentTaskBuilder: Set the character encoding to use for transferring the string content.
withEncoding(Charset) - Method in class com.sshtools.client.tasks.CommandTask.CommandTaskBuilder: Set the character encoding to use for transferring string content.
withEncoding(Charset) - Method in class com.sshtools.client.tasks.UploadFileContentTask.UploadFileContentTaskBuilder: Set the character encoding to use for transferring the string content.
withFileFactory(AbstractFileFactory<?>) - Method in class com.sshtools.client.sftp.SftpClient.SftpClientBuilder: Use a specific AbstractFileFactory for this client.
withFilePaths(Collection<String>) - Method in class com.sshtools.client.tasks.PushTask.PushTaskBuilder: Set a collection of file paths to transfer.
withFiles(File...) - Method in class com.sshtools.client.tasks.PushTask.PushTaskBuilder: Set an array of files to transfer.
withFilesPaths(String...) - Method in class com.sshtools.client.tasks.PushTask.PushTaskBuilder: Set an array of files to transfer.
withFuture(ChannelRequestFuture) - Method in class com.sshtools.client.tasks.AbstractSessionTask.AbstractSessionTaskBuilder: Set a custom ChannelRequestFuture.
withHost(InetAddress) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set the host to use.
withHostname(String) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set the hostname to use.
withIdentities(SshKeyPair...) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set one more identities (key pairs) to use for authentication.
withIdentities(Collection<SshKeyPair>) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Add a key pair to use for authentication.
withIgnoreIntegrity() - Method in class com.sshtools.client.tasks.AbstractOptimisedTask.AbstractOptimisedTaskBuilder: Only warn about integrity checks, do not fail entirely.
withIgnoreIntegrity(boolean) - Method in class com.sshtools.client.tasks.AbstractOptimisedTask.AbstractOptimisedTaskBuilder: Only warn about integrity checks, do not fail entirely.
withInputStream(InputStream) - Method in class com.sshtools.client.tasks.UploadInputStreamTask.UploadInputStreamTaskBuilder: Set the InputStream to upload.
withIntegrityVerification(boolean) - Method in class com.sshtools.client.tasks.AbstractOptimisedTask.AbstractOptimisedTaskBuilder: Set whether to verify the integrity of any paths transferred using the configured digest (see AbstractOptimisedTask.AbstractOptimisedTaskBuilder.withDigest(RemoteHash).
withLength(long) - Method in class com.sshtools.client.tasks.UploadInputStreamTask.UploadInputStreamTaskBuilder: Set the length of content that will be uploaded (if known).
withLocal(Path) - Method in class com.sshtools.client.tasks.DownloadFileTask.DownloadFileTaskBuilder: Set the local local to download to.
withLocal(Path) - Method in class com.sshtools.client.tasks.UploadFileTask.UploadFileTaskBuilder: Set the local file to upload.
withLocal(Optional<Path>) - Method in class com.sshtools.client.tasks.DownloadFileTask.DownloadFileTaskBuilder: Set the local local to download to.
withLocalFile(File) - Method in class com.sshtools.client.tasks.DownloadFileTask.DownloadFileTaskBuilder: Set the local local to download to.
withLocalFile(File) - Method in class com.sshtools.client.tasks.UploadFileTask.UploadFileTaskBuilder: Set the local file to upload.
withLocalFile(Optional<File>) - Method in class com.sshtools.client.tasks.DownloadFileTask.DownloadFileTaskBuilder: Set the local local to download to.
withLocalFolder(String) - Method in class com.sshtools.client.tasks.PullTask.PullTaskBuilder: Set the local folder where any transferred paths will be placed.
withLocalFolder(Path) - Method in class com.sshtools.client.tasks.PullTask.PullTaskBuilder: Set the remote folder where any transferred paths will be placed.
withLocalFolder(Optional<Path>) - Method in class com.sshtools.client.tasks.PullTask.PullTaskBuilder: Set the remote folder where any transferred paths will be placed.
withLocalHome(File) - Method in class com.sshtools.client.sftp.SftpClient.SftpClientBuilder: Use a specific Path as the home of the local file system.
withLocalHome(Path) - Method in class com.sshtools.client.sftp.SftpClient.SftpClientBuilder: Use a specific Path as the home of the local file system.
withLocalHomeSandbox(boolean) - Method in class com.sshtools.client.sftp.SftpClient.SftpClientBuilder: Whether or not to sandbox the path provided as the Local Home/code>.
withLocalPath(String) - Method in class com.sshtools.client.sftp.SftpClient.SftpClientBuilder: Start off in a specified local path.
withMode(int) - Method in class com.sshtools.client.PseudoTerminalModes.PseudoTerminalModesBuilder: Deprecated.

Set a boolean>code> mode to true.
withMode(int, boolean) - Method in class com.sshtools.client.PseudoTerminalModes.PseudoTerminalModesBuilder: Deprecated.

Set a boolean mode.
withMode(int, int) - Method in class com.sshtools.client.PseudoTerminalModes.PseudoTerminalModesBuilder: Deprecated.

Set an integer mode.
withModes(PseudoTerminalModes) - Method in class com.sshtools.client.tasks.CommandTask.CommandTaskBuilder: Set the terminal modes to use when allocating a PTY.
withModes(PseudoTerminalModes) - Method in class com.sshtools.client.tasks.ShellTask.ShellTaskBuilder: Deprecated, for removal: This API element is subject to removal in a future version.
withModes(TerminalModes) - Method in class com.sshtools.client.tasks.ShellTask.ShellTaskBuilder: Set the terminal modes to use when allocating a PTY.
withoutCloseOnDisconnect() - Method in class com.sshtools.client.SshClient.PreConnectedSshClientBuilder: Set whether to close the SshConnection when this client disconnects.
withoutMode(int) - Method in class com.sshtools.client.PseudoTerminalModes.PseudoTerminalModesBuilder: Deprecated.

Set a boolean>code> mode to false.
withoutPty() - Method in class com.sshtools.client.tasks.CommandTask.CommandTaskBuilder: Do not to allocate a Pty.
withoutPty() - Method in class com.sshtools.client.tasks.ShellTask.ShellTaskBuilder: Do not to allocate a Pty.
withOutputStream(OutputStream) - Method in class com.sshtools.client.tasks.DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder: Set the output stream to download to.
withOutputStream(Optional<OutputStream>) - Method in class com.sshtools.client.tasks.DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder: Set the output stream to download to.
withPassword(char[]) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set the password to use for authentication.
withPassword(String) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set the password to use for authentication.
withPassword(Optional<String>) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set the password to use for authentication.
withPasswordPrompt(PasswordAuthenticator.PasswordPrompt) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set the password prompt to use for authentication.
withPaths(String...) - Method in class com.sshtools.client.tasks.PullTask.PullTaskBuilder: Set an array of files to transfer.
withPaths(Path...) - Method in class com.sshtools.client.tasks.PushTask.PushTaskBuilder: Set an array of files to transfer.
withPaths(Collection<String>) - Method in class com.sshtools.client.tasks.PullTask.PullTaskBuilder: Set an array of files to transfer.
withPaths(Collection<Path>) - Method in class com.sshtools.client.tasks.PushTask.PushTaskBuilder: Set a collection of file paths to transfer.
withPort(int) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set the port to use.
withPort(Optional<Integer>) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set the port to use.
withPrimarySftpClient(SftpClient) - Method in class com.sshtools.client.tasks.AbstractOptimisedTask.AbstractOptimisedTaskBuilder: Set an SftpClient to use instead of creating a new one.
withPrivateKeyFile(File) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set a private key file to use for authentication.
withPrivateKeyFile(File, PassphrasePrompt) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set a private key file to use for authentication.
withPrivateKeyFile(Path) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set a private key file to use for authentication.
withPrivateKeyFile(Path, PassphrasePrompt) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set a private key file to use for authentication.
withPrivateKeyFiles(Collection<File>) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set multiple private keys from a Path collection.
withPrivateKeyFiles(Collection<File>, PassphrasePrompt) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set a private key file to use for authentication.
withPrivateKeyPaths(Collection<Path>) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set multiple private keys from a Path collection.
withPrivateKeyPaths(Collection<Path>, PassphrasePrompt) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set multiple private keys from a Path collection.
withProgress(FileTransferProgress) - Method in class com.sshtools.client.tasks.AbstractFileTask.AbstractFileTaskBuilder: Set a FileTransferProgress for the overall progress of the transfer.
withProgress(Optional<FileTransferProgress>) - Method in class com.sshtools.client.tasks.AbstractFileTask.AbstractFileTaskBuilder: Set a FileTransferProgress for the overall progress of the transfer.
withProgressMessages(AbstractOptimisedTask.ProgressMessages) - Method in class com.sshtools.client.tasks.AbstractOptimisedTask.AbstractOptimisedTaskBuilder: Set the AbstractOptimisedTask.ProgressMessages callback to receive various progress message, it does not receive the actual amount of progress.
withPty(boolean) - Method in class com.sshtools.client.tasks.CommandTask.CommandTaskBuilder: Set whether or not to allocate a Pty.
withPty(boolean) - Method in class com.sshtools.client.tasks.ShellTask.ShellTaskBuilder: Set whether or not to allocate a Pty.
withRemote(Path) - Method in class com.sshtools.client.tasks.DownloadFileTask.DownloadFileTaskBuilder: Set the remote path of the local to download.
withRemote(Path) - Method in class com.sshtools.client.tasks.DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder: Set the remote remote of the local to download.
withRemote(Path) - Method in class com.sshtools.client.tasks.StatTask.StatTaskBuilder: Set the remote path to stat
withRemote(Path) - Method in class com.sshtools.client.tasks.UploadFileContentTask.UploadFileContentTaskBuilder: Set the remote path to upload the file to.
withRemote(Path) - Method in class com.sshtools.client.tasks.UploadFileTask.UploadFileTaskBuilder: Set the remote path to upload the file to.
withRemote(Path) - Method in class com.sshtools.client.tasks.UploadInputStreamTask.UploadInputStreamTaskBuilder: Set the remote path to upload the file to.
withRemote(Optional<Path>) - Method in class com.sshtools.client.tasks.DownloadFileTask.DownloadFileTaskBuilder: Set the remote path of the local to download.
withRemote(Optional<Path>) - Method in class com.sshtools.client.tasks.DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder: Set the remote remote of the local to download.
withRemote(Optional<Path>) - Method in class com.sshtools.client.tasks.StatTask.StatTaskBuilder: Set the remote path to stat
withRemote(Optional<Path>) - Method in class com.sshtools.client.tasks.UploadFileContentTask.UploadFileContentTaskBuilder: Set the remote path to upload the file to.
withRemote(Optional<Path>) - Method in class com.sshtools.client.tasks.UploadFileTask.UploadFileTaskBuilder: Set the remote path to upload the file to.
withRemote(Optional<Path>) - Method in class com.sshtools.client.tasks.UploadInputStreamTask.UploadInputStreamTaskBuilder: Set the remote path to upload the file to.
withRemoteFolder(String) - Method in class com.sshtools.client.tasks.PushTask.PushTaskBuilder: Set the remote folder where any transferred paths will be placed.
withRemoteFolder(Path) - Method in class com.sshtools.client.tasks.PushTask.PushTaskBuilder: Set the remote folder where any transferred paths will be placed.
withRemoteFolder(Optional<Path>) - Method in class com.sshtools.client.tasks.PushTask.PushTaskBuilder: Set the remote folder where any transferred paths will be placed.
withRemotePath(String) - Method in class com.sshtools.client.sftp.SftpClient.SftpClientBuilder: Start off in a specified remote path.
withRemotePath(String) - Method in class com.sshtools.client.tasks.DownloadFileTask.DownloadFileTaskBuilder: Set the remote path of the local to download.
withRemotePath(String) - Method in class com.sshtools.client.tasks.DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder: Set the remote remote of the local to download.
withRemotePath(String) - Method in class com.sshtools.client.tasks.StatTask.StatTaskBuilder: Set the remote path to stat
withRemotePath(String) - Method in class com.sshtools.client.tasks.UploadFileContentTask.UploadFileContentTaskBuilder: Set the remote path to upload the file to.
withRemotePath(String) - Method in class com.sshtools.client.tasks.UploadFileTask.UploadFileTaskBuilder: Set the remote path to upload the file to.
withRemotePath(String) - Method in class com.sshtools.client.tasks.UploadInputStreamTask.UploadInputStreamTaskBuilder: Set the remote path to upload the file to.
withRemotePath(Optional<String>) - Method in class com.sshtools.client.tasks.DownloadFileTask.DownloadFileTaskBuilder: Set the remote path of the local to download.
withRemotePath(Optional<String>) - Method in class com.sshtools.client.tasks.DownloadOutputStreamTask.DownloadOutputStreamTaskBuilder: Set the remote remote of the local to download.
withRemotePath(Optional<String>) - Method in class com.sshtools.client.tasks.StatTask.StatTaskBuilder: Set the remote path to stat
withRemotePath(Optional<String>) - Method in class com.sshtools.client.tasks.UploadFileContentTask.UploadFileContentTaskBuilder: Set the remote path to upload the file to.
withRemotePath(Optional<String>) - Method in class com.sshtools.client.tasks.UploadFileTask.UploadFileTaskBuilder: Set the remote path to upload the file to.
withRemotePath(Optional<String>) - Method in class com.sshtools.client.tasks.UploadInputStreamTask.UploadInputStreamTaskBuilder: Set the remote path to upload the file to.
withRows(int) - Method in class com.sshtools.client.tasks.CommandTask.CommandTaskBuilder: Set the terminal height in rows to use when allocating a PTY.
withRows(int) - Method in class com.sshtools.client.tasks.ShellTask.ShellTaskBuilder: Set the terminal height in rows to use when allocating a PTY.
withSession(Function<SshConnection, SC>) - Method in class com.sshtools.client.tasks.AbstractSessionTask.AbstractSessionTaskBuilder: Set a function to create a custom session channel.
withSshContext(SshClientContext) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set the SshClientContext to use.
withTarget(String, int) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set the hostname and port to use from the provided address.
withTarget(InetSocketAddress) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set the host and port to use from the provided address.
withTermType(String) - Method in class com.sshtools.client.tasks.CommandTask.CommandTaskBuilder: Set the terminal type to use when allocating a PTY.
withTermType(String) - Method in class com.sshtools.client.tasks.ShellTask.ShellTaskBuilder: Set the terminal type to use when allocating a PTY.
withTermType(Optional<String>) - Method in class com.sshtools.client.tasks.CommandTask.CommandTaskBuilder: Set the terminal type to use when allocating a PTY.
withTermType(Optional<String>) - Method in class com.sshtools.client.tasks.ShellTask.ShellTaskBuilder: Set the terminal type to use when allocating a PTY.
withUsername(String) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set the username to use for authentication.
withUsername(Optional<String>) - Method in class com.sshtools.client.SshClient.SshClientBuilder: Set the username to use for authentication.
withVerboseOutput() - Method in class com.sshtools.client.tasks.AbstractOptimisedTask.AbstractOptimisedTaskBuilder: Output verbose information about the operation.
withVerboseOutput(boolean) - Method in class com.sshtools.client.tasks.AbstractOptimisedTask.AbstractOptimisedTaskBuilder: Output verbose information about the operation.
withVerifyIntegrity() - Method in class com.sshtools.client.tasks.AbstractOptimisedTask.AbstractOptimisedTaskBuilder: The integrity of any paths transferred will be verified using the configured digest (see AbstractOptimisedTask.AbstractOptimisedTaskBuilder.withDigest(RemoteHash).
withWithoutLocalHomeSandbox() - Method in class com.sshtools.client.sftp.SftpClient.SftpClientBuilder: Set to not sandbox the path provided as the Local Home/code>.
write(byte[], int, int) - Method in class com.sshtools.client.sftp.SftpFileOutputStream
write(int) - Method in class com.sshtools.client.sftp.SftpFileOutputStream
write(long, byte[], int, int) - Method in class com.sshtools.client.sftp.SftpHandle: Write bytes directly to this file.
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

Deprecated.

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
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form