Top Description Methods
org.apache.sshd.common.session

public Interface ConnectionService

extends Service, SessionHeartbeatController, UnknownChannelReferenceHandlerManager, PortForwardingEventListenerManager, PortForwardingEventListenerManagerHolder
Known Direct Implementers
org.apache.sshd.common.session.helpers.AbstractConnectionService
Imports
java.io.IOException, org.apache.sshd.agent.common.AgentForwardSupport, org.apache.sshd.common.Service, org.apache.sshd.common.channel.Channel, org.apache.sshd.common.forward.Forwarder, .PortForwardingEventListenerManager, .PortForwardingEventListenerManagerHolder, org.apache.sshd.server.x11.X11ForwardSupport
Interface implementing ssh-connection service.
Author
Apache MINA SSHD Project

Method Summary

Modifier and TypeMethod and Description
public AgentForwardSupport
getAgentForwardSupport()

public Forwarder

Returns:

The Forwarder
getForwarder()

Retrieve the forwarder instance

public X11ForwardSupport
getX11ForwardSupport()

public boolean
isAllowMoreSessions()

public long

Returns:

The assigned id of this channel - a UINT32 represented as a long
registerChannel(Channel
The Channel to register
channel)

Register a newly created channel with a new unique identifier

public void
setAllowMoreSessions(boolean allow)

public void
unregisterChannel(Channel
The Channel instance
channel)

Remove this channel from the list of managed channels

Inherited from org.apache.sshd.common.forward.PortForwardingEventListenerManager:
addPortForwardingEventListenergetPortForwardingEventListenerProxyremovePortForwardingEventListener
Inherited from org.apache.sshd.common.forward.PortForwardingEventListenerManagerHolder:
addPortForwardingEventListenerManagergetRegisteredManagersremovePortForwardingEventListenerManager
Inherited from org.apache.sshd.common.Service:
getParentPropertyResolverprocessstart
Inherited from org.apache.sshd.common.session.SessionHeartbeatController:
disableSessionHeartbeatgetSessionHeartbeatIntervalgetSessionHeartbeatTypesetSessionHeartbeatsetSessionHeartbeat
Inherited from org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager:
getUnknownChannelReferenceHandlerresolveUnknownChannelReferenceHandlersetUnknownChannelReferenceHandler

Method Detail

getAgentForwardSupportback to summary
public AgentForwardSupport getAgentForwardSupport()
getForwarderback to summary
public Forwarder getForwarder()

Retrieve the forwarder instance

Returns:Forwarder

The Forwarder

getX11ForwardSupportback to summary
public X11ForwardSupport getX11ForwardSupport()
isAllowMoreSessionsback to summary
public boolean isAllowMoreSessions()
registerChannelback to summary
public long registerChannel(Channel channel) throws IOException

Register a newly created channel with a new unique identifier

Parameters
channel:Channel

The Channel to register

Returns:long

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

Exceptions
IOException:
If failed to initialize and register the channel
setAllowMoreSessionsback to summary
public void setAllowMoreSessions(boolean allow)
unregisterChannelback to summary
public void unregisterChannel(Channel channel)

Remove this channel from the list of managed channels

Parameters
channel:Channel

The Channel instance