org.eclipse.jgit.internal.transport.sshd

Class JGitClientSession

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.AbstractSession

org.apache.sshd.client.session.AbstractClientSession

org.apache.sshd.client.session.ClientSessionImpl

org.eclipse.jgit.internal.transport.sshd.JGitClientSession

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, org.apache.sshd.client.ClientAuthenticationManager, org.apache.sshd.client.session.ClientProxyConnectorHolder, org.apache.sshd.client.session.ClientSession, org.apache.sshd.common.AttributeStore, org.apache.sshd.common.auth.MutableUserHolder, org.apache.sshd.common.auth.UsernameHolder, org.apache.sshd.common.channel.ChannelListenerManager, org.apache.sshd.common.channel.throttle.ChannelStreamPacketWriterResolver, org.apache.sshd.common.channel.throttle.ChannelStreamPacketWriterResolverManager, org.apache.sshd.common.FactoryManagerHolder, org.apache.sshd.common.forward.PortForwardingEventListenerManager, org.apache.sshd.common.forward.PortForwardingManager, org.apache.sshd.common.io.PacketWriter, org.apache.sshd.common.kex.KexFactoryManager, org.apache.sshd.common.keyprovider.KeyPairProviderHolder, org.apache.sshd.common.PropertyResolver, org.apache.sshd.common.session.ReservedSessionMessagesManager, org.apache.sshd.common.session.Session, org.apache.sshd.common.session.SessionListenerManager, org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager, org.apache.sshd.common.signature.SignatureFactoriesManager

public class JGitClientSession
extends org.apache.sshd.client.session.ClientSessionImpl

A ClientSession that can be associated with the HostConfigEntry the session was created for. The JGitSshClient creates such sessions and sets this association.

Also provides for associating a JGit CredentialsProvider with a session.

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.client.session.ClientSession

org.apache.sshd.client.session.ClientSession.ClientSessionEvent

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

org.apache.sshd.common.session.Session.TimeoutStatus

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

org.apache.sshd.common.AttributeStore.AttributeKey<T>

Field Summary

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

authed, authTimeoutStart, channelListenerProxy, channelListeners, clientProposal, clientVersion, currentService, decodeLock, decoderBuffer, decoderLength, decoderState, encodeLock, firstKexPacketFollows, idleTimeoutStart, ignorePacketDataLength, ignorePacketsCount, ignorePacketsFrequency, ignorePacketsVariance, inBlocksCount, inBytesCount, inCipher, inCipherSize, inCompression, inMac, inMacResult, inPacketsCount, isServer, kex, kexFutureHolder, kexState, lastKeyTimeValue, maxRekeyBlocks, maxRekeyBytes, maxRekeyInterval, maxRekyPackets, negotiationResult, outBlocksCount, outBytesCount, outCipher, outCipherSize, outCompression, outMac, outPacketsCount, pendingPackets, random, requestLock, seqi, seqo, serverProposal, serverVersion, SESSION, sessionId, sessionListenerProxy, sessionListeners, timeoutStatus, tunnelListenerProxy, tunnelListeners, uncompressBuffer, username

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.client.session.ClientSession

REMOTE_COMMAND_WAIT_EVENTS

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

DEFAULT_SSH_VERSION_PREFIX, FALLBACK_SSH_VERSION_PREFIX, MAX_VERSION_LINE_LENGTH

Fields inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamPacketWriterResolver

NONE

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

EMPTY

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

CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT

Fields inherited from interface org.apache.sshd.client.ClientAuthenticationManager

DEFAULT_PASSWORD_PROMPTS, PASSWORD_PROMPTS, PREFERRED_AUTHS

Constructor Summary

Constructors

Constructor and Description
JGitClientSession(org.apache.sshd.client.ClientFactoryManager manager, org.apache.sshd.common.io.IoSession session)

Method Summary

Modifier and Type	Method and Description
protected void	checkKeys()
CredentialsProvider	getCredentialsProvider() Retrieves the CredentialsProvider set for this session.
org.apache.sshd.client.config.hosts.HostConfigEntry	getHostConfigEntry() Retrieves the HostConfigEntry this session was created for.
void	messageReceived(org.apache.sshd.common.util.Readable buffer) As long as we're still setting up the proxy connection, diverts messages to the StatefulProxyConnector.
protected String	resolveAvailableSignaturesProposal(org.apache.sshd.common.FactoryManager manager)
protected org.apache.sshd.common.io.IoWriteFuture	sendIdentification(String ident)
protected byte[]	sendKexInit()
void	setCredentialsProvider(CredentialsProvider provider) Sets the CredentialsProvider for this session.
void	setHostConfigEntry(org.apache.sshd.client.config.hosts.HostConfigEntry hostConfig) Sets the HostConfigEntry this session was created for.
void	setProxyHandler(StatefulProxyConnector handler) Sets a StatefulProxyConnector to handle proxy connection protocols.

