Interface ConnectionService

All Superinterfaces:

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

All Known Implementing Classes:

AbstractConnectionService, ClientConnectionService, ServerConnectionService

public interface ConnectionService
extends Service, SessionHeartbeatController, UnknownChannelReferenceHandlerManager, PortForwardingEventListenerManager, PortForwardingEventListenerManagerHolder

Interface implementing ssh-connection service.

Nested Class Summary

Nested classes/interfaces inherited from interface SessionHeartbeatController

SessionHeartbeatController.HeartbeatType

Field Summary

Fields inherited from interface PropertyResolver

EMPTY

Method Summary

Modifier and Type	Method	Description
AgentForwardSupport	getAgentForwardSupport()
Forwarder	getForwarder()	Retrieve the forwarder instance
X11ForwardSupport	getX11ForwardSupport()
boolean	isAllowMoreSessions()
long	registerChannel(Channel channel)	Register a newly created channel with a new unique identifier
void	setAllowMoreSessions(boolean allow)
void	unregisterChannel(Channel channel)	Remove this channel from the list of managed channels

Methods inherited from interface Closeable

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

Methods inherited from interface PortForwardingEventListenerManager

addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

Methods inherited from interface PortForwardingEventListenerManagerHolder

addPortForwardingEventListenerManager, getRegisteredManagers, removePortForwardingEventListenerManager

Methods inherited from interface PropertyResolver

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

Methods inherited from interface Service

getParentPropertyResolver, process, start

Methods inherited from interface SessionHeartbeatController

disableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, setSessionHeartbeat, setSessionHeartbeat

Methods inherited from interface SessionHolder

getSession, getSessionContext

Methods inherited from interface UnknownChannelReferenceHandlerManager

getUnknownChannelReferenceHandler, resolveUnknownChannelReferenceHandler, setUnknownChannelReferenceHandler

Method Details

registerChannel

long registerChannel(Channel channel)
              throws IOException

Register a newly created channel with a new unique identifier

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

void unregisterChannel(Channel channel)

Remove this channel from the list of managed channels

Parameters:

channel - The Channel instance

getForwarder

Forwarder getForwarder()

Retrieve the forwarder instance

Returns:

The Forwarder

getAgentForwardSupport

AgentForwardSupport getAgentForwardSupport()

getX11ForwardSupport

X11ForwardSupport getX11ForwardSupport()

isAllowMoreSessions

boolean isAllowMoreSessions()

setAllowMoreSessions

void setAllowMoreSessions(boolean allow)