Package org.opendaylight.netconf.nettyutil.handler.ssh.client

Class NetconfClientSessionImpl

java.lang.Object

org.opendaylight.netconf.shaded.sshd.common.util.logging.AbstractLoggingBean

org.opendaylight.netconf.shaded.sshd.common.util.closeable.IoBaseCloseable

org.opendaylight.netconf.shaded.sshd.common.util.closeable.AbstractCloseable

org.opendaylight.netconf.shaded.sshd.common.util.closeable.AbstractInnerCloseable

org.opendaylight.netconf.shaded.sshd.common.kex.AbstractKexFactoryManager

org.opendaylight.netconf.shaded.sshd.common.session.helpers.SessionHelper

org.opendaylight.netconf.shaded.sshd.common.session.helpers.AbstractSession

org.opendaylight.netconf.shaded.sshd.client.session.AbstractClientSession

org.opendaylight.netconf.shaded.sshd.client.session.ClientSessionImpl

org.opendaylight.netconf.nettyutil.handler.ssh.client.NetconfClientSessionImpl

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, NettyAwareClientSession, org.opendaylight.netconf.shaded.sshd.client.ClientAuthenticationManager, org.opendaylight.netconf.shaded.sshd.client.session.ClientProxyConnectorHolder, org.opendaylight.netconf.shaded.sshd.client.session.ClientSession, org.opendaylight.netconf.shaded.sshd.common.AttributeRepository, org.opendaylight.netconf.shaded.sshd.common.AttributeStore, org.opendaylight.netconf.shaded.sshd.common.auth.MutableUserHolder, org.opendaylight.netconf.shaded.sshd.common.auth.UserAuthFactoriesManager<org.opendaylight.netconf.shaded.sshd.client.session.ClientSession,org.opendaylight.netconf.shaded.sshd.client.auth.UserAuth,org.opendaylight.netconf.shaded.sshd.client.auth.UserAuthFactory>, org.opendaylight.netconf.shaded.sshd.common.auth.UsernameHolder, org.opendaylight.netconf.shaded.sshd.common.channel.ChannelListenerManager, org.opendaylight.netconf.shaded.sshd.common.channel.throttle.ChannelStreamWriterResolver, org.opendaylight.netconf.shaded.sshd.common.channel.throttle.ChannelStreamWriterResolverManager, org.opendaylight.netconf.shaded.sshd.common.Closeable, org.opendaylight.netconf.shaded.sshd.common.FactoryManagerHolder, org.opendaylight.netconf.shaded.sshd.common.forward.PortForwardingEventListenerManager, org.opendaylight.netconf.shaded.sshd.common.forward.PortForwardingInformationProvider, org.opendaylight.netconf.shaded.sshd.common.forward.PortForwardingManager, org.opendaylight.netconf.shaded.sshd.common.kex.extension.KexExtensionHandlerManager, org.opendaylight.netconf.shaded.sshd.common.kex.KexFactoryManager, org.opendaylight.netconf.shaded.sshd.common.keyprovider.KeyIdentityProviderHolder, org.opendaylight.netconf.shaded.sshd.common.PropertyResolver, org.opendaylight.netconf.shaded.sshd.common.session.ReservedSessionMessagesManager, org.opendaylight.netconf.shaded.sshd.common.session.Session, org.opendaylight.netconf.shaded.sshd.common.session.SessionContext, org.opendaylight.netconf.shaded.sshd.common.session.SessionDisconnectHandlerManager, org.opendaylight.netconf.shaded.sshd.common.session.SessionHeartbeatController, org.opendaylight.netconf.shaded.sshd.common.session.SessionListenerManager, org.opendaylight.netconf.shaded.sshd.common.session.UnknownChannelReferenceHandlerManager, org.opendaylight.netconf.shaded.sshd.common.signature.SignatureFactoriesHolder, org.opendaylight.netconf.shaded.sshd.common.signature.SignatureFactoriesManager, org.opendaylight.netconf.shaded.sshd.common.util.net.ConnectionEndpointsIndicator