Methods inherited from class org.apache.sshd.client.session.ClientSessionImpl

auth, exceptionCaught, getMetadataMap, getServices, handleDisconnect, nextServiceName, preClose, sendInitialServiceRequest, signalAuthFailure, signalSessionEvent, switchToNextService, waitFor

Methods inherited from class org.apache.sshd.client.session.AbstractClientSession

addPasswordIdentity, addPublicKeyIdentity, createChannel, createChannel, createDirectTcpipChannel, createExecChannel, createShellChannel, createSubsystemChannel, getClientProxyConnector, getConnectAddress, getConnectionService, getFactoryManager, getForwardingFilter, getPasswordIdentityProvider, getRegisteredIdentities, getServerKeyVerifier, getUserAuthFactories, getUserAuthService, getUserInteraction, readIdentification, receiveKexInit, removePasswordIdentity, removePublicKeyIdentity, sendClientIdentification, sendKexInit, setClientProxyConnector, setConnectAddress, setKexSeed, setPasswordIdentityProvider, setServerKeyVerifier, setUserAuthFactories, setUserInteraction, signalExtraServerVersionInfo, startDynamicPortForwarding, startLocalPortForwarding, startRemotePortForwarding, startService, stopDynamicPortForwarding, stopLocalPortForwarding, stopRemotePortForwarding, switchToNoneCipher

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

addChannelListener, addPortForwardingEventListener, addSessionListener, attachSession, calculateNextIgnorePacketCount, checkAuthenticationTimeout, checkForTimeouts, checkIdleTimeout, checkRekey, comparePreferredKexProposalOption, createBuffer, createBuffer, createProposal, decode, disconnect, doHandleMessage, doReadIdentification, doWritePacket, encode, getAttribute, getAuthTimeout, getChannelListenerProxy, getChannelStreamPacketWriterResolver, getCipherInformation, getClientKexData, getClientVersion, getCompressionInformation, getIdleTimeout, getInnerCloseable, getIoSession, getKex, getLock, getMacInformation, getNegotiatedKexParameter, getParentPropertyResolver, getPortForwardingEventListenerProxy, getProperties, getReservedSessionMessagesHandler, getServerKexData, getServerVersion, getService, getSession, getSession, getSessionId, getSessionListenerProxy, getTimeoutStatus, getUnknownChannelReferenceHandler, getUsername, handleDebug, handleDisconnect, handleFirstKexPacketFollows, handleIgnore, handleKexInit, handleKexMessage, handleMessage, handleNewKeys, handleServiceAccept, handleServiceAccept, handleServiceRequest, handleServiceRequest, handleUnimplemented, invokeSessionSignaller, isAuthenticated, isRekeyBlocksCountExceeded, isRekeyDataSizeExceeded, isRekeyPacketCountsExceeded, isRekeyRequired, isRekeyTimeIntervalExceeded, mergeProposals, negotiate, notImplemented, prepareBuffer, receiveKexInit, receiveKexInit, receiveNewKeys, reExchangeKeys, refreshConfiguration, removeAttribute, removeChannelListener, removePortForwardingEventListener, removeSessionListener, request, requestFailure, requestNewKeysExchange, requestSuccess, resetIdleTimeout, resizeKey, resolveAttribute, resolveAvailableSignaturesProposal, resolveChannelStreamPacketWriterResolver, resolveIdentificationString, resolveIgnoreBufferDataLength, resolvePeerAddress, resolveReservedSessionMessagesHandler, resolveUnknownChannelReferenceHandler, sendDebugMessage, sendIgnoreMessage, sendNewKeys, sendNotImplemented, sendPendingPackets, setAttribute, setAuthenticated, setChannelStreamPacketWriterResolver, setClientKexData, setNegotiationResult, setReservedSessionMessagesHandler, setServerKexData, setUnknownChannelReferenceHandler, setUsername, signalExceptionCaught, signalExceptionCaught, signalNegotiationEnd, signalNegotiationEnd, signalNegotiationStart, signalNegotiationStart, signalSessionClosed, signalSessionClosed, signalSessionCreated, signalSessionCreated, signalSessionEvent, toString, validateKexState, validateTargetBuffer, writePacket, writePacket

Methods inherited from class org.apache.sshd.common.kex.AbstractKexFactoryManager

getCipherFactories, getCompressionFactories, getKeyExchangeFactories, getKeyPairProvider, getMacFactories, getSignatureFactories, resolveEffectiveFactories, resolveEffectiveProvider, setCipherFactories, setCompressionFactories, setKeyExchangeFactories, setKeyPairProvider, setMacFactories, setSignatureFactories

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.client.session.ClientSession

createDynamicPortForwardingTracker, createLocalPortForwardingTracker, createRemotePortForwardingTracker, executeRemoteCommand, executeRemoteCommand, executeRemoteCommand

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

