Class ClientSessionImpl

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.kex.AbstractKexFactoryManager

org.apache.sshd.common.session.helpers.SessionHelper

org.apache.sshd.common.session.helpers.AbstractSession

org.apache.sshd.client.session.AbstractClientSession

org.apache.sshd.client.session.ClientSessionImpl

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ClientAuthenticationManager, ClientProxyConnectorHolder, ClientSession, AttributeRepository, AttributeStore, MutableUserHolder, UserAuthFactoriesManager<ClientSession, UserAuth, UserAuthFactory>, UsernameHolder, ChannelListenerManager, ChannelStreamWriterResolver, ChannelStreamWriterResolverManager, Closeable, FactoryManagerHolder, PortForwardingEventListenerManager, PortForwardingInformationProvider, PortForwardingManager, KexExtensionHandlerManager, KexFactoryManager, KeyIdentityProviderHolder, PropertyResolver, ReservedSessionMessagesManager, Session, SessionContext, SessionDisconnectHandlerManager, SessionHeartbeatController, SessionListenerManager, UnknownChannelReferenceHandlerManager, SignatureFactoriesHolder, SignatureFactoriesManager, ConnectionEndpointsIndicator

public class ClientSessionImpl
extends AbstractClientSession

The default implementation of a ClientSession

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ClientSessionImpl.Services	Encapsulates and protects against concurrent access the service switching.

Nested classes/interfaces inherited from class AbstractSession

AbstractSession.MessageCodingSettings

Nested classes/interfaces inherited from class AbstractCloseable

AbstractCloseable.State

Nested classes/interfaces inherited from interface AttributeRepository

AttributeRepository.AttributeKey<T>

Nested classes/interfaces inherited from interface ClientSession

ClientSession.ClientSessionEvent

Nested classes/interfaces inherited from interface SessionHeartbeatController

SessionHeartbeatController.HeartbeatType

Field Summary

Fields

Modifier and Type	Field	Description
private final AtomicReference<Throwable>	authErrorHolder	Also guards setting an earlyError and the authFuture together.
private AuthFuture	authFuture	The authentication future created by the last call to auth(); null before the first call to auth().
private final AtomicReference<Throwable>	beforeAuthErrorHolder
private final AtomicBoolean	initialServiceRequestSent
private Map<Object,Object>	metadataMap	For clients to store their own metadata

Fields inherited from class AbstractClientSession

sendImmediateClientIdentification, sendImmediateKexInit

Fields inherited from class AbstractSession

channelListenerProxy, channelListeners, clientProposal, clientVersion, currentService, decodeLock, decoderBuffer, decoderLength, decoderState, discarding, encodeLock, firstKexPacketFollows, ignorePacketDataLength, ignorePacketsCount, ignorePacketsFrequency, ignorePacketsVariance, inBlocksCount, inBytesCount, inCipher, inCipherSize, inCompression, initialKexDone, initialKexInitSequenceNumber, inMac, inMacResult, inMacSize, inPacketsCount, inSettings, kex, kexFutureHolder, kexHandler, kexInitializedFuture, kexState, lastKeyTimeValue, maxRekeyBlocks, maxRekeyBytes, maxRekeyInterval, maxRekyPackets, negotiationResult, outBlocksCount, outBytesCount, outCipher, outCipherSize, outCompression, outMac, outMacSize, outPacketsCount, outSettings, random, requestLock, seqi, seqo, serverProposal, serverVersion, SESSION, sessionId, sessionListenerProxy, sessionListeners, strictKex, tunnelListenerProxy, tunnelListeners, uncompressBuffer, unmodClientProposal, unmodNegotiationResult, unmodServerProposal

Fields inherited from class SessionHelper

authStart, idleStart, initialKexProposal

Fields inherited from class AbstractCloseable

closeFuture, futureLock, state

Fields inherited from class AbstractLoggingBean

log

Fields inherited from interface ChannelStreamWriterResolver

NONE

Fields inherited from interface ClientSession

REMOTE_COMMAND_WAIT_EVENTS

Fields inherited from interface PropertyResolver

EMPTY

Fields inherited from interface SessionContext

DEFAULT_SSH_VERSION_PREFIX, FALLBACK_SSH_VERSION_PREFIX, MAX_VERSION_LINE_LENGTH

