Modifier and Type	Class and Description
private static class	JGitSshClient.CombinedKeyIdentityProvider A `KeyIdentityProvider` that iterates over the `Iterable`s returned by other `KeyIdentityProvider`s.
private static class	JGitSshClient.JGitSessionFactory A `SessionFactory` to create our own specialized `JGitClientSession`s.

Field Summary

Modifier and Type	Field and Description
private CredentialsProvider	credentialsProvider
public static final AttributeRepository.AttributeKey<Path>	HOME_DIRECTORY An attribute key for the home directory.
pack-priv static final AttributeRepository.AttributeKey<HostConfigEntry>	HOST_CONFIG_ENTRY We need access to this during the constructor of the ClientSession, before setConnectAddress() can have been called.
private KeyCache	keyCache
private Supplier<KeyPasswordProvider>	keyPasswordProviderFactory
public static final AttributeRepository.AttributeKey<SshdSocketAddress>	LOCAL_FORWARD_ADDRESS An attribute key for storing an alternate local address to connect to if a local forward from a ProxyJump ssh config is present.
pack-priv static final AttributeRepository.AttributeKey<InetSocketAddress>	ORIGINAL_REMOTE_ADDRESS
public static final AttributeRepository.AttributeKey<String>	PREFERRED_AUTHENTICATIONS An attribute key for the comma-separated list of default preferred authentication mechanisms.
private ProxyDataFactory	proxyDatabase

Inherited from org.apache.sshd.client.SshClient:: connector DEFAULT_SERVICE_FACTORIES DEFAULT_SSH_CLIENT_FACTORY DEFAULT_USER_AUTH_FACTORIES sessionFactory userAuthFactories

Constructor Summary

Access	Constructor and Description
public	JGitSshClient()

Method Summary

Modifier and Type	Method and Description
private AttributeRepository	chain(AttributeRepository self, AttributeRepository parent)
private InetSocketAddress	configureProxy(ProxyData proxyData, InetSocketAddress remoteAddress)
public ConnectFuture	connect(HostConfigEntry The effective `HostConfigEntry` to connect to - never `null` hostConfig, AttributeRepository An optional "context" to be attached to the established session if successfully connected context, SocketAddress The local address to use - if `null` an automatic ephemeral port and bind address is used localAddress) Overrides org.apache.sshd.client.SshClient.connect. Implements org.apache.sshd.client.session.ClientSessionCreator.connect.
private SshFutureListener<IoConnectFuture>	createConnectCompletionListener(ConnectFuture connectFuture, String username, InetSocketAddress address, HostConfigEntry hostConfig)
private JGitClientSession	createSession(IoSession ioSession, String username, InetSocketAddress address, HostConfigEntry hostConfig)
protected SessionFactory	createSessionFactory() Overrides org.apache.sshd.client.SshClient.createSessionFactory.
public CredentialsProvider	Returns: the provider, or `null` if none is set. getCredentialsProvider() Retrieves the `CredentialsProvider` set for this client.
public Supplier<KeyPasswordProvider>	Returns: a factory to create `KeyPasswordProvider`s getKeyPasswordProviderFactory() Retrieves the `KeyPasswordProvider` factory of this client.
private int	getNumberOfPasswordPrompts(HostConfigEntry hostConfig)
private ProxyData	getProxyData(InetSocketAddress remoteAddress)
protected ProxyDataFactory	Returns: the factory, or `null` if none is set getProxyDatabase() Retrieves the `ProxyDataFactory`.
private AttributeRepository	sessionAttributes(AttributeRepository parent, HostConfigEntry hostConfig, InetSocketAddress originalAddress)
public void	setCredentialsProvider(CredentialsProvider to set provider) Sets the `CredentialsProvider` for this client.
public void	setKeyCache(KeyCache to use cache) Set a cache for loaded keys.
public void	setKeyPasswordProviderFactory(Supplier<KeyPasswordProvider> to set factory) Sets a supplier for a `KeyPasswordProvider` for this client.
public void	setProxyDatabase(ProxyDataFactory to use, or `null` if proxying is not desired or supported factory) Sets a `ProxyDataFactory` for connecting through proxies.

