public class JGitSshClient
extends org.apache.sshd.client.SshClient
SshClient
for JGit. It creates specialized
JGitClientSession
s that know about the HostConfigEntry
they
were created for, and it loads all KeyPair identities lazily.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. |
Modifier and Type | Field and Description |
---|---|
private CredentialsProvider |
credentialsProvider |
(package private) static org.apache.sshd.common.AttributeRepository.AttributeKey<org.apache.sshd.client.config.hosts.HostConfigEntry> |
HOST_CONFIG_ENTRY
We need access to this during the constructor of the ClientSession,
before setConnectAddress() can have been called.
|
private KeyCache |
keyCache |
(package private) static org.apache.sshd.common.AttributeRepository.AttributeKey<java.net.InetSocketAddress> |
ORIGINAL_REMOTE_ADDRESS |
static org.apache.sshd.common.AttributeRepository.AttributeKey<java.lang.String> |
PREFERRED_AUTHENTICATIONS
An attribute key for the comma-separated list of default preferred
authentication mechanisms.
|
private ProxyDataFactory |
proxyDatabase |
connector, DEFAULT_SERVICE_FACTORIES, DEFAULT_SSH_CLIENT_FACTORY, DEFAULT_USER_AUTH_FACTORIES, sessionFactory, userAuthFactories, userInteraction
agentFactory, channelFactories, channelListenerProxy, channelListeners, executor, fileSystemFactory, forwarderFactory, forwardingFilter, globalRequestHandlers, ioServiceFactory, ioServiceFactoryFactory, randomFactory, serviceFactories, sessionListenerProxy, sessionListeners, sessionTimeoutListener, shutdownExecutor, timeoutListenerFuture, tunnelListenerProxy, tunnelListeners
closeFuture, lock, state
CLIENT_IDENTIFICATION, DEFAULT_HEARTBEAT_INTERVAL, DEFAULT_IGNORE_INVALID_IDENTITIES, DEFAULT_KEEP_ALIVE_HEARTBEAT_STRING, HEARTBEAT_INTERVAL, HEARTBEAT_REQUEST, IGNORE_INVALID_IDENTITIES
AGENT_FORWARDING_TYPE, AGENT_FORWARDING_TYPE_IETF, AGENT_FORWARDING_TYPE_OPENSSH, AUTH_TIMEOUT, CHANNEL_CLOSE_TIMEOUT, DEFAULT_AUTH_TIMEOUT, DEFAULT_CHANNEL_CLOSE_TIMEOUT, DEFAULT_DISCONNECT_TIMEOUT, DEFAULT_IDLE_TIMEOUT, DEFAULT_IGNORE_MESSAGE_FREQUENCY, DEFAULT_IGNORE_MESSAGE_SIZE, DEFAULT_IGNORE_MESSAGE_VARIANCE, DEFAULT_LIMIT_PACKET_SIZE, DEFAULT_MAX_IDENTIFICATION_SIZE, DEFAULT_MAX_PACKET_SIZE, DEFAULT_NIO_WORKERS, DEFAULT_NIO2_MIN_WRITE_TIMEOUT, DEFAULT_NIO2_READ_TIMEOUT, DEFAULT_REKEY_BYTES_LIMIT, DEFAULT_REKEY_PACKETS_LIMIT, DEFAULT_REKEY_TIME_LIMIT, DEFAULT_STOP_WAIT_TIME, DEFAULT_VERSION, DEFAULT_WINDOW_SIZE, DEFAULT_WINDOW_TIMEOUT, DISCONNECT_TIMEOUT, IDLE_TIMEOUT, IGNORE_MESSAGE_FREQUENCY, IGNORE_MESSAGE_SIZE, IGNORE_MESSAGE_VARIANCE, LIMIT_PACKET_SIZE, MAX_IDENTIFICATION_SIZE, MAX_PACKET_SIZE, NIO_WORKERS, NIO2_MIN_WRITE_TIMEOUT, NIO2_READ_BUFFER_SIZE, NIO2_READ_TIMEOUT, REKEY_BLOCKS_LIMIT, REKEY_BYTES_LIMIT, REKEY_PACKETS_LIMIT, REKEY_TIME_LIMIT, SOCKET_BACKLOG, SOCKET_KEEPALIVE, SOCKET_LINGER, SOCKET_RCVBUF, SOCKET_REUSEADDR, SOCKET_SNDBUF, STOP_WAIT_TIME, TCP_NODELAY, WINDOW_SIZE, WINDOW_TIMEOUT
NONE
Constructor and Description |
---|
JGitSshClient() |
Modifier and Type | Method and Description |
---|---|
private java.net.InetSocketAddress |
configureProxy(ProxyData proxyData,
java.net.InetSocketAddress remoteAddress) |
org.apache.sshd.client.future.ConnectFuture |
connect(org.apache.sshd.client.config.hosts.HostConfigEntry hostConfig,
org.apache.sshd.common.AttributeRepository context,
java.net.SocketAddress localAddress) |
private void |
copyProperty(java.lang.String value,
java.lang.String key) |
private org.apache.sshd.common.future.SshFutureListener<org.apache.sshd.common.io.IoConnectFuture> |
createConnectCompletionListener(org.apache.sshd.client.future.ConnectFuture connectFuture,
java.lang.String username,
java.net.InetSocketAddress address,
org.apache.sshd.client.config.hosts.HostConfigEntry hostConfig) |
private JGitClientSession |
createSession(org.apache.sshd.common.io.IoSession ioSession,
java.lang.String username,
java.net.InetSocketAddress address,
org.apache.sshd.client.config.hosts.HostConfigEntry hostConfig) |
protected org.apache.sshd.client.session.SessionFactory |
createSessionFactory() |
CredentialsProvider |
getCredentialsProvider()
Retrieves the
CredentialsProvider set for this client. |
private int |
getNumberOfPasswordPrompts(org.apache.sshd.client.config.hosts.HostConfigEntry hostConfig) |
private ProxyData |
getProxyData(java.net.InetSocketAddress remoteAddress) |
protected ProxyDataFactory |
getProxyDatabase()
Retrieves the
ProxyDataFactory . |
void |
setCredentialsProvider(CredentialsProvider provider)
Sets the
CredentialsProvider for this client. |
void |
setKeyCache(KeyCache cache)
Set a cache for loaded keys.
|
void |
setProxyDatabase(ProxyDataFactory factory)
Sets a
ProxyDataFactory for connecting through proxies. |
addPasswordIdentity, addPublicKeyIdentity, checkConfig, connect, connect, createConnectCompletionListener, createConnector, doConnect, getClientIdentityLoader, getClientProxyConnector, getFilePasswordProvider, getHostConfigEntryResolver, getInnerCloseable, getKeyIdentityProvider, getPasswordIdentityProvider, getRegisteredIdentities, getServerKeyVerifier, getSessionFactory, getUserAuthFactories, getUserInteraction, isStarted, onConnectOperationComplete, open, preloadClientIdentities, removePasswordIdentity, removePublicKeyIdentity, setClientIdentityLoader, setClientProxyConnector, setFilePasswordProvider, setHostConfigEntryResolver, setKeyIdentityProvider, setKeyPairProvider, setKeyPairProvider, setPasswordIdentityProvider, setServerKeyVerifier, setSessionFactory, setUpDefaultClient, setupDefaultSessionIdentities, setUpDefaultSimpleClient, setUserAuthFactories, setUserInteraction, start, stop, toString, wrapAsSimpleClient
addChannelListener, addPortForwardingEventListener, addSessionListener, attributeKeys, clearAttributes, computeAttributeIfAbsent, createSessionTimeoutListener, getAgentFactory, getAttribute, getAttributesCount, getChannelFactories, getChannelListenerProxy, getChannelStreamPacketWriterResolver, getFileSystemFactory, getForwarderFactory, getForwardingFilter, getGlobalRequestHandlers, getIoServiceEventListener, getIoServiceFactory, getIoServiceFactoryFactory, getNioWorkers, getParentPropertyResolver, getPortForwardingEventListenerProxy, getProperties, getRandomFactory, getReservedSessionMessagesHandler, getScheduledExecutorService, getServiceFactories, getSessionListenerProxy, getUnknownChannelReferenceHandler, getVersion, removeAttribute, removeChannelListener, removePortForwardingEventListener, removeSessionListener, removeSessionTimeout, resolveUnknownChannelReferenceHandler, setAgentFactory, setAttribute, setChannelFactories, setChannelStreamPacketWriterResolver, setFileSystemFactory, setForwarderFactory, setForwardingFilter, setGlobalRequestHandlers, setIoServiceEventListener, setIoServiceFactoryFactory, setNioWorkers, setParentPropertyResolver, setRandomFactory, setReservedSessionMessagesHandler, setScheduledExecutorService, setScheduledExecutorService, setServiceFactories, setUnknownChannelReferenceHandler, setupSessionTimeout, stopSessionTimeoutListener
getCipherFactories, getCompressionFactories, getDelegate, getKeyExchangeFactories, getMacFactories, getSignatureFactories, resolveEffectiveFactories, resolveEffectiveProvider, setCipherFactories, setCompressionFactories, setKeyExchangeFactories, setMacFactories, setSignatureFactories
doCloseGracefully, doCloseImmediately
addCloseFutureListener, builder, close, isClosed, isClosing, preClose, removeCloseFutureListener
getSimplifiedLogger
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getAgentFactory, getAgentForwardingFilter, getChannelFactories, getFileSystemFactory, getForwarderFactory, getForwardingFilter, getGlobalRequestHandlers, getIoServiceFactory, getRandomFactory, getScheduledExecutorService, getServiceFactories, getTcpForwardingFilter, getVersion, getX11ForwardingFilter, resolveAttribute, resolveAttribute
getCipherFactories, getCipherFactoriesNameList, getCipherFactoriesNames, getCompressionFactories, getCompressionFactoriesNameList, getCompressionFactoriesNames, getKeyExchangeFactories, getMacFactories, getMacFactoriesNameList, getMacFactoriesNames, setCipherFactories, setCipherFactoriesNameList, setCipherFactoriesNames, setCipherFactoriesNames, setCompressionFactories, setCompressionFactoriesNameList, setCompressionFactoriesNames, setCompressionFactoriesNames, setKeyExchangeFactories, setMacFactories, setMacFactoriesNameList, setMacFactoriesNames, setMacFactoriesNames
getSignatureFactories, getSignatureFactories, getSignatureFactoriesNameList, getSignatureFactoriesNames, resolveSignatureFactories, setSignatureFactories, setSignatureFactoriesNameList, setSignatureFactoriesNames, setSignatureFactoriesNames
addSessionListener, getSessionListenerProxy, removeSessionListener
getReservedSessionMessagesHandler, setReservedSessionMessagesHandler
addChannelListener, getChannelListenerProxy, removeChannelListener
getChannelStreamPacketWriterResolver, resolveChannelStreamPacketWriter, resolveChannelStreamPacketWriterResolver, setChannelStreamPacketWriterResolver
getUnknownChannelReferenceHandler, resolveUnknownChannelReferenceHandler, setUnknownChannelReferenceHandler
addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener
getIoServiceEventListener, setIoServiceEventListener
clearAttributes, computeAttributeIfAbsent, removeAttribute, setAttribute
attributeKeys, getAttribute, getAttributesCount, ofAttributesMap, ofKeyValuePair
getBoolean, getBooleanProperty, getInteger, getIntProperty, getLong, getLongProperty, getObject, getParentPropertyResolver, getProperties, getString, getStringProperty
providerHolderOf
loaderHolderOf
getUserAuthFactoriesNameList, getUserAuthFactoriesNames, setUserAuthFactoriesNameList, setUserAuthFactoriesNames, setUserAuthFactoriesNames
static final org.apache.sshd.common.AttributeRepository.AttributeKey<org.apache.sshd.client.config.hosts.HostConfigEntry> HOST_CONFIG_ENTRY
static final org.apache.sshd.common.AttributeRepository.AttributeKey<java.net.InetSocketAddress> ORIGINAL_REMOTE_ADDRESS
public static final org.apache.sshd.common.AttributeRepository.AttributeKey<java.lang.String> PREFERRED_AUTHENTICATIONS
private KeyCache keyCache
private CredentialsProvider credentialsProvider
private ProxyDataFactory proxyDatabase
protected org.apache.sshd.client.session.SessionFactory createSessionFactory()
createSessionFactory
in class org.apache.sshd.client.SshClient
public org.apache.sshd.client.future.ConnectFuture connect(org.apache.sshd.client.config.hosts.HostConfigEntry hostConfig, org.apache.sshd.common.AttributeRepository context, java.net.SocketAddress localAddress) throws java.io.IOException
connect
in interface org.apache.sshd.client.session.ClientSessionCreator
connect
in class org.apache.sshd.client.SshClient
java.io.IOException
private void copyProperty(java.lang.String value, java.lang.String key)
private ProxyData getProxyData(java.net.InetSocketAddress remoteAddress)
private java.net.InetSocketAddress configureProxy(ProxyData proxyData, java.net.InetSocketAddress remoteAddress)
private org.apache.sshd.common.future.SshFutureListener<org.apache.sshd.common.io.IoConnectFuture> createConnectCompletionListener(org.apache.sshd.client.future.ConnectFuture connectFuture, java.lang.String username, java.net.InetSocketAddress address, org.apache.sshd.client.config.hosts.HostConfigEntry hostConfig)
private JGitClientSession createSession(org.apache.sshd.common.io.IoSession ioSession, java.lang.String username, java.net.InetSocketAddress address, org.apache.sshd.client.config.hosts.HostConfigEntry hostConfig)
private int getNumberOfPasswordPrompts(org.apache.sshd.client.config.hosts.HostConfigEntry hostConfig)
public void setKeyCache(KeyCache cache)
cache
- to usepublic void setProxyDatabase(ProxyDataFactory factory)
ProxyDataFactory
for connecting through proxies.factory
- to use, or null
if proxying is not desired or
supportedprotected ProxyDataFactory getProxyDatabase()
ProxyDataFactory
.null
if none is setpublic void setCredentialsProvider(CredentialsProvider provider)
CredentialsProvider
for this client.provider
- to setpublic CredentialsProvider getCredentialsProvider()
CredentialsProvider
set for this client.null
if none is set.