org.apache.sshd.common.session

Interface ConnectionService

All Superinterfaces:

AutoCloseable, Channel, Closeable, PortForwardingEventListenerManager, PortForwardingEventListenerManagerHolder, Service

All Known Implementing Classes:

AbstractConnectionService, ClientConnectionService, ServerConnectionService

public interface ConnectionService
extends Service, PortForwardingEventListenerManager, PortForwardingEventListenerManagerHolder

Interface implementing ssh-connection service.

Author:

Apache MINA SSHD Project

Field Summary

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

CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT

Method Summary

Modifier and Type	Method and Description
AgentForwardSupport	getAgentForwardSupport()
TcpipForwarder	getTcpipForwarder() Retrieve the tcpip forwarder
X11ForwardSupport	getX11ForwardSupport()
boolean	isAllowMoreSessions()
int	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 org.apache.sshd.common.Service

getSession, process, start

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

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

Methods inherited from interface org.apache.sshd.common.forward.PortForwardingEventListenerManager

addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

Methods inherited from interface org.apache.sshd.common.forward.PortForwardingEventListenerManagerHolder

addPortForwardingEventListenerManager, getRegisteredManagers, removePortForwardingEventListenerManager

Method Detail

registerChannel

int 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

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

getTcpipForwarder

TcpipForwarder getTcpipForwarder()

Retrieve the tcpip forwarder

Returns:

The TcpipForwarder

getAgentForwardSupport

AgentForwardSupport getAgentForwardSupport()

getX11ForwardSupport

X11ForwardSupport getX11ForwardSupport()

isAllowMoreSessions

boolean isAllowMoreSessions()

setAllowMoreSessions

void setAllowMoreSessions(boolean allow)