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

Interface NettyAwareClientSession

All Superinterfaces:

org.opendaylight.netconf.shaded.sshd.common.AttributeRepository, org.opendaylight.netconf.shaded.sshd.common.AttributeStore, AutoCloseable, Channel, 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.client.ClientAuthenticationManager, org.opendaylight.netconf.shaded.sshd.client.session.ClientProxyConnectorHolder, org.opendaylight.netconf.shaded.sshd.client.session.ClientSession, Closeable, org.opendaylight.netconf.shaded.sshd.common.Closeable, org.opendaylight.netconf.shaded.sshd.common.util.net.ConnectionEndpointsIndicator, org.opendaylight.netconf.shaded.sshd.common.FactoryManagerHolder, 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.auth.MutableUserHolder, 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.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.signature.SignatureFactoriesHolder, org.opendaylight.netconf.shaded.sshd.common.signature.SignatureFactoriesManager, org.opendaylight.netconf.shaded.sshd.common.session.UnknownChannelReferenceHandlerManager, 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

All Known Implementing Classes:

NetconfClientSessionImpl

@Beta
public interface NettyAwareClientSession
extends org.opendaylight.netconf.shaded.sshd.client.session.ClientSession

A ClientSession which additionally allows subsystem channels which are forwarded to a particular Netty channel context.

Nested Class Summary

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

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

Method Detail

createSubsystemChannel

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

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

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