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

Class NetconfSshClient

  • All Implemented Interfaces:
    Closeable, AutoCloseable, Channel, org.opendaylight.netconf.shaded.sshd.client.ClientAuthenticationManager, org.opendaylight.netconf.shaded.sshd.client.ClientFactoryManager, org.opendaylight.netconf.shaded.sshd.client.config.keys.ClientIdentityLoaderHolder, org.opendaylight.netconf.shaded.sshd.client.config.keys.ClientIdentityLoaderManager, org.opendaylight.netconf.shaded.sshd.client.session.ClientProxyConnectorHolder, org.opendaylight.netconf.shaded.sshd.client.session.ClientSessionCreator, org.opendaylight.netconf.shaded.sshd.common.AttributeRepository, org.opendaylight.netconf.shaded.sshd.common.AttributeStore, 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.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.config.keys.FilePasswordProviderHolder, org.opendaylight.netconf.shaded.sshd.common.config.keys.FilePasswordProviderManager, org.opendaylight.netconf.shaded.sshd.common.FactoryManager, org.opendaylight.netconf.shaded.sshd.common.forward.PortForwardingEventListenerManager, org.opendaylight.netconf.shaded.sshd.common.io.IoServiceEventListenerManager, 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.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
    @Beta
public class NetconfSshClient
extends org.opendaylight.netconf.shaded.sshd.client.SshClient
    An extension to SshClient which uses NetconfSessionFactory to create sessions (leading towards NetconfClientSessionImpl.

    • Nested Class Summary

      • 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.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.SshClient

        connector, DEFAULT_SERVICE_FACTORIES, DEFAULT_SSH_CLIENT_FACTORY, DEFAULT_USER_AUTH_FACTORIES, sessionFactory, userAuthFactories

      • Fields inherited from class org.opendaylight.netconf.shaded.sshd.common.helpers.AbstractFactoryManager

        agentFactory, channelFactories, channelListenerProxy, channelListeners, executor, fileSystemFactory, forwarderFactory, forwardingFilter, globalRequestHandlers, ioServiceFactory, ioServiceFactoryFactory, randomFactory, serviceFactories, sessionListenerProxy, sessionListeners, sessionTimeoutListener, shutdownExecutor, timeoutListenerFuture, tunnelListenerProxy, tunnelListeners

      • 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.ClientSessionCreator

        TARGET_SERVER

      • Fields inherited from interface org.opendaylight.netconf.shaded.sshd.common.FactoryManager

        DEFAULT_VERSION

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

        EMPTY

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected NetconfSessionFactory createSessionFactory()  

      • Methods inherited from class org.opendaylight.netconf.shaded.sshd.client.SshClient

        addPasswordIdentity, addPublicKeyIdentity, checkConfig, connect, connect, connect, connect, createConnectCompletionListener, createConnector, doConnect, doConnect, getClientIdentityLoader, getClientProxyConnector, getFilePasswordProvider, getHostBasedAuthenticationReporter, getHostConfigEntryResolver, getInnerCloseable, getKeyIdentityProvider, getPasswordAuthenticationReporter, getPasswordIdentityProvider, getPublicKeyAuthenticationReporter, getRegisteredIdentities, getServerKeyVerifier, getSessionFactory, getUserAuthFactories, getUserInteraction, isStarted, onConnectOperationComplete, open, parseProxyJumps, preloadClientIdentities, removePasswordIdentity, removePublicKeyIdentity, resolveHost, setClientIdentityLoader, setClientProxyConnector, setFilePasswordProvider, setHostBasedAuthenticationReporter, setHostConfigEntryResolver, setKeyIdentityProvider, setKeyPairProvider, setKeyPairProvider, setPasswordAuthenticationReporter, setPasswordIdentityProvider, setPublicKeyAuthenticationReporter, setServerKeyVerifier, setSessionFactory, setUpDefaultClient, setupDefaultSessionIdentities, setUpDefaultSimpleClient, setUserAuthFactories, setUserInteraction, start, stop, toString, wrapAsSimpleClient

      • Methods inherited from class org.opendaylight.netconf.shaded.sshd.common.helpers.AbstractFactoryManager

        addChannelListener, addPortForwardingEventListener, addSessionListener, attributeKeys, clearAttributes, computeAttributeIfAbsent, createSessionTimeoutListener, getAgentFactory, getAttribute, getAttributesCount, getChannelFactories, getChannelListenerProxy, getChannelStreamWriterResolver, getFileSystemFactory, getForwarderFactory, getForwardingFilter, getGlobalRequestHandlers, getIoServiceEventListener, getIoServiceFactory, getIoServiceFactoryFactory, getNioWorkers, getParentPropertyResolver, getPortForwardingEventListenerProxy, getProperties, getRandomFactory, getReservedSessionMessagesHandler, getScheduledExecutorService, getServiceFactories, getSessionDisconnectHandler, getSessionListenerProxy, getUnknownChannelReferenceHandler, getVersion, removeAttribute, removeChannelListener, removePortForwardingEventListener, removeSessionListener, removeSessionTimeout, resolveUnknownChannelReferenceHandler, setAgentFactory, setAttribute, setChannelFactories, setChannelStreamWriterResolver, setFileSystemFactory, setForwarderFactory, setForwardingFilter, setGlobalRequestHandlers, setIoServiceEventListener, setIoServiceFactoryFactory, setNioWorkers, setParentPropertyResolver, setRandomFactory, setReservedSessionMessagesHandler, setScheduledExecutorService, setScheduledExecutorService, setServiceFactories, setSessionDisconnectHandler, setUnknownChannelReferenceHandler, setupSessionTimeout, stopSessionTimeoutListener

      • 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, preClose, 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 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

        setUserAuthFactoriesNames

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

        connect, connect, connect, connect, connect, connect, connect, connect, connect

      • 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.FactoryManager

        getAgentFactory, getAgentForwardingFilter, getChannelFactories, getFileSystemFactory, getForwarderFactory, getForwardingFilter, getGlobalRequestHandlers, getIoServiceFactory, getRandomFactory, getScheduledExecutorService, getServiceFactories, getTcpForwardingFilter, getVersion, getX11ForwardingFilter, resolveAttribute

      • Methods inherited from interface org.opendaylight.netconf.shaded.sshd.common.io.IoServiceEventListenerManager

        getIoServiceEventListener, setIoServiceEventListener

      • 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.forward.PortForwardingEventListenerManager

        addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

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

        getUserAuthFactoriesNameList, getUserAuthFactoriesNames, setUserAuthFactoriesNameList, setUserAuthFactoriesNames

    • 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

      • NetconfSshClient

        public NetconfSshClient()

    • Method Detail

      • createSessionFactory

        protected NetconfSessionFactory createSessionFactory()
        Overrides:
        createSessionFactory in class org.opendaylight.netconf.shaded.sshd.client.SshClient