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

Class AbstractConnectionService

java.lang.Object

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

org.apache.sshd.common.util.closeable.IoBaseCloseable

org.apache.sshd.common.util.closeable.AbstractCloseable

org.apache.sshd.common.util.closeable.AbstractInnerCloseable

org.apache.sshd.common.session.helpers.AbstractConnectionService

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, Closeable, PortForwardingEventListenerManager, PortForwardingEventListenerManagerHolder, PropertyResolver, Service, ConnectionService, SessionContextHolder, SessionHeartbeatController, SessionHolder<Session>, UnknownChannelReferenceHandlerManager

Direct Known Subclasses:

ClientConnectionService, ServerConnectionService

public abstract class AbstractConnectionService
extends AbstractInnerCloseable
implements ConnectionService

Base implementation of ConnectionService.

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

AbstractCloseable.State

Nested classes/interfaces inherited from interface org.apache.sshd.common.session.SessionHeartbeatController

SessionHeartbeatController.HeartbeatType

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<Long,Channel>	channels	Map of channels keyed by the identifier
static final String	DEFAULT_SESSION_IGNORE_HEARTBEAT_STRING	Used in SSH_MSH_IGNORE messages for the keep-alive mechanism
protected final AtomicLong	heartbeatCount
protected final AtomicLong	nextChannelId	Next channel identifier - a UINT32 represented as a long
static final IntUnaryOperator	RESPONSE_BUFFER_GROWTH_FACTOR	Default growth factor function used to resize response buffers

Fields inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

closeFuture, futureLock, state

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

log

Fields inherited from interface org.apache.sshd.common.PropertyResolver

EMPTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractConnectionService(AbstractSession session)

Method Summary

Modifier and Type	Method	Description
void	addPortForwardingEventListener(PortForwardingEventListener listener)	Add a port forwarding listener
boolean	addPortForwardingEventListenerManager(PortForwardingEventListenerManager manager)
void	channelClose(Buffer buffer)	Close a channel due to a close packet received
void	channelData(Buffer buffer)	Process incoming data on a channel
void	channelEof(Buffer buffer)	Process end of file on a channel
void	channelExtendedData(Buffer buffer)	Process incoming extended data on a channel
void	channelFailure(Buffer buffer)	Process a failure on a channel
protected void	channelOpen(Buffer buffer)
void	channelOpenConfirmation(Buffer buffer)
void	channelOpenFailure(Buffer buffer)
void	channelRequest(Buffer buffer)	Service a request on a channel
void	channelSuccess(Buffer buffer)	Process a success on a channel
void	channelWindowAdjust(Buffer buffer)	Process a window adjust packet on a channel
protected AgentForwardSupport	createAgentForwardSupport(Session session)
protected Forwarder	createForwardingFilter(Session session)
protected X11ForwardSupport	createX11ForwardSupport(Session session)
protected void	futureDone(HasException future)
AgentForwardSupport	getAgentForwardSupport()
protected Channel	getChannel(byte cmd, long recipient, Buffer buffer)
protected Channel	getChannel(byte cmd, Buffer buffer)	Retrieve the channel designated by the given packet
Collection<Channel>	getChannels()
Forwarder	getForwarder()	Retrieve the forwarder instance
protected Closeable	getInnerCloseable()
protected long	getNextChannelId()
PortForwardingEventListener	getPortForwardingEventListenerProxy()
Map<String,Object>	getProperties()
Collection<PortForwardingEventListenerManager>	getRegisteredManagers()
AbstractSession	getSession()
UnknownChannelReferenceHandler	getUnknownChannelReferenceHandler()
X11ForwardSupport	getX11ForwardSupport()
protected IoWriteFuture	globalRequest(Buffer buffer)	Process global requests
protected IoWriteFuture	handleUnknownRequest(Buffer buffer, String req, boolean wantReply)
boolean	isAllowMoreSessions()
protected void	preClose()
void	process(int cmd, Buffer buffer)	Service the request.
long	registerChannel(Channel channel)	Register a newly created channel with a new unique identifier
void	removePortForwardingEventListener(PortForwardingEventListener listener)	Remove a port forwarding listener
boolean	removePortForwardingEventListenerManager(PortForwardingEventListenerManager manager)
protected void	requestFailure(Buffer buffer)
protected void	requestSuccess(Buffer buffer)
UnknownChannelReferenceHandler	resolveUnknownChannelReferenceHandler()	Check if current manager has a specific handler set for it - if not, try and resolve one from the "parent" container (if any)
protected IoWriteFuture	sendChannelOpenFailure(Buffer buffer, long sender, int reasonCode, String message, String lang)
protected IoWriteFuture	sendGlobalResponse(Buffer buffer, String req, RequestHandler.Result result, boolean wantReply)
protected boolean	sendHeartBeat()	Sends a heartbeat message/packet
void	setAllowMoreSessions(boolean allow)
void	setUnknownChannelReferenceHandler(UnknownChannelReferenceHandler handler)
void	start()
protected ScheduledFuture<?>	startHeartBeat()
protected void	stopHeartBeat()
String	toString()
void	unregisterChannel(Channel channel)	Remove this channel from the list of managed channels

