Package org.apache.sshd.sftp.client
Interface SftpClientFactory
- All Known Implementing Classes:
DefaultSftpClientFactory
public interface SftpClientFactory
TODO Add javadoc
-
Method Summary
Modifier and TypeMethodDescriptiondefault SftpClient
createSftpClient
(ClientSession session) Create an SFTP client from this session.default SftpClient
createSftpClient
(ClientSession session, int version) Creates an SFTP client using the specified versiondefault SftpClient
createSftpClient
(ClientSession session, SftpErrorDataHandler errorDataHandler) Create an SFTP client from this session.default SftpClient
createSftpClient
(ClientSession session, SftpVersionSelector selector) createSftpClient
(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler) default SftpFileSystem
createSftpFileSystem
(ClientSession session) default SftpFileSystem
createSftpFileSystem
(ClientSession session, int version) default SftpFileSystem
createSftpFileSystem
(ClientSession session, int readBufferSize, int writeBufferSize) default SftpFileSystem
createSftpFileSystem
(ClientSession session, int version, int readBufferSize, int writeBufferSize) default SftpFileSystem
createSftpFileSystem
(ClientSession session, SftpVersionSelector selector) default SftpFileSystem
createSftpFileSystem
(ClientSession session, SftpVersionSelector selector, int readBufferSize, int writeBufferSize) createSftpFileSystem
(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler, int readBufferSize, int writeBufferSize) static SftpClientFactory
instance()
-
Method Details
-
instance
-
createSftpClient
Create an SFTP client from this session.- Parameters:
session
- TheClientSession
to be used for creating the SFTP client- Returns:
- The created
SftpClient
- Throws:
IOException
- if failed to create the client
-
createSftpClient
Creates an SFTP client using the specified version- Parameters:
session
- TheClientSession
to be used for creating the SFTP clientversion
- 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
default SftpClient createSftpClient(ClientSession session, SftpVersionSelector selector) throws IOException - Parameters:
session
- TheClientSession
to which the SFTP client should be attachedselector
- TheSftpVersionSelector
to use in order to negotiate the SFTP version- Returns:
- The created
SftpClient
instance - Throws:
IOException
- If failed to create the client
-
createSftpClient
default SftpClient createSftpClient(ClientSession session, SftpErrorDataHandler errorDataHandler) throws IOException Create an SFTP client from this session.- Parameters:
session
- TheClientSession
to be used for creating the SFTP clienterrorDataHandler
- TheSftpErrorDataHandler
to handle incoming data through the error stream - ifnull
the data is silently ignored- Returns:
- The created
SftpClient
- Throws:
IOException
- if failed to create the client
-
createSftpClient
SftpClient createSftpClient(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler) throws IOException - Parameters:
session
- TheClientSession
to which the SFTP client should be attachedselector
- TheSftpVersionSelector
to use in order to negotiate the SFTP versionerrorDataHandler
- TheSftpErrorDataHandler
to handle incoming data through the error stream - ifnull
the data is silently ignored- Returns:
- The created
SftpClient
instance - Throws:
IOException
- If failed to create the client
-
createSftpFileSystem
- Throws:
IOException
-
createSftpFileSystem
- Throws:
IOException
-
createSftpFileSystem
default SftpFileSystem createSftpFileSystem(ClientSession session, SftpVersionSelector selector) throws IOException - Throws:
IOException
-
createSftpFileSystem
default SftpFileSystem createSftpFileSystem(ClientSession session, int version, int readBufferSize, int writeBufferSize) throws IOException - Throws:
IOException
-
createSftpFileSystem
default SftpFileSystem createSftpFileSystem(ClientSession session, int readBufferSize, int writeBufferSize) throws IOException - Throws:
IOException
-
createSftpFileSystem
default SftpFileSystem createSftpFileSystem(ClientSession session, SftpVersionSelector selector, int readBufferSize, int writeBufferSize) throws IOException - Throws:
IOException
-
createSftpFileSystem
SftpFileSystem createSftpFileSystem(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler, int readBufferSize, int writeBufferSize) throws IOException - Parameters:
session
- TheClientSession
to which the SFTP client backing the file system should be attachedselector
- TheSftpVersionSelector
to use in order to negotiate the SFTP versionerrorDataHandler
- TheSftpErrorDataHandler
to handle incoming data through the error stream - ifnull
the data is silently ignoredreadBufferSize
- Default I/O read buffer sizewriteBufferSize
- Default I/O write buffer size- Returns:
- The created
SftpFileSystem
instance - Throws:
IOException
- If failed to create the instance
-