Class ClientConnectionService

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

org.apache.sshd.client.session.ClientConnectionService

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, EventListener, ClientSessionHolder, org.apache.sshd.common.Closeable, PortForwardingEventListenerManager, PortForwardingEventListenerManagerHolder, org.apache.sshd.common.PropertyResolver, Service, ConnectionService, ReservedSessionMessagesHandler, org.apache.sshd.common.session.SessionContextHolder, org.apache.sshd.common.session.SessionHeartbeatController, SessionHolder<Session>, UnknownChannelReferenceHandlerManager, org.apache.sshd.common.util.SshdEventListener

public class ClientConnectionService
extends AbstractConnectionService
implements ClientSessionHolder

Client side ssh-connection service.

Author:

Apache MINA SSHD Project

Nested Class Summary

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

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

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

org.apache.sshd.common.session.SessionHeartbeatController.HeartbeatType

Field Summary

Fields

Modifier and Type	Field	Description
protected ScheduledFuture<?>	clientHeartbeat	Non-null only if using the "keep-alive" request mechanism
protected final Duration	heartbeatInterval
protected final int	heartbeatMaxNoReply
protected final String	heartbeatRequest
protected final AtomicInteger	outstandingHeartbeats

Fields inherited from class AbstractConnectionService

channels, DEFAULT_SESSION_IGNORE_HEARTBEAT_STRING, heartbeatCount, nextChannelId, RESPONSE_BUFFER_GROWTH_FACTOR

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

Constructor	Description
ClientConnectionService(AbstractClientSession s)

Method Summary

Modifier and Type	Method	Description
AgentForwardSupport	getAgentForwardSupport()
final ClientSession	getClientSession()
AbstractClientSession	getSession()
X11ForwardSupport	getX11ForwardSupport()
protected boolean	sendHeartBeat()	Sends a heartbeat message/packet
void	start()
protected ScheduledFuture<?>	startHeartBeat()
protected void	stopHeartBeat()

Methods inherited from class AbstractConnectionService

addPortForwardingEventListener, addPortForwardingEventListenerManager, channelClose, channelData, channelEof, channelExtendedData, channelFailure, channelOpen, channelOpenConfirmation, channelOpenFailure, channelRequest, channelSuccess, channelWindowAdjust, createAgentForwardSupport, createForwardingFilter, createX11ForwardSupport, futureDone, getChannel, getChannel, getChannels, getForwarder, getInnerCloseable, getNextChannelId, getPortForwardingEventListenerProxy, getProperties, getRegisteredManagers, getUnknownChannelReferenceHandler, globalRequest, handleUnimplementedMessage, handleUnknownRequest, isAllowMoreSessions, preClose, process, registerChannel, removePortForwardingEventListener, removePortForwardingEventListenerManager, request, request, requestFailure, requestSuccess, resolveUnknownChannelReferenceHandler, sendChannelOpenFailure, sendGlobalResponse, setAllowMoreSessions, setUnknownChannelReferenceHandler, toString, unregisterChannel

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 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 ConnectionService

request, request

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

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

Methods inherited from interface ReservedSessionMessagesHandler

handleDebugMessage, handleIgnoreMessage, sendIdentification, sendKexInitRequest, sendReservedHeartbeat

Methods inherited from interface Service

getParentPropertyResolver

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

disableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, setSessionHeartbeat, setSessionHeartbeat

Methods inherited from interface SessionHolder

getSessionContext

Field Details

heartbeatRequest

protected final String heartbeatRequest

heartbeatInterval

protected final Duration heartbeatInterval

heartbeatMaxNoReply

protected final int heartbeatMaxNoReply

outstandingHeartbeats

protected final AtomicInteger outstandingHeartbeats

clientHeartbeat

protected ScheduledFuture<?> clientHeartbeat

Non-null only if using the "keep-alive" request mechanism

Constructor Details

ClientConnectionService

public ClientConnectionService(AbstractClientSession s)
                        throws org.apache.sshd.common.SshException

Throws:

org.apache.sshd.common.SshException

Method Details

getClientSession

public final ClientSession getClientSession()

Specified by:

getClientSession in interface ClientSessionHolder

Returns:

The underlying ClientSession used

getSession

public AbstractClientSession getSession()

Specified by:

getSession in interface SessionHolder<Session>

Overrides:

getSession in class AbstractConnectionService

start

public void start()

Specified by:

start in interface Service

Overrides:

start in class AbstractConnectionService

startHeartBeat

protected ScheduledFuture<?> startHeartBeat()

Overrides:

startHeartBeat in class AbstractConnectionService

stopHeartBeat

protected void stopHeartBeat()

Overrides:

stopHeartBeat in class AbstractConnectionService

sendHeartBeat

protected boolean sendHeartBeat()

Description copied from class: AbstractConnectionService

Sends a heartbeat message/packet

Overrides:

sendHeartBeat in class AbstractConnectionService

Returns:

true if heartbeat successfully sent

getAgentForwardSupport

public AgentForwardSupport getAgentForwardSupport()

Specified by:

getAgentForwardSupport in interface ConnectionService

Overrides:

getAgentForwardSupport in class AbstractConnectionService

getX11ForwardSupport

public X11ForwardSupport getX11ForwardSupport()

Specified by:

getX11ForwardSupport in interface ConnectionService

Overrides:

getX11ForwardSupport in class AbstractConnectionService