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:

Closeable, AutoCloseable, Channel, ClientSessionHolder, PortForwardingEventListenerManager, PortForwardingEventListenerManagerHolder, Service, ConnectionService, UnknownChannelReferenceHandlerManager

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

AbstractCloseable.State

Field Summary

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

channels, DEFAULT_MAX_CHANNELS, MAX_CONCURRENT_CHANNELS_PROP, nextChannelId, RESPONSE_BUFFER_GROWTH_FACTOR

Fields inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

closeFuture, lock, 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

Constructor Summary

Constructors

Constructor and Description
ClientConnectionService(AbstractClientSession s)

Method Summary

Modifier and Type	Method and Description
protected void	futureDone(IoWriteFuture future)
AgentForwardSupport	getAgentForwardSupport()
ClientSession	getClientSession()
AbstractClientSession	getSession()
X11ForwardSupport	getX11ForwardSupport()
protected void	preClose() preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately.
protected IoWriteFuture	sendHeartBeat() Sends a heartbeat message
void	start()
protected void	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, getChannel, getChannel, getChannels, getForwardingFilter, getInnerCloseable, getNextChannelId, getPortForwardingEventListenerProxy, getRegisteredManagers, getUnknownChannelReferenceHandler, globalRequest, handleChannelRegistrationFailure, handleUnknownRequest, isAllowMoreSessions, 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, 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.Closeable

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

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 Service

Overrides:

getSession in class AbstractConnectionService

start

public void start()

Specified by:

start in interface Service

Overrides:

start in class AbstractConnectionService

preClose

protected void preClose()

Description copied from class: AbstractCloseable

preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately. When preClose() is called, isClosing() == true

Overrides:

preClose in class AbstractConnectionService

startHeartBeat

protected void startHeartBeat()

stopHeartBeat

protected void stopHeartBeat()

sendHeartBeat

protected IoWriteFuture sendHeartBeat()

Sends a heartbeat message

Returns:

The IoWriteFuture that can be used to wait for the message write completion

futureDone

protected void futureDone(IoWriteFuture future)

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