Constructor Summary

Constructors

Constructor	Description
ClientSessionImpl(ClientFactoryManager client, IoSession ioSession)

Method Summary

Modifier and Type	Method	Description
AuthFuture	auth()	Starts the authentication process.
void	exceptionCaught(Throwable t)	Handle any exceptions that occurred on this session.
private ClientSessionImpl.Services	getCurrentServices()
Map<Object,Object>	getMetadataMap()	Access to the metadata.
protected List<Service>	getServices()
Set<ClientSession.ClientSessionEvent>	getSessionState()
protected void	handleDisconnect(int code, String msg, String lang, Buffer buffer)
protected CurrentService	initializeCurrentService()	Creates a new CurrentService instance managing this session's current SSH service.
protected String	nextServiceName()
protected void	preClose()	preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately.
protected void	sendInitialServiceRequest()
protected void	signalAuthFailure(Throwable t)
protected void	signalSessionEvent(SessionListener.Event event)	Sends a session event to all currently registered session listeners
void	start()	Starts the SSH protocol.
void	switchToNextService()
protected <C extends Collection<ClientSession.ClientSessionEvent>> C	updateCurrentSessionState(C state)
Set<ClientSession.ClientSessionEvent>	waitFor(Collection<ClientSession.ClientSessionEvent> mask, long timeout)	Wait for any one of a specific state to be signaled.

Methods inherited from class AbstractClientSession

addPasswordIdentity, addPublicKeyIdentity, checkKeys, createChannel, createChannel, createDirectTcpipChannel, createExecChannel, createExecChannel, createShellChannel, createSubsystemChannel, getClientProxyConnector, getConnectAddress, getConnectionContext, getConnectionService, getFactoryManager, getForwarder, getHostBasedAuthenticationReporter, getKeyIdentityProvider, getPasswordAuthenticationReporter, getPasswordIdentityProvider, getPublicKeyAuthenticationReporter, getRegisteredIdentities, getServerKey, getServerKeyVerifier, getUserAuthFactories, getUserAuthService, getUserInteraction, initializeKeyExchangePhase, initializeProxyConnector, readIdentification, receiveKexInit, receiveKexInit, removePasswordIdentity, removePublicKeyIdentity, resolveAvailableSignaturesProposal, sendClientIdentification, sendKexInit, setClientProxyConnector, setConnectAddress, setHostBasedAuthenticationReporter, setKexSeed, setKeyIdentityProvider, setPasswordAuthenticationReporter, setPasswordIdentityProvider, setPublicKeyAuthenticationReporter, setServerKey, setServerKeyVerifier, setUserAuthFactories, setUserInteraction, signalExtraServerVersionInfo, startDynamicPortForwarding, startLocalPortForwarding, startRemotePortForwarding, startService, stopDynamicPortForwarding, stopLocalPortForwarding, stopRemotePortForwarding, switchToNoneCipher

Methods inherited from class AbstractSession

addChannelListener, addPortForwardingEventListener, addSessionListener, aeadOutgoingBuffer, appendOutgoingMac, attachSession, calculatePadLength, checkRekey, comparePreferredKexProposalOption, createBuffer, decode, determineRekeyBlockLimit, doHandleMessage, doInvokeUnimplementedMessageHandler, doKexNegotiation, doStrictKexProposal, doWritePacket, encode, encryptOutgoingBuffer, failStrictKex, getChannelListenerProxy, getCipherInformation, getClientKexData, getClientKexProposals, getClientVersion, getCompressionInformation, getInnerCloseable, getKex, getKexNegotiationResult, getKexState, getMacInformation, getNegotiatedKexParameter, getPortForwardingEventListenerProxy, getServerKexData, getServerKexProposals, getServerVersion, getService, getSession, getSession, getSessionId, getSessionListenerProxy, handleFirstKexPacketFollows, handleKexExtension, handleKexInit, handleKexMessage, handleMessage, handleNewCompression, handleNewKeys, handleServiceAccept, handleServiceAccept, handleServiceRequest, handleServiceRequest, initializeKeyExchangeMessageHandler, isRekeyBlocksCountExceeded, isRekeyDataSizeExceeded, isRekeyPacketCountsExceeded, isRekeyRequired, isRekeyTimeIntervalExceeded, messageReceived, negotiate, notImplemented, performKexNegotiation, prepareBuffer, prepareNewKeys, preProcessEncodeBuffer, receiveKexInit, reExchangeKeys, refreshConfiguration, removeChannelListener, removePortForwardingEventListener, removeSessionListener, removeValue, request, request, requestFailure, requestNewKeysExchange, requestSuccess, resolveIgnoreBufferDataLength, resolveOutputPacket, resolveSessionKexProposal, sendKexInit, sendNewKeys, setClientKexData, setInputEncoding, setNegotiationResult, setOutputEncoding, setServerKexData, validateIncomingMac, validateKexState, validateServiceKexState, validateTargetBuffer, writePacket, writePacket