@Beta
public class NetconfClientSessionImpl
extends org.opendaylight.netconf.shaded.sshd.client.session.ClientSessionImpl
implements NettyAwareClientSession

A ClientSessionImpl which additionally allows creation of NETCONF subsystem channel, which is routed to a particular ChannelHandlerContext.

Nested Class Summary

Nested classes/interfaces inherited from class org.opendaylight.netconf.shaded.sshd.common.session.helpers.AbstractSession

org.opendaylight.netconf.shaded.sshd.common.session.helpers.AbstractSession.MessageCodingSettings

Nested classes/interfaces inherited from class org.opendaylight.netconf.shaded.sshd.common.util.closeable.AbstractCloseable

org.opendaylight.netconf.shaded.sshd.common.util.closeable.AbstractCloseable.State

Nested classes/interfaces inherited from interface org.opendaylight.netconf.shaded.sshd.common.AttributeRepository

org.opendaylight.netconf.shaded.sshd.common.AttributeRepository.AttributeKey<T extends Object>

Nested classes/interfaces inherited from interface org.opendaylight.netconf.shaded.sshd.client.session.ClientSession

org.opendaylight.netconf.shaded.sshd.client.session.ClientSession.ClientSessionEvent

Nested classes/interfaces inherited from interface org.opendaylight.netconf.shaded.sshd.common.session.SessionHeartbeatController

org.opendaylight.netconf.shaded.sshd.common.session.SessionHeartbeatController.HeartbeatType

Field Summary

Fields

Modifier and Type	Field	Description
static org.opendaylight.netconf.shaded.sshd.common.Factory<org.opendaylight.netconf.shaded.sshd.client.SshClient>	DEFAULT_NETCONF_SSH_CLIENT_FACTORY

Fields inherited from class org.opendaylight.netconf.shaded.sshd.client.session.AbstractClientSession

sendImmediateClientIdentification, sendImmediateKexInit

Fields inherited from class org.opendaylight.netconf.shaded.sshd.common.session.helpers.AbstractSession

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

Fields inherited from class org.opendaylight.netconf.shaded.sshd.common.session.helpers.SessionHelper

authStart, idleStart, sessionLock

Fields inherited from class org.opendaylight.netconf.shaded.sshd.common.util.closeable.AbstractCloseable

closeFuture, futureLock, state

Fields inherited from class org.opendaylight.netconf.shaded.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.opendaylight.netconf.shaded.sshd.common.channel.throttle.ChannelStreamWriterResolver

NONE

Fields inherited from interface org.opendaylight.netconf.shaded.sshd.client.session.ClientSession

REMOTE_COMMAND_WAIT_EVENTS

Fields inherited from interface org.opendaylight.netconf.shaded.sshd.common.PropertyResolver

EMPTY

Fields inherited from interface org.opendaylight.netconf.shaded.sshd.common.session.SessionContext

DEFAULT_SSH_VERSION_PREFIX, FALLBACK_SSH_VERSION_PREFIX, MAX_VERSION_LINE_LENGTH

Constructor Summary

Constructors

Constructor	Description
NetconfClientSessionImpl(org.opendaylight.netconf.shaded.sshd.client.ClientFactoryManager client, org.opendaylight.netconf.shaded.sshd.common.io.IoSession ioSession)

Method Summary

Modifier and Type	Method	Description
NettyAwareChannelSubsystem	createSubsystemChannel(String subsystem, io.netty.channel.ChannelHandlerContext ctx)	Allocate a channel to the specified subsystem subsystem.

Methods inherited from class org.opendaylight.netconf.shaded.sshd.client.session.ClientSessionImpl

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

Methods inherited from class org.opendaylight.netconf.shaded.sshd.client.session.AbstractClientSession

