Top Description Fields Constructors Methods
org.apache.sshd.sftp.client.impl

public Class DefaultSftpClientFactory

extends AbstractLoggingBean
implements SftpClientFactory
Class Inheritance
All Implemented Interfaces
org.apache.sshd.sftp.client.SftpClientFactory
Imports
java.io.IOException, org.apache.sshd.client.ClientFactoryManager, .SshClient, org.apache.sshd.client.session.ClientSession, org.apache.sshd.common.util.logging.AbstractLoggingBean, org.apache.sshd.sftp.client.SftpClient, .SftpClientFactory, .SftpErrorDataHandler, .SftpVersionSelector, org.apache.sshd.sftp.client.fs.SftpFileSystem, .SftpFileSystemProvider

TODO Add javadoc
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
public static final DefaultSftpClientFactory
Inherited from org.apache.sshd.common.util.logging.AbstractLoggingBean:
log

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
protected DefaultSftpClient
public SftpClient
createSftpClient(ClientSession
The ClientSession to which the SFTP client should be attached
session
,
SftpVersionSelector
The SftpVersionSelector to use in order to negotiate the SFTP version
selector
,
SftpErrorDataHandler
The SftpErrorDataHandler to handle incoming data through the error stream - if null the data is silently ignored
errorDataHandler
)

Implements org.apache.sshd.sftp.client.SftpClientFactory.createSftpClient.

public SftpFileSystem
createSftpFileSystem(ClientSession
The ClientSession to which the SFTP client backing the file system should be attached
session
,
SftpVersionSelector
The SftpVersionSelector to use in order to negotiate the SFTP version
selector
,
SftpErrorDataHandler
The SftpErrorDataHandler to handle incoming data through the error stream - if null the data is silently ignored
errorDataHandler
,
int
Default I/O read buffer size
readBufferSize
,
int
Default I/O write buffer size
writeBufferSize
)

Implements org.apache.sshd.sftp.client.SftpClientFactory.createSftpFileSystem.

Inherited from org.apache.sshd.common.util.logging.AbstractLoggingBean:
debugdebugdebugdebugdebugerrorerrorerrorerrorerrorgetSimplifiedLoggerinfoinfowarnwarnwarnwarnwarnwarnwarnwarn

Field Detail

INSTANCEback to summary
public static final DefaultSftpClientFactory INSTANCE

Constructor Detail

DefaultSftpClientFactoryback to summary
public DefaultSftpClientFactory()

Method Detail

createDefaultSftpClientback to summary
protected DefaultSftpClient createDefaultSftpClient(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler) throws IOException
createSftpClientback to summary
public SftpClient createSftpClient(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler) throws IOException

Implements org.apache.sshd.sftp.client.SftpClientFactory.createSftpClient.

Parameters
session:ClientSession

Doc from org.apache.sshd.sftp.client.SftpClientFactory.createSftpClient.

The ClientSession to which the SFTP client should be attached

selector:SftpVersionSelector

Doc from org.apache.sshd.sftp.client.SftpClientFactory.createSftpClient.

The SftpVersionSelector to use in order to negotiate the SFTP version

errorDataHandler:SftpErrorDataHandler

Doc from org.apache.sshd.sftp.client.SftpClientFactory.createSftpClient.

The SftpErrorDataHandler to handle incoming data through the error stream - if null the data is silently ignored

Returns:SftpClient

Doc from org.apache.sshd.sftp.client.SftpClientFactory.createSftpClient.

The created SftpClient instance

Annotations
@Override
Exceptions
IOException:

Doc from org.apache.sshd.sftp.client.SftpClientFactory.createSftpClient.

If failed to create the client

createSftpFileSystemback to summary
public SftpFileSystem createSftpFileSystem(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler, int readBufferSize, int writeBufferSize) throws IOException

Implements org.apache.sshd.sftp.client.SftpClientFactory.createSftpFileSystem.

Parameters
session:ClientSession

Doc from org.apache.sshd.sftp.client.SftpClientFactory.createSftpFileSystem.

The ClientSession to which the SFTP client backing the file system should be attached

selector:SftpVersionSelector

Doc from org.apache.sshd.sftp.client.SftpClientFactory.createSftpFileSystem.

The SftpVersionSelector to use in order to negotiate the SFTP version

errorDataHandler:SftpErrorDataHandler

Doc from org.apache.sshd.sftp.client.SftpClientFactory.createSftpFileSystem.

The SftpErrorDataHandler to handle incoming data through the error stream - if null the data is silently ignored

readBufferSize:int

Doc from org.apache.sshd.sftp.client.SftpClientFactory.createSftpFileSystem.

Default I/O read buffer size

writeBufferSize:int

Doc from org.apache.sshd.sftp.client.SftpClientFactory.createSftpFileSystem.

Default I/O write buffer size

Returns:SftpFileSystem

Doc from org.apache.sshd.sftp.client.SftpClientFactory.createSftpFileSystem.

The created SftpFileSystem instance

Annotations
@Override
Exceptions
IOException:

Doc from org.apache.sshd.sftp.client.SftpClientFactory.createSftpFileSystem.

If failed to create the instance