Inherited from org.apache.sshd.client.SshClient:: addPasswordIdentity addPublicKeyIdentity checkConfig connect connect connect createConnectCompletionListener createConnector doConnect doConnect ensureFilePasswordProvider getClientIdentityLoader getClientProxyConnector getFilePasswordProvider getHostBasedAuthenticationReporter getHostConfigEntryResolver getInnerCloseable getKeyIdentityProvider getPasswordAuthenticationReporter getPasswordIdentityProvider getPublicKeyAuthenticationReporter getRegisteredIdentities getServerKeyVerifier getSessionFactory getUserAuthFactories getUserInteraction isStarted onConnectOperationComplete open parseProxyJumps 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

Field Detail

credentialsProvider	back to summary
private CredentialsProvider credentialsProvider

HOME_DIRECTORY	back to summary
public static final AttributeRepository.AttributeKey<Path> HOME_DIRECTORY An attribute key for the home directory.

HOST_CONFIG_ENTRY	back to summary
pack-priv static final AttributeRepository.AttributeKey<HostConfigEntry> HOST_CONFIG_ENTRY We need access to this during the constructor of the ClientSession, before setConnectAddress() can have been called. So we have to remember it in an attribute on the SshClient, from where we can then retrieve it.

keyCache	back to summary
private KeyCache keyCache

keyPasswordProviderFactory	back to summary
private Supplier<KeyPasswordProvider> keyPasswordProviderFactory

LOCAL_FORWARD_ADDRESS back to summary

LOCAL_FORWARD_ADDRESS	back to summary
public static final AttributeRepository.AttributeKey<SshdSocketAddress> LOCAL_FORWARD_ADDRESS An attribute key for storing an alternate local address to connect to if a local forward from a ProxyJump ssh config is present. If set, `connect(HostConfigEntry, AttributeRepository, SocketAddress)` will not connect to the address obtained from the `HostConfigEntry` but to the address stored in this key (which is assumed to forward the `HostConfigEntry` address).

public static final AttributeRepository.AttributeKey<SshdSocketAddress> LOCAL_FORWARD_ADDRESS

An attribute key for storing an alternate local address to connect to if a local forward from a ProxyJump ssh config is present. If set, connect(HostConfigEntry, AttributeRepository, SocketAddress) will not connect to the address obtained from the HostConfigEntry but to the address stored in this key (which is assumed to forward the HostConfigEntry address).

ORIGINAL_REMOTE_ADDRESS	back to summary
pack-priv static final AttributeRepository.AttributeKey<InetSocketAddress> ORIGINAL_REMOTE_ADDRESS

PREFERRED_AUTHENTICATIONS	back to summary
public static final AttributeRepository.AttributeKey<String> PREFERRED_AUTHENTICATIONS An attribute key for the comma-separated list of default preferred authentication mechanisms.

proxyDatabase	back to summary
private ProxyDataFactory proxyDatabase

Constructor Detail

JGitSshClient	back to summary
public JGitSshClient()

Method Detail

chain	back to summary
private AttributeRepository chain(AttributeRepository self, AttributeRepository parent)

configureProxy	back to summary
private InetSocketAddress configureProxy(ProxyData proxyData, InetSocketAddress remoteAddress)

connect back to summary

connect	back to summary
public ConnectFuture connect(HostConfigEntry hostConfig, AttributeRepository context, SocketAddress localAddress) throws IOException Overrides org.apache.sshd.client.SshClient.connect. Implements org.apache.sshd.client.session.ClientSessionCreator.connect. Parameters hostConfig:HostConfigEntry Doc from org.apache.sshd.client.session.ClientSessionCreator.connect. The effective `HostConfigEntry` to connect to - never `null` context:AttributeRepository Doc from org.apache.sshd.client.session.ClientSessionCreator.connect. An optional "context" to be attached to the established session if successfully connected localAddress:SocketAddress Doc from org.apache.sshd.client.session.ClientSessionCreator.connect. The local address to use - if `null` an automatic ephemeral port and bind address is used Returns:ConnectFuture Doc from org.apache.sshd.client.session.ClientSessionCreator.connect. A `ConnectFuture` Annotations @Override Exceptions IOException: Doc from org.apache.sshd.client.session.ClientSessionCreator.connect. If failed to create the connection future

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