Methods inherited from class SessionHelper

attributeKeys, calculateNextIgnorePacketCount, checkAuthenticationTimeout, checkForTimeouts, checkIdleTimeout, clearAttributes, computeAttributeIfAbsent, createProposal, disconnect, doInvokeDebugMessageHandler, doInvokeIgnoreMessageHandler, doReadIdentification, getAttribute, getAttributesCount, getAuthTimeout, getAuthTimeoutStart, getBoundLocalPortForwards, getBoundRemotePortForward, getChannelStreamWriterResolver, getIdleTimeout, getIdleTimeoutStart, getIoSession, getKexProposal, getLocalForwardsBindings, getParentPropertyResolver, getProperties, getRemoteForwardsBindings, getReservedSessionMessagesHandler, getSessionDisconnectHandler, getStartedLocalPortForwards, getStartedRemotePortForwards, getTimeoutStatus, getUnknownChannelReferenceHandler, getUsername, handleDebug, handleDisconnect, handleIgnore, handleUnimplemented, invokeSessionSignaller, isAuthenticated, isLocalPortForwardingStartedForPort, isRemotePortForwardingStartedForPort, isServerSession, mergeProposals, removeAttribute, resetAuthTimeout, resetIdleTimeout, resizeKey, resolveAvailableSignaturesProposal, resolveChannelStreamWriterResolver, resolveIdentificationString, resolvePeerAddress, resolveReservedSessionMessagesHandler, resolveUnknownChannelReferenceHandler, sendDebugMessage, sendIdentification, sendIgnoreMessage, sendNotImplemented, setAttribute, setAuthenticated, setChannelStreamWriterResolver, setReservedSessionMessagesHandler, setSessionDisconnectHandler, setUnknownChannelReferenceHandler, setUsername, signalDisconnect, signalDisconnect, signalExceptionCaught, signalExceptionCaught, signalNegotiationEnd, signalNegotiationEnd, signalNegotiationOptionsCreated, signalNegotiationOptionsCreated, signalNegotiationStart, signalNegotiationStart, signalPeerIdentificationReceived, signalPeerIdentificationReceived, signalReadPeerIdentificationLine, signalReadPeerIdentificationLine, signalSendIdentification, signalSendIdentification, signalSessionClosed, signalSessionClosed, signalSessionCreated, signalSessionCreated, signalSessionEstablished, signalSessionEstablished, signalSessionEvent, toString

Methods inherited from class AbstractKexFactoryManager

getCipherFactories, getCompressionFactories, getDelegate, getKexExtensionHandler, getKeyExchangeFactories, getMacFactories, getSignatureFactories, resolveEffectiveFactories, resolveEffectiveProvider, setCipherFactories, setCompressionFactories, setKexExtensionHandler, setKeyExchangeFactories, setMacFactories, setSignatureFactories

Methods inherited from class AbstractInnerCloseable

doCloseGracefully, doCloseImmediately

Methods inherited from class AbstractCloseable

addCloseFutureListener, builder, close, getFutureLock, isClosed, isClosing, removeCloseFutureListener

Methods inherited from class 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 AttributeRepository

attributeKeys, getAttribute, getAttributesCount

Methods inherited from interface AttributeStore

clearAttributes, computeAttributeIfAbsent, removeAttribute, setAttribute

Methods inherited from interface ChannelListenerManager

addChannelListener, getChannelListenerProxy, removeChannelListener

Methods inherited from interface ChannelStreamWriterResolverManager

getChannelStreamWriterResolver, resolveChannelStreamWriter, resolveChannelStreamWriterResolver, setChannelStreamWriterResolver