createBuffer, createBuffer, disconnect, getAuthTimeout, getCipherInformation, getClientVersion, getCompressionInformation, getIdleTimeout, getIoSession, getKex, getMacInformation, getNegotiatedKexParameter, getServerVersion, getService, getSessionId, getTimeoutStatus, isAuthenticated, isValidVersionPrefix, prepareBuffer, reExchangeKeys, request, resetIdleTimeout, sendDebugMessage, sendIgnoreMessage, setAuthenticated, writePacket

Methods inherited from interface org.apache.sshd.common.kex.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 org.apache.sshd.common.keyprovider.KeyPairProviderHolder

getKeyPairProvider, setKeyPairProvider

Methods inherited from interface org.apache.sshd.common.signature.SignatureFactoriesManager

getSignatureFactories, getSignatureFactories, getSignatureFactoriesNameList, getSignatureFactoriesNames, resolveSignatureFactories, setSignatureFactories, setSignatureFactoriesNameList, setSignatureFactoriesNames, setSignatureFactoriesNames

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

addSessionListener, getSessionListenerProxy, removeSessionListener

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

getReservedSessionMessagesHandler, setReservedSessionMessagesHandler

Methods inherited from interface org.apache.sshd.common.channel.ChannelListenerManager

addChannelListener, getChannelListenerProxy, removeChannelListener

Methods inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamPacketWriterResolverManager

getChannelStreamPacketWriterResolver, resolveChannelStreamPacketWriter, resolveChannelStreamPacketWriterResolver, setChannelStreamPacketWriterResolver

Methods inherited from interface org.apache.sshd.common.forward.PortForwardingEventListenerManager

addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

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

getUnknownChannelReferenceHandler, resolveUnknownChannelReferenceHandler, setUnknownChannelReferenceHandler

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

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

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

getAttribute, removeAttribute, resolveAttribute, resolveAttribute, resolveAttribute, resolveAttribute, setAttribute

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.auth.MutableUserHolder

setUsername

Methods inherited from interface org.apache.sshd.common.auth.UsernameHolder

getUsername

Methods inherited from interface org.apache.sshd.common.io.PacketWriter

writePacket

Methods inherited from interface org.apache.sshd.client.ClientAuthenticationManager

getUserAuthFactoriesNameList, getUserAuthFactoriesNames, setUserAuthFactoriesNameList, setUserAuthFactoriesNames, setUserAuthFactoriesNames

Constructor Detail

JGitClientSession

public JGitClientSession(org.apache.sshd.client.ClientFactoryManager manager,
                         org.apache.sshd.common.io.IoSession session)
                  throws Exception

Parameters:

manager -

session -

Throws:

Exception

Method Detail

getHostConfigEntry

public org.apache.sshd.client.config.hosts.HostConfigEntry getHostConfigEntry()

Retrieves the HostConfigEntry this session was created for.

Returns:

the HostConfigEntry, or null if none set

setHostConfigEntry

public void setHostConfigEntry(org.apache.sshd.client.config.hosts.HostConfigEntry hostConfig)

Sets the HostConfigEntry this session was created for.

Parameters:

hostConfig - the HostConfigEntry

setCredentialsProvider

public void setCredentialsProvider(CredentialsProvider provider)

Sets the CredentialsProvider for this session.

Parameters:

provider - to set

getCredentialsProvider

public CredentialsProvider getCredentialsProvider()

Retrieves the CredentialsProvider set for this session.

Returns:

the provider, or null if none is set.

setProxyHandler

public void setProxyHandler(StatefulProxyConnector handler)

Sets a StatefulProxyConnector to handle proxy connection protocols.

Parameters:

handler - to set

sendIdentification

protected org.apache.sshd.common.io.IoWriteFuture sendIdentification(String ident)
                                                              throws IOException

Overrides:

sendIdentification in class org.apache.sshd.common.session.helpers.AbstractSession

Throws:

IOException

sendKexInit

protected byte[] sendKexInit()
                      throws IOException

Overrides:

sendKexInit in class org.apache.sshd.common.session.helpers.AbstractSession

Throws:

IOException

messageReceived

public void messageReceived(org.apache.sshd.common.util.Readable buffer)
                     throws Exception

As long as we're still setting up the proxy connection, diverts messages to the StatefulProxyConnector.

Overrides:

messageReceived in class org.apache.sshd.common.session.helpers.AbstractSession

Throws:

Exception

checkKeys

protected void checkKeys()
                  throws org.apache.sshd.common.SshException

Overrides:

checkKeys in class org.apache.sshd.client.session.AbstractClientSession

Throws:

org.apache.sshd.common.SshException

resolveAvailableSignaturesProposal

protected String resolveAvailableSignaturesProposal(org.apache.sshd.common.FactoryManager manager)

Overrides:

resolveAvailableSignaturesProposal in class org.apache.sshd.client.session.AbstractClientSession