Overrides org.apache.sshd.client.SshClient.connect.

Implements org.apache.sshd.client.session.ClientSessionCreator.connect.

Parameters

hostConfig:HostConfigEntry

Doc from org.apache.sshd.client.session.ClientSessionCreator.connect.

The effective HostConfigEntry to connect to - never null

context:AttributeRepository

Doc from org.apache.sshd.client.session.ClientSessionCreator.connect.

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

localAddress:SocketAddress

Doc from org.apache.sshd.client.session.ClientSessionCreator.connect.

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

Returns:ConnectFuture

Doc from org.apache.sshd.client.session.ClientSessionCreator.connect.

A ConnectFuture

Annotations

@Override

Exceptions

IOException:

Doc from org.apache.sshd.client.session.ClientSessionCreator.connect.

If failed to create the connection future

createConnectCompletionListener	back to summary
private SshFutureListener<IoConnectFuture> createConnectCompletionListener(ConnectFuture connectFuture, String username, InetSocketAddress address, HostConfigEntry hostConfig)

createSession	back to summary
private JGitClientSession createSession(IoSession ioSession, String username, InetSocketAddress address, HostConfigEntry hostConfig)

createSessionFactory	back to summary
protected SessionFactory createSessionFactory() Overrides org.apache.sshd.client.SshClient.createSessionFactory. Annotations @Override

createSessionFactory

back to summary

protected SessionFactory createSessionFactory()

Overrides org.apache.sshd.client.SshClient.createSessionFactory.

Annotations

@Override

getCredentialsProvider back to summary

getCredentialsProvider	back to summary
public CredentialsProvider getCredentialsProvider() Retrieves the `CredentialsProvider` set for this client. Returns:CredentialsProvider the provider, or `null` if none is set.

public CredentialsProvider getCredentialsProvider()

Retrieves the CredentialsProvider set for this client.

Returns:CredentialsProvider: the provider, or null if none is set.

getKeyPasswordProviderFactory back to summary

getKeyPasswordProviderFactory	back to summary
public Supplier<KeyPasswordProvider> getKeyPasswordProviderFactory() Retrieves the `KeyPasswordProvider` factory of this client. Returns:Supplier<KeyPasswordProvider> a factory to create `KeyPasswordProvider`s

public Supplier<KeyPasswordProvider> getKeyPasswordProviderFactory()

Retrieves the KeyPasswordProvider factory of this client.

Returns:Supplier<KeyPasswordProvider>: a factory to create KeyPasswordProviders

getNumberOfPasswordPrompts	back to summary
private int getNumberOfPasswordPrompts(HostConfigEntry hostConfig)

getProxyData	back to summary
private ProxyData getProxyData(InetSocketAddress remoteAddress)

getProxyDatabase back to summary

getProxyDatabase	back to summary
protected ProxyDataFactory getProxyDatabase() Retrieves the `ProxyDataFactory`. Returns:ProxyDataFactory the factory, or `null` if none is set

protected ProxyDataFactory getProxyDatabase()

Retrieves the ProxyDataFactory.

Returns:ProxyDataFactory: the factory, or null if none is set

sessionAttributes	back to summary
private AttributeRepository sessionAttributes(AttributeRepository parent, HostConfigEntry hostConfig, InetSocketAddress originalAddress)

setCredentialsProvider back to summary

setCredentialsProvider	back to summary
public void setCredentialsProvider(CredentialsProvider provider) Sets the `CredentialsProvider` for this client. Parameters provider:CredentialsProvider to set

public void setCredentialsProvider(CredentialsProvider provider)

Sets the CredentialsProvider for this client.

Parameters

provider:CredentialsProvider: to set

setKeyCache	back to summary
public void setKeyCache(KeyCache cache) Set a cache for loaded keys. Newly discovered keys will be added when IdentityFile host entries from the ssh config file are used during session authentication. Parameters cache:KeyCache to use