Methods inherited from interface ClientAuthenticationManager

setUserAuthFactoriesNames

Methods inherited from interface ClientSession

createDynamicPortForwardingTracker, createExecChannel, createExecChannel, createLocalPortForwardingTracker, createLocalPortForwardingTracker, createRemotePortForwardingTracker, createShellChannel, executeRemoteCommand, executeRemoteCommand, executeRemoteCommand, executeRemoteCommand, executeRemoteCommand, executeRemoteCommand, waitFor

Methods inherited from interface Closeable

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

Methods inherited from interface KexExtensionHandlerManager

getKexExtensionHandler, setKexExtensionHandler

Methods inherited from interface KexFactoryManager

getCipherFactories, getCipherFactoriesNameList, getCipherFactoriesNames, getCompressionFactories, getCompressionFactoriesNameList, getCompressionFactoriesNames, getKeyExchangeFactories, getMacFactories, getMacFactoriesNameList, getMacFactoriesNames, setCipherFactories, setCipherFactoriesNameList, setCipherFactoriesNames, setCipherFactoriesNames, setCompressionFactories, setCompressionFactoriesNameList, setCompressionFactoriesNames, setCompressionFactoriesNames, setKeyExchangeFactories, setMacFactories, setMacFactoriesNameList, setMacFactoriesNames, setMacFactoriesNames

Methods inherited from interface MutableUserHolder

setUsername

Methods inherited from interface PortForwardingEventListenerManager

addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

Methods inherited from interface PortForwardingInformationProvider

getBoundLocalPortForwards, getBoundRemotePortForward, getLocalForwardsBindings, getRemoteForwardsBindings, getStartedLocalPortForwards, getStartedRemotePortForwards, isLocalPortForwardingStartedForPort, isRemotePortForwardingStartedForPort

Methods inherited from interface PortForwardingManager

startLocalPortForwarding

Methods inherited from interface PropertyResolver

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

Methods inherited from interface ReservedSessionMessagesManager

getReservedSessionMessagesHandler, setReservedSessionMessagesHandler

Methods inherited from interface Session

createBuffer, createBuffer, disconnect, getAuthTimeout, getAuthTimeoutStart, getIdleTimeout, getIdleTimeoutStart, getIoSession, getKex, getLocalAddress, getRemoteAddress, getService, getTimeoutStatus, prepareBuffer, reExchangeKeys, request, request, request, request, resetAuthTimeout, resetIdleTimeout, resolveAttribute, sendDebugMessage, sendIgnoreMessage, setAuthenticated, writePacket, writePacket, writePacket, writePacket

Methods inherited from interface SessionContext

getCipherInformation, getClientKexProposals, getClientVersion, getCompressionInformation, getKexNegotiationResult, getKexState, getMacInformation, getNegotiatedKexParameter, getServerKexProposals, getServerVersion, getSessionId, isAuthenticated, isServerSession

Methods inherited from interface SessionDisconnectHandlerManager

getSessionDisconnectHandler, setSessionDisconnectHandler

Methods inherited from interface SessionHeartbeatController

disableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, setSessionHeartbeat, setSessionHeartbeat

Methods inherited from interface SessionListenerManager

addSessionListener, getSessionListenerProxy, removeSessionListener

Methods inherited from interface SignatureFactoriesHolder

getSignatureFactories, getSignatureFactoriesNameList, getSignatureFactoriesNames

Methods inherited from interface SignatureFactoriesManager

setSignatureFactories, setSignatureFactoriesNameList, setSignatureFactoriesNames, setSignatureFactoriesNames

Methods inherited from interface UnknownChannelReferenceHandlerManager

getUnknownChannelReferenceHandler, resolveUnknownChannelReferenceHandler, setUnknownChannelReferenceHandler

Methods inherited from interface UserAuthFactoriesManager

getUserAuthFactoriesNameList, getUserAuthFactoriesNames, setUserAuthFactoriesNameList, setUserAuthFactoriesNames

Methods inherited from interface UsernameHolder

getUsername

Field Details

authFuture

private volatile AuthFuture authFuture

The authentication future created by the last call to auth(); null before the first call to auth(). Volatile because of unsynchronized access in updateCurrentSessionState(Collection).

beforeAuthErrorHolder

