Package org.apache.sshd.client

Class SshClient

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.helpers.AbstractFactoryManager

org.apache.sshd.client.SshClient

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ClientAuthenticationManager, ClientFactoryManager, ClientIdentityLoaderHolder, ClientIdentityLoaderManager, ClientProxyConnectorHolder, ClientSessionCreator, AttributeRepository, AttributeStore, UserAuthFactoriesManager<ClientSession,UserAuth,UserAuthFactory>, ChannelListenerManager, ChannelStreamWriterResolver, ChannelStreamWriterResolverManager, Closeable, FilePasswordProviderHolder, FilePasswordProviderManager, FactoryManager, PortForwardingEventListenerManager, IoServiceEventListenerManager, KexExtensionHandlerManager, KexFactoryManager, KeyIdentityProviderHolder, PropertyResolver, ReservedSessionMessagesManager, SessionDisconnectHandlerManager, SessionHeartbeatController, SessionListenerManager, UnknownChannelReferenceHandlerManager, SignatureFactoriesHolder, SignatureFactoriesManager

public class SshClient
extends AbstractFactoryManager
implements ClientFactoryManager, Closeable

Entry point for the client side of the SSH protocol.

The default configured client can be created using the setUpDefaultClient(). The next step is to configure and then start the client using the start() method.

Sessions can then be created using on of the ClientSessionCreator.connect(String, String, int) or ClientSessionCreator.connect(String, java.net.SocketAddress) methods.

The client can be stopped any time using the stop() method.

Following is an example of using the SshClient:

 
 try (SshClient client = SshClient.setUpDefaultClient()) {
      ...further configuration of the client...
      client.start();

      try (ClientSession session = client.connect(login, host, port)
                  .verify(...timeout...)
                  .getSession()) {
          session.addPasswordIdentity(password);
          session.auth().verify(...timeout...);

          try (ClientChannel channel = session.createChannel(ClientChannel.CHANNEL_SHELL)) {
              channel.setIn(new NoCloseInputStream(System.in));
              channel.setOut(new NoCloseOutputStream(System.out));
              channel.setErr(new NoCloseOutputStream(System.err));
              channel.open();
              channel.waitFor(ClientChannel.CLOSED, 0);
          } finally {
              session.close(false);
          }
    } finally {
        client.stop();
    }
 }
 
 

Note: the idea is to have one SshClient instance for the entire application and re-use it repeatedly in order to create as many sessions as necessary - possibly with different hosts, ports, users, passwords, etc. - including concurrently. In other words, except for exceptional cases, it is recommended to initialize one instance of SshClient for the application and then use throughout - including for multi-threading. As long as the SshClient is not re-configured it should be multi-thread safe regardless of the target session being created.

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

AbstractCloseable.State

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

AttributeRepository.AttributeKey<T extends Object>

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

SessionHeartbeatController.HeartbeatType

Field Summary

Fields

Modifier and Type	Field	Description
protected IoConnector	connector
static List<ServiceFactory>	DEFAULT_SERVICE_FACTORIES
static Factory<SshClient>	DEFAULT_SSH_CLIENT_FACTORY
static List<UserAuthFactory>	DEFAULT_USER_AUTH_FACTORIES	Default user authentication preferences if not set
protected SessionFactory	sessionFactory
protected List<UserAuthFactory>	userAuthFactories

Fields inherited from class org.apache.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.apache.sshd.common.util.closeable.AbstractCloseable

closeFuture, futureLock, state

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

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

NONE

Fields inherited from interface org.apache.sshd.client.session.ClientSessionCreator

TARGET_SERVER

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

DEFAULT_VERSION

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
SshClient()

Method Summary