setKeyCache

back to summary

public void setKeyCache(KeyCache cache)

Set a cache for loaded keys. Newly discovered keys will be added when IdentityFile host entries from the ssh config file are used during session authentication.

Parameters

cache:KeyCache: to use

setKeyPasswordProviderFactory back to summary

setKeyPasswordProviderFactory	back to summary
public void setKeyPasswordProviderFactory(Supplier<KeyPasswordProvider> factory) Sets a supplier for a `KeyPasswordProvider` for this client. Parameters factory:Supplier<KeyPasswordProvider> to set

public void setKeyPasswordProviderFactory(Supplier<KeyPasswordProvider> factory)

Sets a supplier for a KeyPasswordProvider for this client.

Parameters

factory:Supplier<KeyPasswordProvider>: to set

setProxyDatabase back to summary

setProxyDatabase	back to summary
public void setProxyDatabase(ProxyDataFactory factory) Sets a `ProxyDataFactory` for connecting through proxies. Parameters factory:ProxyDataFactory to use, or `null` if proxying is not desired or supported

public void setProxyDatabase(ProxyDataFactory factory)

Sets a ProxyDataFactory for connecting through proxies.

Parameters

factory:ProxyDataFactory: to use, or null if proxying is not desired or supported

org.eclipse.jgit.internal.transport.sshd back to summary

private Class JGitSshClient.CombinedKeyIdentityProvider

Class Inheritance

extends Object
implements KeyIdentityProvider

java.lang.Object
org.eclipse.jgit.internal.transport.sshd.JGitSshClient.CombinedKeyIdentityProvider

All Implemented Interfaces

org.apache.sshd.common.keyprovider.KeyIdentityProvider

A KeyIdentityProvider that iterates over the Iterables returned by other KeyIdentityProviders.

Field Summary

Modifier and Type	Field and Description
private final List<KeyIdentityProvider>	providers

Constructor Summary

Access	Constructor and Description
public	CombinedKeyIdentityProvider(KeyIdentityProvider... providers)
public	CombinedKeyIdentityProvider(List<KeyIdentityProvider> providers)

Method Summary

Modifier and Type	Method and Description
public Iterable<KeyPair>	loadKeys(SessionContext The `SessionContext` for invoking this load command - may be `null` if not invoked within a session context (e.g., offline tool or session unknown). context) Implements org.apache.sshd.common.keyprovider.KeyIdentityProvider.loadKeys. Load available keys.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

providers	back to summary
private final List<KeyIdentityProvider> providers

Constructor Detail

CombinedKeyIdentityProvider	back to summary
public CombinedKeyIdentityProvider(KeyIdentityProvider... providers)

CombinedKeyIdentityProvider	back to summary
public CombinedKeyIdentityProvider(List<KeyIdentityProvider> providers)

Method Detail

loadKeys back to summary

loadKeys	back to summary
public Iterable<KeyPair> loadKeys(SessionContext context) Implements org.apache.sshd.common.keyprovider.KeyIdentityProvider.loadKeys. Doc from org.apache.sshd.common.keyprovider.KeyIdentityProvider.loadKeys. Load available keys. Parameters context:SessionContext The `SessionContext` for invoking this load command - may be `null` if not invoked within a session context (e.g., offline tool or session unknown). Returns:Iterable<KeyPair> an `Iterable` instance of available keys - ignored if `null` Annotations @Override

public Iterable<KeyPair> loadKeys(SessionContext context)

Implements org.apache.sshd.common.keyprovider.KeyIdentityProvider.loadKeys.

Doc from org.apache.sshd.common.keyprovider.KeyIdentityProvider.loadKeys.

Load available keys.

Parameters

context:SessionContext: The SessionContext for invoking this load command - may be null if not invoked within a session context (e.g., offline tool or session unknown).

Returns:Iterable<KeyPair>

an Iterable instance of available keys - ignored if null

Annotations

@Override

public Class JGitSshClient

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class JGitSshClient.CombinedKeyIdentityProvider

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class JGitSshClient.JGitSessionFactory

Constructor Summary

Method Summary

Constructor Detail

Method Detail