Methods inherited from class org.apache.sshd.common.util.closeable.AbstractInnerCloseable

doCloseGracefully, doCloseImmediately

Methods inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

addCloseFutureListener, builder, close, getFutureLock, isClosed, isClosing, removeCloseFutureListener

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, wait, wait, wait

Methods inherited from interface org.apache.sshd.common.Closeable

addCloseFutureListener, close, close, isClosed, isClosing, isOpen, removeCloseFutureListener

Methods inherited from interface org.apache.sshd.common.PropertyResolver

getBoolean, getBooleanProperty, getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getString, getStringProperty, isEmpty

Methods inherited from interface org.apache.sshd.common.Service

getParentPropertyResolver

Methods inherited from interface org.apache.sshd.common.session.SessionHeartbeatController

disableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, setSessionHeartbeat, setSessionHeartbeat

Methods inherited from interface org.apache.sshd.common.session.SessionHolder

getSessionContext

Field Details

RESPONSE_BUFFER_GROWTH_FACTOR

public static final IntUnaryOperator RESPONSE_BUFFER_GROWTH_FACTOR

Default growth factor function used to resize response buffers

DEFAULT_SESSION_IGNORE_HEARTBEAT_STRING

public static final String DEFAULT_SESSION_IGNORE_HEARTBEAT_STRING

Used in SSH_MSH_IGNORE messages for the keep-alive mechanism

See Also:

• Constant Field Values

channels

protected final Map<Long,Channel> channels

Map of channels keyed by the identifier

nextChannelId

protected final AtomicLong nextChannelId

Next channel identifier - a UINT32 represented as a long

heartbeatCount

protected final AtomicLong heartbeatCount

Constructor Details

AbstractConnectionService

protected AbstractConnectionService(AbstractSession session)

Method Details

getProperties

public Map<String,Object> getProperties()

Specified by:

getProperties in interface PropertyResolver

getPortForwardingEventListenerProxy

public PortForwardingEventListener getPortForwardingEventListenerProxy()

Specified by:

getPortForwardingEventListenerProxy in interface PortForwardingEventListenerManager

Returns:

A proxy listener representing all the currently registered listener through this manager

addPortForwardingEventListener

public void addPortForwardingEventListener(PortForwardingEventListener listener)

Description copied from interface: PortForwardingEventListenerManager

Add a port forwarding listener

Specified by:

addPortForwardingEventListener in interface PortForwardingEventListenerManager

Parameters:

listener - The PortForwardingEventListener to add - never null

removePortForwardingEventListener

public void removePortForwardingEventListener(PortForwardingEventListener listener)

Description copied from interface: PortForwardingEventListenerManager

Remove a port forwarding listener

Specified by:

removePortForwardingEventListener in interface PortForwardingEventListenerManager

Parameters:

listener - The PortForwardingEventListener to remove - ignored if null

getUnknownChannelReferenceHandler

public UnknownChannelReferenceHandler getUnknownChannelReferenceHandler()

