Package org.apache.sshd.contrib.common.session.helpers

Class ChannelIdTrackingUnknownChannelReferenceHandler

java.lang.Object

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

org.apache.sshd.common.session.helpers.DefaultUnknownChannelReferenceHandler

org.apache.sshd.contrib.common.session.helpers.ChannelIdTrackingUnknownChannelReferenceHandler

All Implemented Interfaces:

java.util.EventListener, ChannelListener, UnknownChannelReferenceHandler, SshdEventListener

public class ChannelIdTrackingUnknownChannelReferenceHandler
extends DefaultUnknownChannelReferenceHandler
implements ChannelListener

Makes sure that the referenced "unknown" channel identifier is one that was assigned in the past. Note: it relies on the fact that the default ConnectionService implementation assigns channels identifiers in ascending order.

Field Summary

Fields

Modifier and Type	Field	Description
static AttributeRepository.AttributeKey<java.lang.Long>	LAST_CHANNEL_ID_KEY
static ChannelIdTrackingUnknownChannelReferenceHandler	TRACKER

Fields inherited from class org.apache.sshd.common.session.helpers.DefaultUnknownChannelReferenceHandler

INSTANCE

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

log

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
ChannelIdTrackingUnknownChannelReferenceHandler()

Method Summary

Modifier and Type	Method	Description
void	channelInitialized(Channel channel)	Called to inform about initial setup of a channel via the Channel.init(org.apache.sshd.common.session.ConnectionService, org.apache.sshd.common.session.Session, long) method.
Channel	handleUnknownChannelCommand(ConnectionService service, byte cmd, long channelId, Buffer buffer)	Invoked when the connection service responsible for handling channel messages receives a message intended for an unknown channel.

Methods inherited from class org.apache.sshd.common.session.helpers.DefaultUnknownChannelReferenceHandler

sendFailureResponse

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

channelClosed, channelOpenFailure, channelOpenSuccess, channelStateChanged

Field Detail

LAST_CHANNEL_ID_KEY

public static final AttributeRepository.AttributeKey<java.lang.Long> LAST_CHANNEL_ID_KEY

TRACKER

public static final ChannelIdTrackingUnknownChannelReferenceHandler TRACKER

Constructor Detail

ChannelIdTrackingUnknownChannelReferenceHandler

public ChannelIdTrackingUnknownChannelReferenceHandler()

Method Detail

channelInitialized

public void channelInitialized(Channel channel)

Description copied from interface: ChannelListener

Called to inform about initial setup of a channel via the Channel.init(org.apache.sshd.common.session.ConnectionService, org.apache.sshd.common.session.Session, long) method. Note: this method is guaranteed to be called before either of the ChannelListener.channelOpenSuccess(Channel) or ChannelListener.channelOpenFailure(Channel, Throwable) will be called

Specified by:

channelInitialized in interface ChannelListener

Parameters:

channel - The initialized Channel

handleUnknownChannelCommand

public Channel handleUnknownChannelCommand(ConnectionService service,
                                           byte cmd,
                                           long channelId,
                                           Buffer buffer)
                                    throws java.io.IOException

Description copied from interface: UnknownChannelReferenceHandler

Invoked when the connection service responsible for handling channel messages receives a message intended for an unknown channel.

Specified by:

handleUnknownChannelCommand in interface UnknownChannelReferenceHandler

Overrides:

handleUnknownChannelCommand in class DefaultUnknownChannelReferenceHandler

Parameters:

service - The ConnectionService instance through which the message was received

cmd - The requested command identifier

channelId - The (unknown) target channel identifier

buffer - The message Buffer containing the rest of the message

Returns:

The resolved Channel - if null then the message for the unknown channel is ignored.

Throws:

java.io.IOException - If failed to handle the request