org.apache.sshd.client.session

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:

java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.Channel, ClientSessionHolder, PortForwardingEventListenerManager, PortForwardingEventListenerManagerHolder, PropertyResolver, Service, ConnectionService, SessionContextHolder, SessionHeartbeatController, SessionHolder<Session>, UnknownChannelReferenceHandlerManager

public class ClientConnectionService
extends AbstractConnectionService
implements ClientSessionHolder

Client side ssh-connection service.

Nested Class Summary

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

AbstractCloseable.State

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

SessionHeartbeatController.HeartbeatType

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.ScheduledFuture<?>	clientHeartbeat Non-null only if using the "keep-alive" request mechanism
protected long	heartbeatInterval
protected long	heartbeatReplyMaxWait
protected java.lang.String	heartbeatRequest

Fields inherited from class org.apache.sshd.common.session.helpers.AbstractConnectionService

channels, DEFAULT_MAX_CHANNELS, DEFAULT_SESSION_IGNORE_HEARTBEAT_STRING, heartbeatCount, MAX_CONCURRENT_CHANNELS_PROP, 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.Closeable

CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT

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

DEFAULT_CONNECTION_HEARTBEAT_INTERVAL, SESSION_HEARTBEAT_INTERVAL, SESSION_HEARTBEAT_TYPE

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
ClientConnectionService(AbstractClientSession s)

Method Summary

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

Methods inherited from class org.apache.sshd.common.session.helpers.AbstractConnectionService

addPortForwardingEventListener, addPortForwardingEventListenerManager, channelClose, channelData, channelEof, channelExtendedData, channelFailure, channelOpen, channelOpenConfirmation, channelOpenFailure, channelRequest, channelSuccess, channelWindowAdjust, createAgentForwardSupport, createForwardingFilter, createX11ForwardSupport, futureDone, getChannel, getChannel, getChannels, getForwardingFilter, getInnerCloseable, getNextChannelId, getPortForwardingEventListenerProxy, getProperties, getRegisteredManagers, getUnknownChannelReferenceHandler, globalRequest, handleChannelRegistrationFailure, handleUnknownRequest, isAllowMoreSessions, preClose, process, registerChannel, removePortForwardingEventListener, removePortForwardingEventListenerManager, 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

getSimplifiedLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getParentPropertyResolver

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

getSessionContext

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.session.SessionHeartbeatController

disableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, setSessionHeartbeat, setSessionHeartbeat

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

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

Field Detail

heartbeatRequest

protected final java.lang.String heartbeatRequest

heartbeatInterval

protected final long heartbeatInterval

heartbeatReplyMaxWait

protected final long heartbeatReplyMaxWait

clientHeartbeat

protected java.util.concurrent.ScheduledFuture<?> clientHeartbeat

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

Constructor Detail

ClientConnectionService

public ClientConnectionService(AbstractClientSession s)
                        throws SshException

Throws:

SshException

Method Detail

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 java.util.concurrent.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