private final AtomicReference<Throwable> beforeAuthErrorHolder

authErrorHolder

private final AtomicReference<Throwable> authErrorHolder

Also guards setting an earlyError and the authFuture together.

initialServiceRequestSent

private final AtomicBoolean initialServiceRequestSent

metadataMap

private Map<Object,Object> metadataMap

For clients to store their own metadata

Constructor Details

ClientSessionImpl

public ClientSessionImpl(ClientFactoryManager client,
 IoSession ioSession)
                  throws Exception

Throws:

Exception

Method Details

start

public void start()
           throws Exception

Description copied from class: AbstractSession

Starts the SSH protocol. Invoked by the framework after the session object was fully created, and after SessionListener.sessionCreated(org.apache.sshd.common.session.Session) has been invoked.

Specified by:

start in class AbstractSession

Throws:

Exception - on errors

initializeCurrentService

protected CurrentService initializeCurrentService()

Description copied from class: AbstractSession

Creates a new CurrentService instance managing this session's current SSH service.

This initialization method is invoked once from the AbstractSession constructor. Do not rely on subclass fields being initialized.

Overrides:

initializeCurrentService in class AbstractSession

Returns:

a new CurrentService instance for the session

getCurrentServices

private ClientSessionImpl.Services getCurrentServices()

getServices

protected List<Service> getServices()

Overrides:

getServices in class AbstractSession

auth

public AuthFuture auth()
                throws IOException

Description copied from interface: ClientSession

Starts the authentication process. User identities will be tried until the server successfully authenticate the user. User identities must be provided before calling this method using ClientAuthenticationManager.addPasswordIdentity(String) or ClientAuthenticationManager.addPublicKeyIdentity(java.security.KeyPair).

Returns:

the authentication future

Throws:

IOException - if failed to generate the future

See Also:

• ClientAuthenticationManager.addPasswordIdentity(String)
• ClientAuthenticationManager.addPublicKeyIdentity(java.security.KeyPair)

exceptionCaught

public void exceptionCaught(Throwable t)

Description copied from class: SessionHelper

Handle any exceptions that occurred on this session. The session will be closed and a disconnect packet will be sent before if the given exception is an SshException.

Specified by:

exceptionCaught in interface Session

Overrides:

exceptionCaught in class SessionHelper

Parameters:

t - the exception to process

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 AbstractSession

handleDisconnect

protected void handleDisconnect(int code,
 String msg,
 String lang,
 Buffer buffer)
                         throws Exception

Overrides:

handleDisconnect in class SessionHelper

Throws:

Exception

signalAuthFailure

protected void signalAuthFailure(Throwable t)

nextServiceName

protected String nextServiceName()

switchToNextService

public void switchToNextService()
                         throws IOException

Throws:

IOException

signalSessionEvent

protected void signalSessionEvent(SessionListener.Event event)
                           throws Exception

Description copied from class: SessionHelper

Sends a session event to all currently registered session listeners

Overrides:

signalSessionEvent in class SessionHelper

Parameters:

event - The event to send

Throws:

Exception - If any of the registered listeners threw an exception.

sendInitialServiceRequest

protected void sendInitialServiceRequest()
                                  throws IOException

Throws:

IOException

waitFor

public Set<ClientSession.ClientSessionEvent> waitFor(Collection<ClientSession.ClientSessionEvent> mask,
 long timeout)

Description copied from interface: ClientSession

Wait for any one of a specific state to be signaled.

Parameters:

mask - The request ClientSession.ClientSessionEvents mask

timeout - Wait time in milliseconds - non-positive means forever

Returns:

The actual state that was detected either due to the mask yielding one of the states or due to timeout (in which case the ClientSession.ClientSessionEvent.TIMEOUT value is set)

getSessionState

public Set<ClientSession.ClientSessionEvent> getSessionState()

Returns:

A snapshot of the current session state

See Also:

• ClientSession.waitFor(Collection, long)

updateCurrentSessionState

protected <C extends Collection<ClientSession.ClientSessionEvent>>
C updateCurrentSessionState(C state)

getMetadataMap

public Map<Object,Object> getMetadataMap()

Description copied from interface: ClientSession

Access to the metadata.

Returns:

The metadata Map - Note: access to the map is not synchronized in any way - up to the user to take care of mutual exclusion if necessary