Modifier and Type	Method	Description
void	addPasswordIdentity(String password)
void	addPublicKeyIdentity(KeyPair kp)
protected void	checkConfig()
ConnectFuture	connect(String uriStr)	Resolves the effective HostConfigEntry and connects to it
ConnectFuture	connect(String username, String host, int port, AttributeRepository context, SocketAddress localAddress)	Resolves the effective HostConfigEntry and connects to it
ConnectFuture	connect(String username, SocketAddress targetAddress, AttributeRepository context, SocketAddress localAddress)	Resolves the effective HostConfigEntry and connects to it
ConnectFuture	connect(HostConfigEntry hostConfig, AttributeRepository context, SocketAddress localAddress)
protected SshFutureListener<IoConnectFuture>	createConnectCompletionListener(ConnectFuture connectFuture, String username, SocketAddress address, KeyIdentityProvider identities, HostConfigEntry hostConfig)
protected IoConnector	createConnector()
protected SessionFactory	createSessionFactory()
protected ConnectFuture	doConnect(String username, SocketAddress targetAddress, AttributeRepository context, SocketAddress localAddress, KeyIdentityProvider identities, HostConfigEntry hostConfig)
protected ConnectFuture	doConnect(HostConfigEntry hostConfig, List<HostConfigEntry> jumps, AttributeRepository context, SocketAddress localAddress)
protected KeyIdentityProvider	ensureFilePasswordProvider(KeyIdentityProvider identities)	Sets this client's FilePasswordProvider on the KeyIdentityProvider if it is an AbstractResourceKeyPairProvider or implements FilePasswordProviderManager and doesn't have one yet.
ClientIdentityLoader	getClientIdentityLoader()
ClientProxyConnector	getClientProxyConnector()
FilePasswordProvider	getFilePasswordProvider()
HostBasedAuthenticationReporter	getHostBasedAuthenticationReporter()
HostConfigEntryResolver	getHostConfigEntryResolver()
protected Closeable	getInnerCloseable()
KeyIdentityProvider	getKeyIdentityProvider()
PasswordAuthenticationReporter	getPasswordAuthenticationReporter()
PasswordIdentityProvider	getPasswordIdentityProvider()	Retrieve PasswordIdentityProvider used to provide password candidates
PublicKeyAuthenticationReporter	getPublicKeyAuthenticationReporter()
AuthenticationIdentitiesProvider	getRegisteredIdentities()
ServerKeyVerifier	getServerKeyVerifier()	Retrieve the server key verifier to be used to check the key when connecting to an SSH server.
SessionFactory	getSessionFactory()
List<UserAuthFactory>	getUserAuthFactories()
UserInteraction	getUserInteraction()
boolean	isStarted()
protected void	onConnectOperationComplete(IoSession ioSession, ConnectFuture connectFuture, String username, SocketAddress address, KeyIdentityProvider identities, HostConfigEntry hostConfig)
void	open()
protected List<HostConfigEntry>	parseProxyJumps(String proxyJump, AttributeRepository context)
protected KeyIdentityProvider	preloadClientIdentities(Collection<? extends NamedResource> locations)
String	removePasswordIdentity(String password)
KeyPair	removePublicKeyIdentity(KeyPair kp)
protected HostConfigEntry	resolveHost(String username, String host, int port, AttributeRepository context, SocketAddress localAddress)
void	setClientIdentityLoader(ClientIdentityLoader loader)
void	setClientProxyConnector(ClientProxyConnector proxyConnector)
void	setFilePasswordProvider(FilePasswordProvider provider)
void	setHostBasedAuthenticationReporter(HostBasedAuthenticationReporter reporter)
void	setHostConfigEntryResolver(HostConfigEntryResolver resolver)
void	setKeyIdentityProvider(KeyIdentityProvider keyIdentityProvider)
static <C extends SshClient> C	setKeyPairProvider(C client, boolean strict, boolean supportedOnly, FilePasswordProvider provider, LinkOption... options)
static <C extends SshClient> C	setKeyPairProvider(C client, Path dir, boolean strict, boolean supportedOnly, FilePasswordProvider provider, LinkOption... options)
void	setPasswordAuthenticationReporter(PasswordAuthenticationReporter reporter)
void	setPasswordIdentityProvider(PasswordIdentityProvider provider)
void	setPublicKeyAuthenticationReporter(PublicKeyAuthenticationReporter reporter)
void	setServerKeyVerifier(ServerKeyVerifier serverKeyVerifier)
void	setSessionFactory(SessionFactory sessionFactory)
static SshClient	setUpDefaultClient()	Setup a default client.
protected void	setupDefaultSessionIdentities(ClientSession session, KeyIdentityProvider extraIdentities)
static SimpleClient	setUpDefaultSimpleClient()	Setup a default client, starts it and then wraps it as a SimpleClient
void	setUserAuthFactories(List<UserAuthFactory> userAuthFactories)
void	setUserInteraction(UserInteraction userInteraction)
void	start()	Starts the SSH client and can start creating sessions using it.
void	stop()
String	toString()
static SimpleClient	wrapAsSimpleClient(SshClient client)	Wraps an SshClient instance as a SimpleClient

