Package org.apache.sshd.common.session
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.
- Author:
- Apache MINA SSHD Project
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.sshd.common.session.SessionHeartbeatController
SessionHeartbeatController.HeartbeatType
-
Field Summary
Fields inherited from interface org.apache.sshd.common.PropertyResolver
EMPTY
-
Method Summary
Modifier and TypeMethodDescriptionRetrieve the forwarder instanceboolean
long
registerChannel
(Channel channel) Register a newly created channel with a new unique identifiervoid
setAllowMoreSessions
(boolean allow) void
unregisterChannel
(Channel channel) Remove this channel from the list of managed channelsMethods inherited from interface org.apache.sshd.common.Closeable
addCloseFutureListener, close, close, 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
Methods inherited from interface org.apache.sshd.common.PropertyResolver
getBoolean, getBooleanProperty, getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getProperties, getString, getStringProperty, isEmpty
Methods inherited from interface org.apache.sshd.common.Service
getParentPropertyResolver, process, start
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
getSession, getSessionContext
Methods inherited from interface org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager
getUnknownChannelReferenceHandler, resolveUnknownChannelReferenceHandler, setUnknownChannelReferenceHandler
-
Method Details
-
registerChannel
Register a newly created channel with a new unique identifier- Parameters:
channel
- TheChannel
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
Remove this channel from the list of managed channels- Parameters:
channel
- TheChannel
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)
-