addPasswordIdentity, addPublicKeyIdentity, checkKeys, createChannel, createChannel, createDirectTcpipChannel, 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 org.opendaylight.netconf.shaded.sshd.common.session.helpers.AbstractSession

addChannelListener, addPortForwardingEventListener, addSessionListener, aeadOutgoingBuffer, appendOutgoingMac, attachSession, calculatePadLength, checkRekey, comparePreferredKexProposalOption, createBuffer, decode, determineRekeyBlockLimit, doHandleMessage, doInvokeUnimplementedMessageHandler, doKexNegotiation, doWritePacket, encode, encryptOutgoingBuffer, enqueuePendingPacket, 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, isRekeyBlocksCountExceeded, isRekeyDataSizeExceeded, isRekeyPacketCountsExceeded, isRekeyRequired, isRekeyTimeIntervalExceeded, messageReceived, negotiate, notImplemented, prepareBuffer, prepareNewKeys, preProcessEncodeBuffer, receiveKexInit, reExchangeKeys, refreshConfiguration, removeChannelListener, removePortForwardingEventListener, removeSessionListener, request, requestFailure, requestNewKeysExchange, requestSuccess, resolveAvailableSignaturesProposal, resolveIgnoreBufferDataLength, resolveOutputPacket, resolveSessionKexProposal, sendKexInit, sendNewKeys, sendPendingPackets, setClientKexData, setInputEncoding, setNegotiationResult, setOutputEncoding, setServerKexData, signalRequestFailure, validateIncomingMac, validateKexState, validateTargetBuffer, writePacket

Methods inherited from class org.opendaylight.netconf.shaded.sshd.common.session.helpers.SessionHelper

attributeKeys, calculateNextIgnorePacketCount, checkAuthenticationTimeout, checkForTimeouts, checkIdleTimeout, clearAttributes, computeAttributeIfAbsent, createProposal, disconnect, doInvokeDebugMessageHandler, doInvokeIgnoreMessageHandler, doReadIdentification, getAttribute, getAttributesCount, getAuthTimeout, getAuthTimeoutStart, getBoundLocalPortForwards, getBoundRemotePortForward, getChannelStreamWriterResolver, getIdleTimeout, getIdleTimeoutStart, getIoSession, 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, 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, writePacket

Methods inherited from class org.opendaylight.netconf.shaded.sshd.common.kex.AbstractKexFactoryManager

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

Methods inherited from class org.opendaylight.netconf.shaded.sshd.common.util.closeable.AbstractInnerCloseable

doCloseGracefully, doCloseImmediately

Methods inherited from class org.opendaylight.netconf.shaded.sshd.common.util.closeable.AbstractCloseable

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

Methods inherited from class org.opendaylight.netconf.shaded.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 java.lang.Object

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

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.AttributeRepository

attributeKeys, getAttribute, getAttributesCount

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.AttributeStore

clearAttributes, computeAttributeIfAbsent, removeAttribute, setAttribute

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.channel.ChannelListenerManager

addChannelListener, getChannelListenerProxy, removeChannelListener

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.channel.throttle.ChannelStreamWriterResolverManager

getChannelStreamWriterResolver, resolveChannelStreamWriter, resolveChannelStreamWriterResolver, setChannelStreamWriterResolver

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.client.ClientAuthenticationManager

addPasswordIdentity, addPublicKeyIdentity, getHostBasedAuthenticationReporter, getPasswordAuthenticationReporter, getPasswordIdentityProvider, getPublicKeyAuthenticationReporter, getRegisteredIdentities, getServerKeyVerifier, getUserInteraction, removePasswordIdentity, removePublicKeyIdentity, setHostBasedAuthenticationReporter, setPasswordAuthenticationReporter, setPasswordIdentityProvider, setPublicKeyAuthenticationReporter, setServerKeyVerifier, setUserAuthFactoriesNames, setUserInteraction

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.client.session.ClientProxyConnectorHolder

