Package org.apache.sshd.sftp.client.fs

Interface SftpFileSystemClientSessionInitializer

public interface SftpFileSystemClientSessionInitializer

Provides user hooks into the process of creating a SftpFileSystem via a SftpFileSystemProvider.

Field Summary

Fields

Modifier and Type	Field	Description
static SftpFileSystemClientSessionInitializer	DEFAULT

Method Summary

Modifier and Type	Method	Description
default void	authenticateClientSession(SftpFileSystemProvider provider, SftpFileSystemInitializationContext context, ClientSession session)	Invoked by the SftpFileSystemProvider.newFileSystem(java.net.URI, Map) method in order to authenticate the session obtained from createClientSession(SftpFileSystemProvider, SftpFileSystemInitializationContext)
default ClientSession	createClientSession(SftpFileSystemProvider provider, SftpFileSystemInitializationContext context)	Invoked by the SftpFileSystemProvider.newFileSystem(java.net.URI, Map) method in order to obtain an initial (non-authenticated) ClientSession.
default SftpFileSystem	createSftpFileSystem(SftpFileSystemProvider provider, SftpFileSystemInitializationContext context, ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)	Deprecated. since 2.10.1
default SftpFileSystem	createSftpFileSystem(SftpFileSystemProvider provider, SftpFileSystemInitializationContext context, IOFunction<java.lang.Boolean,ClientSession> sessionProvider, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)	Invoked by the SftpFileSystemProvider.newFileSystem(java.net.URI, Map) method in order to create the SftpFileSystem once session has been authenticated.

Field Detail

DEFAULT

static final SftpFileSystemClientSessionInitializer DEFAULT

Method Detail

createClientSession

default ClientSession createClientSession(SftpFileSystemProvider provider,
                                          SftpFileSystemInitializationContext context)
                                   throws java.io.IOException

Invoked by the SftpFileSystemProvider.newFileSystem(java.net.URI, Map) method in order to obtain an initial (non-authenticated) ClientSession.

Parameters:

provider - The SftpFileSystemProvider instance requesting the session

context - The initialization SftpFileSystemInitializationContext

Returns:

The created ClientSession

Throws:

java.io.IOException - If failed to connect

authenticateClientSession

default void authenticateClientSession(SftpFileSystemProvider provider,
                                       SftpFileSystemInitializationContext context,
                                       ClientSession session)
                                throws java.io.IOException

Invoked by the SftpFileSystemProvider.newFileSystem(java.net.URI, Map) method in order to authenticate the session obtained from createClientSession(SftpFileSystemProvider, SftpFileSystemInitializationContext)

Parameters:

provider - The SftpFileSystemProvider instance requesting the session

context - The initialization SftpFileSystemInitializationContext

session - The created ClientSession

Throws:

java.io.IOException - If failed to authenticate

createSftpFileSystem

@Deprecated
default SftpFileSystem createSftpFileSystem(SftpFileSystemProvider provider,
                                            SftpFileSystemInitializationContext context,
                                            ClientSession session,
                                            SftpVersionSelector selector,
                                            SftpErrorDataHandler errorDataHandler)
                                     throws java.io.IOException

Deprecated.

since 2.10.1

Invoked by the SftpFileSystemProvider.newFileSystem(java.net.URI, Map) method in order to create the SftpFileSystem once session has been authenticated.

Parameters:

provider - The SftpFileSystemProvider instance requesting the session

context - The initialization SftpFileSystemInitializationContext

session - The authenticated ClientSession

selector - The resolved SftpVersionSelector to use

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

Returns:

The created SftpFileSystem

Throws:

java.io.IOException - If failed to create the file-system

createSftpFileSystem

default SftpFileSystem createSftpFileSystem(SftpFileSystemProvider provider,
                                            SftpFileSystemInitializationContext context,
                                            IOFunction<java.lang.Boolean,ClientSession> sessionProvider,
                                            SftpVersionSelector selector,
                                            SftpErrorDataHandler errorDataHandler)
                                     throws java.io.IOException

Invoked by the SftpFileSystemProvider.newFileSystem(java.net.URI, Map) method in order to create the SftpFileSystem once session has been authenticated.

Parameters:

provider - The SftpFileSystemProvider instance requesting the session

context - The initialization SftpFileSystemInitializationContext

sessionProvider - A factory for authenticated ClientSessions

selector - The resolved SftpVersionSelector to use

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

Returns:

The created SftpFileSystem

Throws:

java.io.IOException - If failed to create the file-system