Specified by:

getUnknownChannelReferenceHandler in interface UnknownChannelReferenceHandlerManager

Returns:

The UnknownChannelReferenceHandlerManager to use - if null then any reference to unknown channel causes an SshChannelNotFoundException

setUnknownChannelReferenceHandler

public void setUnknownChannelReferenceHandler(UnknownChannelReferenceHandler handler)

Specified by:

setUnknownChannelReferenceHandler in interface UnknownChannelReferenceHandlerManager

Parameters:

handler - The UnknownChannelReferenceHandlerManager to use - if null then any reference to unknown channel causes an SshChannelNotFoundException

getRegisteredManagers

public Collection<PortForwardingEventListenerManager> getRegisteredManagers()

Specified by:

getRegisteredManagers in interface PortForwardingEventListenerManagerHolder

Returns:

The currently registered managers. Note: it is highly recommended that implementors return either an un-modifiable collection or a copy of the current one. Callers, should avoid modifying the retrieved value.

addPortForwardingEventListenerManager

public boolean addPortForwardingEventListenerManager(PortForwardingEventListenerManager manager)

Specified by:

addPortForwardingEventListenerManager in interface PortForwardingEventListenerManagerHolder

removePortForwardingEventListenerManager

public boolean removePortForwardingEventListenerManager(PortForwardingEventListenerManager manager)

Specified by:

removePortForwardingEventListenerManager in interface PortForwardingEventListenerManagerHolder

getChannels

public Collection<Channel> getChannels()

getSession

public AbstractSession getSession()

Specified by:

getSession in interface SessionHolder<Session>

start

public void start()

Specified by:

start in interface Service

startHeartBeat

protected ScheduledFuture<?> startHeartBeat()

sendHeartBeat

protected boolean sendHeartBeat()

Sends a heartbeat message/packet

Returns:

true if heartbeat successfully sent

futureDone

protected void futureDone(HasException future)

stopHeartBeat

protected void stopHeartBeat()

getForwarder

public Forwarder getForwarder()

Description copied from interface: ConnectionService

Retrieve the forwarder instance

Specified by:

getForwarder in interface ConnectionService

Returns:

The Forwarder

preClose

protected void preClose()

Overrides:

preClose in class AbstractCloseable

createForwardingFilter

protected Forwarder createForwardingFilter(Session session)

getX11ForwardSupport

public X11ForwardSupport getX11ForwardSupport()

Specified by:

getX11ForwardSupport in interface ConnectionService

createX11ForwardSupport

protected X11ForwardSupport createX11ForwardSupport(Session session)

getAgentForwardSupport

public AgentForwardSupport getAgentForwardSupport()

Specified by:

getAgentForwardSupport in interface ConnectionService

createAgentForwardSupport

protected AgentForwardSupport createAgentForwardSupport(Session session)

getInnerCloseable

protected Closeable getInnerCloseable()

Specified by:

getInnerCloseable in class AbstractInnerCloseable

getNextChannelId

protected long getNextChannelId()

registerChannel

public long registerChannel(Channel channel)
                     throws IOException

Description copied from interface: ConnectionService

Register a newly created channel with a new unique identifier

Specified by:

registerChannel in interface ConnectionService

Parameters:

channel - The Channel to register

Returns:

The assigned id of this channel - a UINT32 represented as a long

Throws:

IOException - If failed to initialize and register the channel

unregisterChannel

public void unregisterChannel(Channel channel)

Remove this channel from the list of managed channels

Specified by:

unregisterChannel in interface ConnectionService

Parameters:

channel - the channel

process

public void process(int cmd,
 Buffer buffer)
             throws Exception

Description copied from interface: Service

Service the request.

Specified by:

process in interface Service

Parameters:

cmd - The incoming command type

buffer - The Buffer containing optional command parameters

Throws:

Exception - If failed to process the command

isAllowMoreSessions

public boolean isAllowMoreSessions()

Specified by:

isAllowMoreSessions in interface ConnectionService

setAllowMoreSessions

public void setAllowMoreSessions(boolean allow)

