org.apache.sshd.sftp.client.impl

Class DefaultSftpClientFactory

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.sftp.client.impl.DefaultSftpClientFactory

All Implemented Interfaces:

SftpClientFactory

public class DefaultSftpClientFactory
extends org.apache.sshd.common.util.logging.AbstractLoggingBean
implements SftpClientFactory

TODO Add javadoc

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static DefaultSftpClientFactory	INSTANCE

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor and Description
DefaultSftpClientFactory()

Method Summary

Modifier and Type	Method and Description
protected DefaultSftpClient	createDefaultSftpClient(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)
SftpClient	createSftpClient(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)
SftpFileSystem	createSftpFileSystem(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler, int readBufferSize, int writeBufferSize)

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.sshd.sftp.client.SftpClientFactory

createSftpClient, createSftpClient, createSftpClient, createSftpClient, createSftpFileSystem, createSftpFileSystem, createSftpFileSystem, createSftpFileSystem, createSftpFileSystem, createSftpFileSystem, instance

Field Detail

INSTANCE

public static final DefaultSftpClientFactory INSTANCE

Constructor Detail

DefaultSftpClientFactory

public DefaultSftpClientFactory()

Method Detail

createSftpClient

public SftpClient createSftpClient(ClientSession session,
                                   SftpVersionSelector selector,
                                   SftpErrorDataHandler errorDataHandler)
                            throws IOException

Specified by:

createSftpClient in interface SftpClientFactory

Parameters:

session - The ClientSession to which the SFTP client should be attached

selector - The SftpVersionSelector to use in order to negotiate the SFTP version

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

Returns:

The created SftpClient instance

Throws:

IOException - If failed to create the client

createDefaultSftpClient

protected DefaultSftpClient createDefaultSftpClient(ClientSession session,
                                                    SftpVersionSelector selector,
                                                    SftpErrorDataHandler errorDataHandler)
                                             throws IOException

Throws:

IOException

createSftpFileSystem

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

Specified by:

createSftpFileSystem in interface SftpClientFactory

Parameters:

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

selector - The SftpVersionSelector to use in order to negotiate the SFTP version

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

readBufferSize - Default I/O read buffer size

writeBufferSize - Default I/O write buffer size

Returns:

The created SftpFileSystem instance

Throws:

IOException - If failed to create the instance