org.apache.sshd.client.subsystem.sftp

Interface SftpClientCreator

All Known Subinterfaces:

ClientSession

All Known Implementing Classes:

AbstractClientSession, ClientSessionImpl

public interface SftpClientCreator

Author:

Apache MINA SSHD Project

Method Summary

Modifier and Type	Method and Description
default SftpClient	createSftpClient() Create an SFTP client from this session.
default SftpClient	createSftpClient(int version) Creates an SFTP client using the specified version
SftpClient	createSftpClient(SftpVersionSelector selector) Creates an SFTP client while allowing the selection of a specific version
FileSystem	createSftpFileSystem()
FileSystem	createSftpFileSystem(int version)
FileSystem	createSftpFileSystem(int readBufferSize, int writeBufferSize)
FileSystem	createSftpFileSystem(int version, int readBufferSize, int writeBufferSize)
FileSystem	createSftpFileSystem(SftpVersionSelector selector)
FileSystem	createSftpFileSystem(SftpVersionSelector selector, int readBufferSize, int writeBufferSize)

Method Detail

createSftpClient

default SftpClient createSftpClient()
                             throws IOException

Create an SFTP client from this session.

Returns:

The created SftpClient

Throws:

IOException - if failed to create the client

createSftpClient

default SftpClient createSftpClient(int version)
                             throws IOException

Creates an SFTP client using the specified version

Parameters:

version - The version to use - Note: if the specified version is not supported by the server then an exception will occur

Returns:

The created SftpClient

Throws:

IOException - If failed to create the client or use the specified version

createSftpClient

SftpClient createSftpClient(SftpVersionSelector selector)
                     throws IOException

Creates an SFTP client while allowing the selection of a specific version

Parameters:

selector - The SftpVersionSelector to use - Note: if the server does not support versions re-negotiation then the selector will be presented with only one "choice" - the current version

Returns:

The created SftpClient

Throws:

IOException - If failed to create the client or re-negotiate

createSftpFileSystem

FileSystem createSftpFileSystem()
                         throws IOException

Throws:

IOException

createSftpFileSystem

FileSystem createSftpFileSystem(int version)
                         throws IOException

Throws:

IOException

createSftpFileSystem

FileSystem createSftpFileSystem(SftpVersionSelector selector)
                         throws IOException

Throws:

IOException

createSftpFileSystem

FileSystem createSftpFileSystem(int readBufferSize,
                                int writeBufferSize)
                         throws IOException

Throws:

IOException

createSftpFileSystem

FileSystem createSftpFileSystem(int version,
                                int readBufferSize,
                                int writeBufferSize)
                         throws IOException

Throws:

IOException

createSftpFileSystem

FileSystem createSftpFileSystem(SftpVersionSelector selector,
                                int readBufferSize,
                                int writeBufferSize)
                         throws IOException

Throws:

IOException