Specified by:

setAllowMoreSessions in interface ConnectionService

channelOpenConfirmation

public void channelOpenConfirmation(Buffer buffer)
                             throws IOException

Throws:

IOException

channelOpenFailure

public void channelOpenFailure(Buffer buffer)
                        throws IOException

Throws:

IOException

channelData

public void channelData(Buffer buffer)
                 throws IOException

Process incoming data on a channel

Parameters:

buffer - the buffer containing the data

Throws:

IOException - if an error occurs

channelExtendedData

public void channelExtendedData(Buffer buffer)
                         throws IOException

Process incoming extended data on a channel

Parameters:

buffer - the buffer containing the data

Throws:

IOException - if an error occurs

channelWindowAdjust

public void channelWindowAdjust(Buffer buffer)
                         throws IOException

Process a window adjust packet on a channel

Parameters:

buffer - the buffer containing the window adjustment parameters

Throws:

IOException - if an error occurs

channelEof

public void channelEof(Buffer buffer)
                throws IOException

Process end of file on a channel

Parameters:

buffer - the buffer containing the packet

Throws:

IOException - if an error occurs

channelClose

public void channelClose(Buffer buffer)
                  throws IOException

Close a channel due to a close packet received

Parameters:

buffer - the buffer containing the packet

Throws:

IOException - if an error occurs

channelRequest

public void channelRequest(Buffer buffer)
                    throws IOException

Service a request on a channel

Parameters:

buffer - the buffer containing the request

Throws:

IOException - if an error occurs

channelFailure

public void channelFailure(Buffer buffer)
                    throws IOException

Process a failure on a channel

Parameters:

buffer - the buffer containing the packet

Throws:

IOException - if an error occurs

channelSuccess

public void channelSuccess(Buffer buffer)
                    throws IOException

Process a success on a channel

Parameters:

buffer - the buffer containing the packet

Throws:

IOException - if an error occurs

getChannel

protected Channel getChannel(byte cmd,
 Buffer buffer)
                      throws IOException

Retrieve the channel designated by the given packet

Parameters:

cmd - The command being processed for the channel

buffer - the incoming packet

Returns:

the target channel

Throws:

IOException - if the channel does not exists

getChannel

protected Channel getChannel(byte cmd,
 long recipient,
 Buffer buffer)
                      throws IOException

Throws:

IOException

resolveUnknownChannelReferenceHandler

public UnknownChannelReferenceHandler resolveUnknownChannelReferenceHandler()

Description copied from interface: UnknownChannelReferenceHandlerManager

Check if current manager has a specific handler set for it - if not, try and resolve one from the "parent" container (if any)

Specified by:

resolveUnknownChannelReferenceHandler in interface UnknownChannelReferenceHandlerManager

Returns:

The resolved handler instance

channelOpen

protected void channelOpen(Buffer buffer)
                    throws Exception

Throws:

Exception

sendChannelOpenFailure

protected IoWriteFuture sendChannelOpenFailure(Buffer buffer,
 long sender,
 int reasonCode,
 String message,
 String lang)
                                        throws IOException

Throws:

IOException

globalRequest

protected IoWriteFuture globalRequest(Buffer buffer)
                               throws Exception

Process global requests

Parameters:

buffer - The request Buffer

Returns:

An IoWriteFuture representing the sent packet - Note: if no reply sent then an "empty" future is returned - i.e., any added listeners are triggered immediately with a synthetic "success"

Throws:

Exception - If failed to process the request

handleUnknownRequest

protected IoWriteFuture handleUnknownRequest(Buffer buffer,
 String req,
 boolean wantReply)
                                      throws IOException

Throws:

IOException

sendGlobalResponse

protected IoWriteFuture sendGlobalResponse(Buffer buffer,
 String req,
 RequestHandler.Result result,
 boolean wantReply)
                                    throws IOException

Throws:

IOException

requestSuccess

protected void requestSuccess(Buffer buffer)
                       throws Exception

Throws:

Exception

requestFailure

protected void requestFailure(Buffer buffer)
                       throws Exception

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object