org.apache.sshd.sftp.client.fs

Class SftpFileSystem.SftpClientHandle

java.lang.Object

org.apache.sshd.sftp.client.fs.SftpFileSystem.SftpClientHandle

All Implemented Interfaces:

EventListener, ChannelListener, SshdEventListener

Enclosing class:

SftpFileSystem

protected static class SftpFileSystem.SftpClientHandle
extends Object
implements ChannelListener

The SftpFileSystem.SftpClientPool stores SftpClients not directly but via handles in its channel pool. HAndles remove themselves from the pool

Field Summary

Fields inherited from interface org.apache.sshd.common.channel.ChannelListener

EMPTY

Constructor Summary

Constructors

Constructor and Description
SftpClientHandle(BlockingQueue<? extends SftpFileSystem.SftpClientHandle> pool, SftpClient client)

Method Summary

Modifier and Type	Method and Description
void	channelClosed(Channel channel, Throwable reason) Called to inform about a channel being closed.
void	destroy()
SftpClient	getClient()
void	setExpiration(Future<?> future)

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.common.channel.ChannelListener

channelInitialized, channelOpenFailure, channelOpenSuccess, channelStateChanged, validateListener

Methods inherited from interface org.apache.sshd.common.util.SshdEventListener

validateListener

Constructor Detail

SftpClientHandle

public SftpClientHandle(BlockingQueue<? extends SftpFileSystem.SftpClientHandle> pool,
                        SftpClient client)

Method Detail

destroy

public void destroy()

getClient

public SftpClient getClient()

setExpiration

public void setExpiration(Future<?> future)

channelClosed

public void channelClosed(Channel channel,
                          Throwable reason)

Description copied from interface: ChannelListener

Called to inform about a channel being closed. Note: when the call is made there are no guarantees about the channel's actual state except that it either has been already closed or may be in the process of being closed. Note: this method is guaranteed to be called regardless of whether ChannelListener.channelOpenSuccess(Channel) or ChannelListener.channelOpenFailure(Channel, Throwable) have been called

Specified by:

channelClosed in interface ChannelListener

Parameters:

channel - The referenced Channel

reason - The reason why the channel is being closed - if null then normal closure