Methods inherited from class org.apache.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.apache.sshd.common.kex.AbstractKexFactoryManager

getCipherFactories, getCompressionFactories, getDelegate, getKexExtensionHandler, getKeyExchangeFactories, getMacFactories, getSignatureFactories, resolveEffectiveFactories, resolveEffectiveProvider, setCipherFactories, setCompressionFactories, setKexExtensionHandler, setKeyExchangeFactories, 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, getFutureLock, isClosed, isClosing, preClose, removeCloseFutureListener

Methods inherited from class org.apache.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.apache.sshd.common.AttributeRepository

attributeKeys, getAttribute, getAttributesCount

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

clearAttributes, computeAttributeIfAbsent, removeAttribute, setAttribute

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

addChannelListener, getChannelListenerProxy, removeChannelListener

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

getChannelStreamWriterResolver, resolveChannelStreamWriter, resolveChannelStreamWriterResolver, setChannelStreamWriterResolver

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

setUserAuthFactoriesNames

Methods inherited from interface org.apache.sshd.client.session.ClientSessionCreator

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

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

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

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

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

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

getIoServiceEventListener, setIoServiceEventListener

Methods inherited from interface org.apache.sshd.common.kex.extension.KexExtensionHandlerManager

getKexExtensionHandler, setKexExtensionHandler

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

addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

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

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

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

getReservedSessionMessagesHandler, setReservedSessionMessagesHandler

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

getSessionDisconnectHandler, setSessionDisconnectHandler

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

disableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, setSessionHeartbeat, setSessionHeartbeat

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

addSessionListener, getSessionListenerProxy, removeSessionListener

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

getSignatureFactories, getSignatureFactoriesNameList, getSignatureFactoriesNames

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

setSignatureFactories, setSignatureFactoriesNameList, setSignatureFactoriesNames, setSignatureFactoriesNames

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

getUnknownChannelReferenceHandler, resolveUnknownChannelReferenceHandler, setUnknownChannelReferenceHandler

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

getUserAuthFactoriesNameList, getUserAuthFactoriesNames, setUserAuthFactoriesNameList, setUserAuthFactoriesNames

Field Detail

DEFAULT_SSH_CLIENT_FACTORY

public static final Factory<SshClient> DEFAULT_SSH_CLIENT_FACTORY

DEFAULT_USER_AUTH_FACTORIES

public static final List<UserAuthFactory> DEFAULT_USER_AUTH_FACTORIES

Default user authentication preferences if not set

See Also:

ssh_config(5) - PreferredAuthentications

DEFAULT_SERVICE_FACTORIES

public static final List<ServiceFactory> DEFAULT_SERVICE_FACTORIES

connector

protected IoConnector connector

sessionFactory

protected SessionFactory sessionFactory

userAuthFactories