getClientProxyConnector, setClientProxyConnector

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.client.session.ClientSession

auth, createChannel, createChannel, createDirectTcpipChannel, createDynamicPortForwardingTracker, createExecChannel, createExecChannel, createLocalPortForwardingTracker, createLocalPortForwardingTracker, createRemotePortForwardingTracker, createShellChannel, createShellChannel, createSubsystemChannel, executeRemoteCommand, executeRemoteCommand, executeRemoteCommand, getConnectAddress, getConnectionContext, getFactoryManager, getMetadataMap, getServerKey, getSessionState, switchToNoneCipher, waitFor, waitFor

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.Closeable

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

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.kex.extension.KexExtensionHandlerManager

getKexExtensionHandler, setKexExtensionHandler

Methods inherited from interface org.opendaylight.netconf.shaded.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.opendaylight.netconf.shaded.sshd.common.keyprovider.KeyIdentityProviderHolder

getKeyIdentityProvider, setKeyIdentityProvider

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.auth.MutableUserHolder

setUsername

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.forward.PortForwardingEventListenerManager

addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.forward.PortForwardingInformationProvider

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

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.forward.PortForwardingManager

startDynamicPortForwarding, startLocalPortForwarding, startLocalPortForwarding, startRemotePortForwarding, stopDynamicPortForwarding, stopLocalPortForwarding, stopRemotePortForwarding

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.PropertyResolver

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

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.session.ReservedSessionMessagesManager

getReservedSessionMessagesHandler, setReservedSessionMessagesHandler

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.session.Session

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

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.session.SessionContext

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

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.session.SessionDisconnectHandlerManager

getSessionDisconnectHandler, setSessionDisconnectHandler

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.session.SessionHeartbeatController

disableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, setSessionHeartbeat, setSessionHeartbeat

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.session.SessionListenerManager

addSessionListener, getSessionListenerProxy, removeSessionListener

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.signature.SignatureFactoriesHolder

getSignatureFactories, getSignatureFactoriesNameList, getSignatureFactoriesNames

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.signature.SignatureFactoriesManager

setSignatureFactories, setSignatureFactoriesNameList, setSignatureFactoriesNames, setSignatureFactoriesNames

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.session.UnknownChannelReferenceHandlerManager

getUnknownChannelReferenceHandler, resolveUnknownChannelReferenceHandler, setUnknownChannelReferenceHandler

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.auth.UserAuthFactoriesManager

getUserAuthFactories, getUserAuthFactoriesNameList, getUserAuthFactoriesNames, setUserAuthFactories, setUserAuthFactoriesNameList, setUserAuthFactoriesNames

Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.auth.UsernameHolder

getUsername

Field Detail

DEFAULT_NETCONF_SSH_CLIENT_FACTORY

public static final org.opendaylight.netconf.shaded.sshd.common.Factory<org.opendaylight.netconf.shaded.sshd.client.SshClient> DEFAULT_NETCONF_SSH_CLIENT_FACTORY

Constructor Detail

NetconfClientSessionImpl

public NetconfClientSessionImpl(org.opendaylight.netconf.shaded.sshd.client.ClientFactoryManager client,
                                org.opendaylight.netconf.shaded.sshd.common.io.IoSession ioSession)
                         throws Exception

Throws:

Exception

Method Detail

createSubsystemChannel

public NettyAwareChannelSubsystem createSubsystemChannel(String subsystem,
                                                         io.netty.channel.ChannelHandlerContext ctx)
                                                  throws IOException

Description copied from interface: NettyAwareClientSession

Allocate a channel to the specified subsystem subsystem. Incoming data on the channel will be routed to the specified ChannelHandlerContext.

Specified by:

createSubsystemChannel in interface NettyAwareClientSession

Parameters:

subsystem - The subsystem name

ctx - Context to which to route data to

Returns:

The created NettyAwareChannelSubsystem

Throws:

IOException - If failed to create the requested channel