protected List<UserAuthFactory> userAuthFactories

Constructor Detail

SshClient

public SshClient()

Method Detail

getSessionFactory

public SessionFactory getSessionFactory()

setSessionFactory

public void setSessionFactory(SessionFactory sessionFactory)

getClientProxyConnector

public ClientProxyConnector getClientProxyConnector()

Specified by:

getClientProxyConnector in interface ClientProxyConnectorHolder

setClientProxyConnector

public void setClientProxyConnector(ClientProxyConnector proxyConnector)

Specified by:

setClientProxyConnector in interface ClientProxyConnectorHolder

getServerKeyVerifier

public ServerKeyVerifier getServerKeyVerifier()

Description copied from interface: ClientAuthenticationManager

Retrieve the server key verifier to be used to check the key when connecting to an SSH server.

Specified by:

getServerKeyVerifier in interface ClientAuthenticationManager

Returns:

the ServerKeyVerifier to use - never null

setServerKeyVerifier

public void setServerKeyVerifier(ServerKeyVerifier serverKeyVerifier)

Specified by:

setServerKeyVerifier in interface ClientAuthenticationManager

getHostConfigEntryResolver

public HostConfigEntryResolver getHostConfigEntryResolver()

Specified by:

getHostConfigEntryResolver in interface ClientFactoryManager

Returns:

The HostConfigEntryResolver to use in order to resolve the effective session parameters - never null

setHostConfigEntryResolver

public void setHostConfigEntryResolver(HostConfigEntryResolver resolver)

Specified by:

setHostConfigEntryResolver in interface ClientFactoryManager

getFilePasswordProvider

public FilePasswordProvider getFilePasswordProvider()

Specified by:

getFilePasswordProvider in interface FilePasswordProviderHolder

setFilePasswordProvider

public void setFilePasswordProvider(FilePasswordProvider provider)

Specified by:

setFilePasswordProvider in interface FilePasswordProviderManager

getClientIdentityLoader

public ClientIdentityLoader getClientIdentityLoader()

Specified by:

getClientIdentityLoader in interface ClientIdentityLoaderHolder

setClientIdentityLoader

public void setClientIdentityLoader(ClientIdentityLoader loader)

Specified by:

setClientIdentityLoader in interface ClientIdentityLoaderManager

getUserInteraction

public UserInteraction getUserInteraction()

Specified by:

getUserInteraction in interface ClientAuthenticationManager

Returns:

A UserInteraction object to communicate with the user (may be null to indicate that no such communication is allowed)

setUserInteraction

public void setUserInteraction(UserInteraction userInteraction)

Specified by:

setUserInteraction in interface ClientAuthenticationManager

getPasswordAuthenticationReporter

public PasswordAuthenticationReporter getPasswordAuthenticationReporter()

Specified by:

getPasswordAuthenticationReporter in interface ClientAuthenticationManager

setPasswordAuthenticationReporter

public void setPasswordAuthenticationReporter(PasswordAuthenticationReporter reporter)

Specified by:

setPasswordAuthenticationReporter in interface ClientAuthenticationManager

getHostBasedAuthenticationReporter

public HostBasedAuthenticationReporter getHostBasedAuthenticationReporter()

Specified by:

getHostBasedAuthenticationReporter in interface ClientAuthenticationManager

setHostBasedAuthenticationReporter

public void setHostBasedAuthenticationReporter(HostBasedAuthenticationReporter reporter)

Specified by:

setHostBasedAuthenticationReporter in interface ClientAuthenticationManager

getUserAuthFactories

public List<UserAuthFactory> getUserAuthFactories()

Specified by:

getUserAuthFactories in interface UserAuthFactoriesManager<ClientSession,UserAuth,UserAuthFactory>

setUserAuthFactories

public void setUserAuthFactories(List<UserAuthFactory> userAuthFactories)

Specified by:

setUserAuthFactories in interface UserAuthFactoriesManager<ClientSession,UserAuth,UserAuthFactory>

getRegisteredIdentities

public AuthenticationIdentitiesProvider getRegisteredIdentities()

Specified by:

getRegisteredIdentities in interface ClientAuthenticationManager

Returns:

The AuthenticationIdentitiesProvider to be used for attempting password or public key authentication

getPasswordIdentityProvider

public PasswordIdentityProvider getPasswordIdentityProvider()

Description copied from interface: ClientAuthenticationManager

Retrieve PasswordIdentityProvider used to provide password candidates

Specified by:

getPasswordIdentityProvider in interface ClientAuthenticationManager

Returns:

The PasswordIdentityProvider instance - ignored if null (i.e., no passwords available).

See Also:

ClientAuthenticationManager.addPasswordIdentity(String)

setPasswordIdentityProvider

public void setPasswordIdentityProvider(PasswordIdentityProvider provider)

Specified by:

setPasswordIdentityProvider in interface ClientAuthenticationManager

addPasswordIdentity

public void addPasswordIdentity(String password)

Specified by:

addPasswordIdentity in interface ClientAuthenticationManager

Parameters:

password - Password to be added - may not be null/empty. Note: this password is in addition to whatever passwords are available via the PasswordIdentityProvider (if any)

removePasswordIdentity

public String removePasswordIdentity(String password)

Specified by:

removePasswordIdentity in interface ClientAuthenticationManager

Parameters:

password - The password to remove - ignored if null/empty

Returns:

The removed password - same one that was added via ClientAuthenticationManager.addPasswordIdentity(String) - or null if no match found

addPublicKeyIdentity

public void addPublicKeyIdentity(KeyPair kp)

Specified by:

addPublicKeyIdentity in interface ClientAuthenticationManager

Parameters:

kp - The KeyPair to add - may not be null Note: this key is in addition to whatever keys are available via the KeyIdentityProvider (if any)

removePublicKeyIdentity

public KeyPair removePublicKeyIdentity(KeyPair kp)

Specified by:

removePublicKeyIdentity in interface ClientAuthenticationManager

Parameters:

kp - The KeyPair to remove - ignored if null

Returns:

The removed KeyPair - same one that was added via ClientAuthenticationManager.addPublicKeyIdentity(KeyPair) - or null if no match found

getKeyIdentityProvider

public KeyIdentityProvider getKeyIdentityProvider()

Specified by:

getKeyIdentityProvider in interface KeyIdentityProviderHolder

setKeyIdentityProvider

public void setKeyIdentityProvider(KeyIdentityProvider keyIdentityProvider)

Specified by:

setKeyIdentityProvider in interface KeyIdentityProviderHolder

getPublicKeyAuthenticationReporter

public PublicKeyAuthenticationReporter getPublicKeyAuthenticationReporter()

Specified by:

getPublicKeyAuthenticationReporter in interface ClientAuthenticationManager

setPublicKeyAuthenticationReporter

public void setPublicKeyAuthenticationReporter(PublicKeyAuthenticationReporter reporter)

Specified by:

setPublicKeyAuthenticationReporter in interface ClientAuthenticationManager

checkConfig

protected void checkConfig()

Overrides:

checkConfig in class AbstractFactoryManager

isStarted

public boolean isStarted()

start

public void start()

Starts the SSH client and can start creating sessions using it. Ignored if already started.

stop

public void stop()

open

public void open()
          throws IOException

Throws:

IOException

getInnerCloseable

protected Closeable getInnerCloseable()

Specified by:

getInnerCloseable in class AbstractInnerCloseable

connect

public ConnectFuture connect(String uriStr)
                      throws IOException

Description copied from interface: ClientSessionCreator

Resolves the effective HostConfigEntry and connects to it

Specified by:

connect in interface ClientSessionCreator

Parameters:

uriStr - The server uri to connect to

Returns:

A ConnectFuture

Throws:

IOException - If failed to resolve the effective target or connect to it

See Also:

ClientSessionCreator.connect(HostConfigEntry)

connect

public ConnectFuture connect(String username,
                             SocketAddress targetAddress,
                             AttributeRepository context,
                             SocketAddress localAddress)
                      throws IOException

Description copied from interface: ClientSessionCreator

Resolves the effective HostConfigEntry and connects to it

Specified by:

connect in interface ClientSessionCreator

Parameters:

username - The intended username

targetAddress - The intended target SocketAddress - never null. If this is an InetSocketAddress then the effective HostConfigEntry is resolved and used.

context - An optional "context" to be attached to the established session if successfully connected

localAddress - The local address to use - if null an automatic ephemeral port and bind address is used

Returns:

A ConnectFuture

Throws:

IOException - If failed to resolve the effective target or connect to it

connect

public ConnectFuture connect(String username,
                             String host,
                             int port,
                             AttributeRepository context,
                             SocketAddress localAddress)
                      throws IOException

Description copied from interface: ClientSessionCreator

Resolves the effective HostConfigEntry and connects to it

Specified by:

connect in interface ClientSessionCreator

Parameters:

username - The intended username

host - The target host name/address - never null/empty

port - The target port

context - An optional "context" to be attached to the established session if successfully connected

localAddress - The local address to use - if null an automatic ephemeral port and bind address is used

Returns:

A ConnectFuture

Throws:

IOException - If failed to resolve the effective target or connect to it

connect

public ConnectFuture connect(HostConfigEntry hostConfig,
                             AttributeRepository context,
                             SocketAddress localAddress)
                      throws IOException

Specified by:

connect in interface ClientSessionCreator

Parameters:

hostConfig - The effective HostConfigEntry to connect to - never null

context - An optional "context" to be attached to the established session if successfully connected

localAddress - The local address to use - if null an automatic ephemeral port and bind address is used

Returns:

A ConnectFuture

Throws:

IOException - If failed to create the connection future

doConnect

protected ConnectFuture doConnect(HostConfigEntry hostConfig,
                                  List<HostConfigEntry> jumps,
                                  AttributeRepository context,
                                  SocketAddress localAddress)
                           throws IOException

Throws:

IOException

doConnect

protected ConnectFuture doConnect(String username,
                                  SocketAddress targetAddress,
                                  AttributeRepository context,
                                  SocketAddress localAddress,
                                  KeyIdentityProvider identities,
                                  HostConfigEntry hostConfig)
                           throws IOException

Throws:

IOException

parseProxyJumps

protected List<HostConfigEntry> parseProxyJumps(String proxyJump,
                                                AttributeRepository context)
                                         throws IOException

Throws:

IOException

resolveHost

protected HostConfigEntry resolveHost(String username,
                                      String host,
                                      int port,
                                      AttributeRepository context,
                                      SocketAddress localAddress)
                               throws IOException

Throws:

IOException

preloadClientIdentities

protected KeyIdentityProvider preloadClientIdentities(Collection<? extends NamedResource> locations)
                                               throws IOException

Throws:

IOException

createConnectCompletionListener

protected SshFutureListener<IoConnectFuture> createConnectCompletionListener(ConnectFuture connectFuture,
                                                                             String username,
                                                                             SocketAddress address,
                                                                             KeyIdentityProvider identities,
                                                                             HostConfigEntry hostConfig)

onConnectOperationComplete

protected void onConnectOperationComplete(IoSession ioSession,
                                          ConnectFuture connectFuture,
                                          String username,
                                          SocketAddress address,
                                          KeyIdentityProvider identities,
                                          HostConfigEntry hostConfig)
                                   throws IOException,
                                          GeneralSecurityException

Throws:

IOException

GeneralSecurityException

ensureFilePasswordProvider

protected KeyIdentityProvider ensureFilePasswordProvider(KeyIdentityProvider identities)

Sets this client's FilePasswordProvider on the KeyIdentityProvider if it is an AbstractResourceKeyPairProvider or implements FilePasswordProviderManager and doesn't have one yet. If the given identities is a MultiKeyIdentityProvider, the wrapped identity providers are set up.

Parameters:

identities - KeyIdentityProvider to set up

Returns:

a KeyIdentityProvider configured with a FilePasswordProvider

See Also:

getFilePasswordProvider()

setupDefaultSessionIdentities

protected void setupDefaultSessionIdentities(ClientSession session,
                                             KeyIdentityProvider extraIdentities)
                                      throws IOException,
                                             GeneralSecurityException

Throws:

IOException

GeneralSecurityException

createConnector

protected IoConnector createConnector()

createSessionFactory

protected SessionFactory createSessionFactory()

toString

public String toString()

Overrides:

toString in class Object

setUpDefaultSimpleClient

public static SimpleClient setUpDefaultSimpleClient()

Setup a default client, starts it and then wraps it as a SimpleClient

Returns:

The SimpleClient wrapper. Note: when the wrapper is closed the client is also stopped

See Also:

setUpDefaultClient(), wrapAsSimpleClient(SshClient)

wrapAsSimpleClient

public static SimpleClient wrapAsSimpleClient(SshClient client)

Wraps an SshClient instance as a SimpleClient

Parameters:

client - The client instance - never null. Note: client must be started before the simple client wrapper is used.

Returns:

The SimpleClient wrapper. Note: when the wrapper is closed the client is also stopped

setUpDefaultClient

public static SshClient setUpDefaultClient()

Setup a default client. The client does not require any additional setup.

Returns:

a newly create SshClient with default configurations

setKeyPairProvider

public static <C extends SshClient> C setKeyPairProvider(C client,
                                                         boolean strict,
                                                         boolean supportedOnly,
                                                         FilePasswordProvider provider,
                                                         LinkOption... options)
                                                  throws IOException,
                                                         GeneralSecurityException

Type Parameters:

C - The generic client class

Parameters:

client - The SshClient to updated

strict - If true then files that do not have the required access rights are excluded from consideration

supportedOnly - If true then ignore identities that are not supported internally

provider - A FilePasswordProvider - may be null if the loaded keys are guaranteed not to be encrypted. The argument to FilePasswordProvider#getPassword is the path of the file whose key is to be loaded

options - The LinkOptions to apply when checking for existence

Returns:

The updated client instance - provided a non-null KeyPairProvider was generated

Throws:

IOException - If failed to access the file system

GeneralSecurityException - If failed to load the keys

See Also:

setKeyPairProvider(SshClient, Path, boolean, boolean, FilePasswordProvider, LinkOption...)

setKeyPairProvider

public static <C extends SshClient> C setKeyPairProvider(C client,
                                                         Path dir,
                                                         boolean strict,
                                                         boolean supportedOnly,
                                                         FilePasswordProvider provider,
                                                         LinkOption... options)
                                                  throws IOException,
                                                         GeneralSecurityException

Type Parameters:

C - The generic client class

Parameters:

client - The SshClient to updated

dir - The folder to scan for the built-in identities

strict - If true then files that do not have the required access rights are excluded from consideration

supportedOnly - If true then ignore identities that are not supported internally

provider - A FilePasswordProvider - may be null if the loaded keys are guaranteed not to be encrypted. The argument to FilePasswordProvider#getPassword is the path of the file whose key is to be loaded

options - The LinkOptions to apply when checking for existence

Returns:

The updated client instance - provided a non-null KeyIdentityProvider was generated

Throws:

IOException - If failed to access the file system

GeneralSecurityException - If failed to load the keys

See Also:

ClientIdentity.loadDefaultKeyPairProvider(Path, boolean, boolean, FilePasswordProvider, LinkOption...)