Modifier and Type	Class and Description
public static interface	SshdSessionFactoryBuilder.ConfigStoreFactory A factory interface for creating a `SshConfigStore`.
private static class	SshdSessionFactoryBuilder.State

Modifier and Type	Field and Description
private final SshdSessionFactoryBuilder.State	state

Access	Constructor and Description
public	SshdSessionFactoryBuilder()

Method Summary

Modifier and Type	Method and Description
public SshdSessionFactory	Returns: the `SshdSessionFactory` build(KeyCache to use for caching ssh keys; may be `null` if no caching is desired. cache) Builds a `SshdSessionFactory` as configured, using the given `KeyCache` for caching keys.
public SshdSessionFactoryBuilder	Returns: this `SshdSessionFactoryBuilder` setConfigFile(Function<File, File> returning a `File` for the SSH config file to use, or returning `null` if no config file is to be used supplier) Sets a function that returns the SSH config file, given the SSH directory.
public SshdSessionFactoryBuilder	Returns: this `SshdSessionFactoryBuilder` setConfigStoreFactory(SshdSessionFactoryBuilder.ConfigStoreFactory to set factory) Sets a factory for the `SshConfigStore` to use.
public SshdSessionFactoryBuilder	Returns: this `SshdSessionFactoryBuilder` setConnectorFactory(ConnectorFactory `ConnectorFactory` to use factory) Sets an explicit `ConnectorFactory`.
public SshdSessionFactoryBuilder	Returns: this `SshdSessionFactoryBuilder` setDefaultIdentities(Function<File, List<Path>> to get the default private key files supplier) Sets a function that returns the default private key files, given the SSH directory.
public SshdSessionFactoryBuilder	Returns: this `SshdSessionFactoryBuilder` setDefaultKeysProvider(Function<File, Iterable<KeyPair>> to get the default private key files provider) Sets a function that returns the default private keys, given the SSH directory.
public SshdSessionFactoryBuilder	Returns: this `SshdSessionFactoryBuilder` setDefaultKnownHostsFiles(Function<File, List<Path>> to get the default known hosts files supplier) Sets a function that returns the default known hosts files, given the SSH directory.
public SshdSessionFactoryBuilder	Returns: this `SshdSessionFactoryBuilder` setHomeDirectory(File to use; may be `null`, in which case the home directory as defined by `FS.userHome()` is assumed homeDirectory) Sets the home directory to use for `SshdSessionFactories` created by `build(KeyCache)`.
public SshdSessionFactoryBuilder	Returns: this `SshdSessionFactoryBuilder` setKeyPasswordProvider(Function<CredentialsProvider, KeyPasswordProvider> to create a `KeyPasswordProvider` factory) Sets a factory function to create a `KeyPasswordProvider`.
public SshdSessionFactoryBuilder	Returns: this `SshdSessionFactoryBuilder` setPreferredAuthentications(String comma-separated list of authentication mechanism names; if `null` or empty, the default as specified by `SshdSessionFactory#getDefaultPreferredAuthentications()` will be used authentications) Sets the default preferred authentication mechanisms to use for `SshdSessionFactories` created by `build(KeyCache)`.
public SshdSessionFactoryBuilder	Returns: this `SshdSessionFactoryBuilder` setProxyDataFactory(ProxyDataFactory to use proxyDataFactory) Sets the `ProxyDataFactory` to use for `SshdSessionFactories` created by `build(KeyCache)`.
public SshdSessionFactoryBuilder	Returns: this `SshdSessionFactoryBuilder` setServerKeyDatabase(BiFunction<File, File, ServerKeyDatabase> to create a `ServerKeyDatabase` factory) Sets a function that creates a new `ServerKeyDatabase`, given the SSH and home directory.
public SshdSessionFactoryBuilder	Returns: this `SshdSessionFactoryBuilder` setSshDirectory(File to use; may be `null`, in which case ".ssh" under the `home directory` is assumed sshDirectory) Sets the SSH directory to use for `SshdSessionFactories` created by `build(KeyCache)`.
public SshdSessionFactoryBuilder	Returns: this `SshdSessionFactoryBuilder` withDefaultConnectorFactory() Removes a previously set `ConnectorFactory`.

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

Field Detail

state	back to summary
private final SshdSessionFactoryBuilder.State state

SshdSessionFactoryBuilder	back to summary
public SshdSessionFactoryBuilder()

Method Detail

build back to summary

build	back to summary
public SshdSessionFactory build(KeyCache cache) Builds a `SshdSessionFactory` as configured, using the given `KeyCache` for caching keys. Different `SshdSessionFactories` should not share the same `KeyCache` since the cache is invalidated when the factory itself or when the last `SshdSession` created from the factory is closed. Parameters cache:KeyCache to use for caching ssh keys; may be `null` if no caching is desired. Returns:SshdSessionFactory the `SshdSessionFactory`

public SshdSessionFactory build(KeyCache cache)

Builds a SshdSessionFactory as configured, using the given KeyCache for caching keys.

Different SshdSessionFactories should not share the same KeyCache since the cache is invalidated when the factory itself or when the last SshdSession created from the factory is closed.

Parameters

cache:KeyCache: to use for caching ssh keys; may be null if no caching is desired.

Returns:SshdSessionFactory

the SshdSessionFactory

setConfigFile back to summary

setConfigFile	back to summary
public SshdSessionFactoryBuilder setConfigFile(Function<File, File> supplier) Sets a function that returns the SSH config file, given the SSH directory. The function may return `null`, in which case no SSH config file will be used. If a non-null file is returned, it will be used when it exists. If no supplier has been set, or the supplier has been set explicitly to `null`, by default a file named `SshConstants.CONFIG` in the `SSH directory` is used. Parameters supplier:Function<File, File> returning a `File` for the SSH config file to use, or returning `null` if no config file is to be used Returns:SshdSessionFactoryBuilder this `SshdSessionFactoryBuilder`

public SshdSessionFactoryBuilder setConfigFile(Function<File, File> supplier)

Sets a function that returns the SSH config file, given the SSH directory. The function may return null, in which case no SSH config file will be used. If a non-null file is returned, it will be used when it exists. If no supplier has been set, or the supplier has been set explicitly to null, by default a file named SshConstants.CONFIG in the SSH directory is used.

Parameters

supplier:Function<File, File>: returning a File for the SSH config file to use, or returning null if no config file is to be used

Returns:SshdSessionFactoryBuilder

this SshdSessionFactoryBuilder

setConfigStoreFactory back to summary

setConfigStoreFactory	back to summary
public SshdSessionFactoryBuilder setConfigStoreFactory(SshdSessionFactoryBuilder.ConfigStoreFactory factory) Sets a factory for the `SshConfigStore` to use. If not set or explicitly set to `null`, the default as specified by `SshdSessionFactory#createSshConfigStore(File, File, String)` is used. Parameters factory:SshdSessionFactoryBuilder.ConfigStoreFactory to set Returns:SshdSessionFactoryBuilder this `SshdSessionFactoryBuilder`

public SshdSessionFactoryBuilder setConfigStoreFactory(SshdSessionFactoryBuilder.ConfigStoreFactory factory)

Sets a factory for the SshConfigStore to use. If not set or explicitly set to null, the default as specified by SshdSessionFactory#createSshConfigStore(File, File, String) is used.

Parameters

factory:SshdSessionFactoryBuilder.ConfigStoreFactory: to set

Returns:SshdSessionFactoryBuilder

this SshdSessionFactoryBuilder

setConnectorFactory back to summary

setConnectorFactory	back to summary
public SshdSessionFactoryBuilder setConnectorFactory(ConnectorFactory factory) Sets an explicit `ConnectorFactory`. If `null`, there will be no support for SSH agents. If not set, the created `SshdSessionFactory` will use the `java.util.ServiceLoader` to find an `ConnectorFactory`. Parameters factory:ConnectorFactory `ConnectorFactory` to use Returns:SshdSessionFactoryBuilder this `SshdSessionFactoryBuilder` Since 6.0

public SshdSessionFactoryBuilder setConnectorFactory(ConnectorFactory factory)

Sets an explicit ConnectorFactory. If null, there will be no support for SSH agents.

If not set, the created SshdSessionFactory will use the java.util.ServiceLoader to find an ConnectorFactory.

Parameters

factory:ConnectorFactory: ConnectorFactory to use

Returns:SshdSessionFactoryBuilder

this SshdSessionFactoryBuilder

Since

6.0

setDefaultIdentities back to summary

setDefaultIdentities	back to summary
public SshdSessionFactoryBuilder setDefaultIdentities(Function<File, List<Path>> supplier) Sets a function that returns the default private key files, given the SSH directory. If not set or explicitly set to `null`, the defaults as specified by `SshdSessionFactory#getDefaultIdentities(File)` are used. Parameters supplier:Function<File, List<Path>> to get the default private key files Returns:SshdSessionFactoryBuilder this `SshdSessionFactoryBuilder`

public SshdSessionFactoryBuilder setDefaultIdentities(Function<File, List<Path>> supplier)

Sets a function that returns the default private key files, given the SSH directory. If not set or explicitly set to null, the defaults as specified by SshdSessionFactory#getDefaultIdentities(File) are used.

Parameters

supplier:Function<File, List<Path>>: to get the default private key files

Returns:SshdSessionFactoryBuilder

this SshdSessionFactoryBuilder

setDefaultKeysProvider back to summary

setDefaultKeysProvider	back to summary
public SshdSessionFactoryBuilder setDefaultKeysProvider(Function<File, Iterable<KeyPair>> provider) Sets a function that returns the default private keys, given the SSH directory. If not set or explicitly set to `null`, the defaults as specified by `SshdSessionFactory#getDefaultKeys(File)` are used. Parameters provider:Function<File, Iterable<KeyPair>> to get the default private key files Returns:SshdSessionFactoryBuilder this `SshdSessionFactoryBuilder`

public SshdSessionFactoryBuilder setDefaultKeysProvider(Function<File, Iterable<KeyPair>> provider)

Sets a function that returns the default private keys, given the SSH directory. If not set or explicitly set to null, the defaults as specified by SshdSessionFactory#getDefaultKeys(File) are used.

Parameters

provider:Function<File, Iterable<KeyPair>>: to get the default private key files

Returns:SshdSessionFactoryBuilder

this SshdSessionFactoryBuilder

setDefaultKnownHostsFiles back to summary

setDefaultKnownHostsFiles	back to summary
public SshdSessionFactoryBuilder setDefaultKnownHostsFiles(Function<File, List<Path>> supplier) Sets a function that returns the default known hosts files, given the SSH directory. If not set or explicitly set to `null`, the defaults as specified by `SshdSessionFactory#getDefaultKnownHostsFiles(File)` are used. Parameters supplier:Function<File, List<Path>> to get the default known hosts files Returns:SshdSessionFactoryBuilder this `SshdSessionFactoryBuilder`

public SshdSessionFactoryBuilder setDefaultKnownHostsFiles(Function<File, List<Path>> supplier)

Sets a function that returns the default known hosts files, given the SSH directory. If not set or explicitly set to null, the defaults as specified by SshdSessionFactory#getDefaultKnownHostsFiles(File) are used.

Parameters

supplier:Function<File, List<Path>>: to get the default known hosts files

Returns:SshdSessionFactoryBuilder

this SshdSessionFactoryBuilder

setHomeDirectory back to summary

setHomeDirectory	back to summary
public SshdSessionFactoryBuilder setHomeDirectory(File homeDirectory) Sets the home directory to use for `SshdSessionFactories` created by `build(KeyCache)`. Parameters homeDirectory:File to use; may be `null`, in which case the home directory as defined by `FS.userHome()` is assumed Returns:SshdSessionFactoryBuilder this `SshdSessionFactoryBuilder`

public SshdSessionFactoryBuilder setHomeDirectory(File homeDirectory)

Sets the home directory to use for SshdSessionFactories created by build(KeyCache).

Parameters

homeDirectory:File: to use; may be null, in which case the home directory as defined by FS.userHome() is assumed

Returns:SshdSessionFactoryBuilder

this SshdSessionFactoryBuilder

setKeyPasswordProvider back to summary

setKeyPasswordProvider	back to summary
public SshdSessionFactoryBuilder setKeyPasswordProvider(Function<CredentialsProvider, KeyPasswordProvider> factory) Sets a factory function to create a `KeyPasswordProvider`. If not set or explicitly set to `null`, or if the factory returns `null`, the default as specified by `SshdSessionFactory#createKeyPasswordProvider(CredentialsProvider)` is used. Parameters factory:Function<CredentialsProvider, KeyPasswordProvider> to create a `KeyPasswordProvider` Returns:SshdSessionFactoryBuilder this `SshdSessionFactoryBuilder`

public SshdSessionFactoryBuilder setKeyPasswordProvider(Function<CredentialsProvider, KeyPasswordProvider> factory)

Sets a factory function to create a KeyPasswordProvider. If not set or explicitly set to null, or if the factory returns null, the default as specified by SshdSessionFactory#createKeyPasswordProvider(CredentialsProvider) is used.

Parameters

factory:Function<CredentialsProvider, KeyPasswordProvider>: to create a KeyPasswordProvider

Returns:SshdSessionFactoryBuilder

this SshdSessionFactoryBuilder

setPreferredAuthentications back to summary

setPreferredAuthentications	back to summary
public SshdSessionFactoryBuilder setPreferredAuthentications(String authentications) Sets the default preferred authentication mechanisms to use for `SshdSessionFactories` created by `build(KeyCache)`. Parameters authentications:String comma-separated list of authentication mechanism names; if `null` or empty, the default as specified by `SshdSessionFactory#getDefaultPreferredAuthentications()` will be used Returns:SshdSessionFactoryBuilder this `SshdSessionFactoryBuilder`

public SshdSessionFactoryBuilder setPreferredAuthentications(String authentications)

Sets the default preferred authentication mechanisms to use for SshdSessionFactories created by build(KeyCache).

Parameters

authentications:String: comma-separated list of authentication mechanism names; if null or empty, the default as specified by SshdSessionFactory#getDefaultPreferredAuthentications() will be used

Returns:SshdSessionFactoryBuilder

this SshdSessionFactoryBuilder

setProxyDataFactory back to summary

setProxyDataFactory	back to summary
public SshdSessionFactoryBuilder setProxyDataFactory(ProxyDataFactory proxyDataFactory) Sets the `ProxyDataFactory` to use for `SshdSessionFactories` created by `build(KeyCache)`. Parameters proxyDataFactory:ProxyDataFactory to use Returns:SshdSessionFactoryBuilder this `SshdSessionFactoryBuilder`

public SshdSessionFactoryBuilder setProxyDataFactory(ProxyDataFactory proxyDataFactory)

Sets the ProxyDataFactory to use for SshdSessionFactories created by build(KeyCache).

Parameters

proxyDataFactory:ProxyDataFactory: to use

Returns:SshdSessionFactoryBuilder

this SshdSessionFactoryBuilder

setServerKeyDatabase back to summary

setServerKeyDatabase	back to summary
public SshdSessionFactoryBuilder setServerKeyDatabase(BiFunction<File, File, ServerKeyDatabase> factory) Sets a function that creates a new `ServerKeyDatabase`, given the SSH and home directory. If not set or explicitly set to `null`, or if the `factory` returns `null`, the default as specified by `SshdSessionFactory#createServerKeyDatabase(File, File)` is used. Parameters factory:BiFunction<File, File, ServerKeyDatabase> to create a `ServerKeyDatabase` Returns:SshdSessionFactoryBuilder this `SshdSessionFactoryBuilder`

public SshdSessionFactoryBuilder setServerKeyDatabase(BiFunction<File, File, ServerKeyDatabase> factory)

Sets a function that creates a new ServerKeyDatabase, given the SSH and home directory. If not set or explicitly set to null, or if the factory returns null, the default as specified by SshdSessionFactory#createServerKeyDatabase(File, File) is used.

Parameters

factory:BiFunction<File, File, ServerKeyDatabase>: to create a ServerKeyDatabase

Returns:SshdSessionFactoryBuilder

this SshdSessionFactoryBuilder

setSshDirectory back to summary

setSshDirectory	back to summary
public SshdSessionFactoryBuilder setSshDirectory(File sshDirectory) Sets the SSH directory to use for `SshdSessionFactories` created by `build(KeyCache)`. Parameters sshDirectory:File to use; may be `null`, in which case ".ssh" under the `home directory` is assumed Returns:SshdSessionFactoryBuilder this `SshdSessionFactoryBuilder`

public SshdSessionFactoryBuilder setSshDirectory(File sshDirectory)

Sets the SSH directory to use for SshdSessionFactories created by build(KeyCache).

Parameters

sshDirectory:File: to use; may be null, in which case ".ssh" under the home directory is assumed

Returns:SshdSessionFactoryBuilder

this SshdSessionFactoryBuilder

withDefaultConnectorFactory back to summary

withDefaultConnectorFactory	back to summary
public SshdSessionFactoryBuilder withDefaultConnectorFactory() Removes a previously set `ConnectorFactory`. The created `SshdSessionFactory` will use the `java.util.ServiceLoader` to find an `ConnectorFactory`. This is also the default if `setConnectorFactory(ConnectorFactory)` isn't called at all. Returns:SshdSessionFactoryBuilder this `SshdSessionFactoryBuilder` Since 6.0

public SshdSessionFactoryBuilder withDefaultConnectorFactory()

Removes a previously set ConnectorFactory. The created SshdSessionFactory will use the java.util.ServiceLoader to find an ConnectorFactory. This is also the default if setConnectorFactory(ConnectorFactory) isn't called at all.

Returns:SshdSessionFactoryBuilder: this SshdSessionFactoryBuilder
Since: 6.0

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

public Interface SshdSessionFactoryBuilder.ConfigStoreFactory

Annotations

@FunctionalInterface

A factory interface for creating a SshConfigStore.

Method Summary

Modifier and Type	Method and Description
public SshConfigStore	Returns: the `SshConfigStore`, or `null` if none is to be used create(File to use for ~-replacements homeDir, File to use, may be `null` if none configFile, String name of the current user in the local OS localUserName) Creates a `SshConfigStore`.

Method Detail

create back to summary

create	back to summary
public SshConfigStore create(File homeDir, File configFile, String localUserName) Creates a `SshConfigStore`. May return `null` if none is to be used. Parameters homeDir:File to use for ~-replacements configFile:File to use, may be `null` if none localUserName:String name of the current user in the local OS Returns:SshConfigStore the `SshConfigStore`, or `null` if none is to be used

public SshConfigStore create(File homeDir, File configFile, String localUserName)

Creates a SshConfigStore. May return null if none is to be used.

Parameters

homeDir:File: to use for ~-replacements
configFile:File: to use, may be null if none
localUserName:String: name of the current user in the local OS

Returns:SshConfigStore

the SshConfigStore, or null if none is to be used

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

private Class SshdSessionFactoryBuilder.State

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jgit.transport.sshd.SshdSessionFactoryBuilder.State

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	SshdSessionFactoryBuilder.State.SessionFactory

Field Summary

Modifier and Type	Field and Description
pack-priv SshdSessionFactoryBuilder.ConfigStoreFactory	configFactory
pack-priv Function<File, File>	configFileFinder
pack-priv ConnectorFactory	connectorFactory
pack-priv boolean	connectorFactorySet
pack-priv Function<File, List<Path>>	defaultKeyFileFinder
pack-priv Function<File, Iterable<KeyPair>>	defaultKeysProvider
pack-priv File	homeDirectory
pack-priv Function<File, List<Path>>	knownHostsFileFinder
pack-priv Function<CredentialsProvider, KeyPasswordProvider>	passphraseProviderFactory
pack-priv String	preferredAuthentications
pack-priv ProxyDataFactory	proxyDataFactory
pack-priv BiFunction<File, File, ServerKeyDatabase>	serverKeyDatabaseCreator
pack-priv File	sshDirectory

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
pack-priv SshdSessionFactory	build(KeyCache cache)
pack-priv SshdSessionFactoryBuilder.State	copy()

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

Field Detail

configFactory	back to summary
pack-priv SshdSessionFactoryBuilder.ConfigStoreFactory configFactory

configFileFinder	back to summary
pack-priv Function<File, File> configFileFinder

connectorFactory	back to summary
pack-priv ConnectorFactory connectorFactory

connectorFactorySet	back to summary
pack-priv boolean connectorFactorySet

defaultKeyFileFinder	back to summary
pack-priv Function<File, List<Path>> defaultKeyFileFinder

defaultKeysProvider	back to summary
pack-priv Function<File, Iterable<KeyPair>> defaultKeysProvider

homeDirectory	back to summary
pack-priv File homeDirectory

knownHostsFileFinder	back to summary
pack-priv Function<File, List<Path>> knownHostsFileFinder

passphraseProviderFactory	back to summary
pack-priv Function<CredentialsProvider, KeyPasswordProvider> passphraseProviderFactory

preferredAuthentications	back to summary
pack-priv String preferredAuthentications

proxyDataFactory	back to summary
pack-priv ProxyDataFactory proxyDataFactory

serverKeyDatabaseCreator	back to summary
pack-priv BiFunction<File, File, ServerKeyDatabase> serverKeyDatabaseCreator

sshDirectory	back to summary
pack-priv File sshDirectory

Constructor Detail

State	back to summary
private State()

Method Detail

build	back to summary
pack-priv SshdSessionFactory build(KeyCache cache)

copy	back to summary
pack-priv SshdSessionFactoryBuilder.State copy()

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

private Class SshdSessionFactoryBuilder.State.SessionFactory

Class Inheritance

extends SshdSessionFactory

java.lang.Object
org.eclipse.jgit.transport.SshSessionFactory
org.eclipse.jgit.transport.sshd.SshdSessionFactory
org.eclipse.jgit.transport.sshd.SshdSessionFactoryBuilder.State.SessionFactory

Constructor Summary

Access	Constructor and Description
public	SessionFactory(KeyCache cache, ProxyDataFactory proxyDataFactory)

Method Summary

Modifier and Type	Method and Description
protected KeyPasswordProvider	createKeyPasswordProvider(CredentialsProvider the `CredentialsProvider` to delegate to for user interactions provider) Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.createKeyPasswordProvider. Creates a `KeyPasswordProvider` for a new session.
protected ServerKeyDatabase	createServerKeyDatabase(File home directory to use for ~ replacement homeDir, File representing ~/.ssh/ sshDir) Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.createServerKeyDatabase. Creates a `ServerKeyDatabase` to verify server host keys.
protected SshConfigStore	createSshConfigStore(File may be used for ~-replacements by the returned config store homeDir, File to use, or `null` if none configFile, String user name of the current user on the local OS localUserName) Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.createSshConfigStore. Obtains a `SshConfigStore`, or `null` if no SSH config is to be used.
protected ConnectorFactory	getConnectorFactory() Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.getConnectorFactory. Gets a `ConnectorFactory`.
protected List<Path>	getDefaultIdentities(File the directory that represents ~/.ssh/ sshDir) Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.getDefaultIdentities. Gets a list of default identities, i.e., private key files that shall always be tried for public key authentication.
protected Iterable<KeyPair>	getDefaultKeys(File to look in for keys sshDir) Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.getDefaultKeys. Determines the default keys.
protected List<Path>	getDefaultKnownHostsFiles(File directory containing ssh configurations sshDir) Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.getDefaultKnownHostsFiles. Gets the list of default user known hosts files.
protected String	getDefaultPreferredAuthentications() Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.getDefaultPreferredAuthentications. Gets the list of default preferred authentication mechanisms.
protected File	getSshConfig(File representing ~/.ssh/ sshDir) Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.getSshConfig. Determines the ssh config file.

Inherited from org.eclipse.jgit.transport.sshd.SshdSessionFactory:: close getHomeDirectory getKeyCache getServerKeyDatabase getSession getSshDirectory getType setHomeDirectory setSshDirectory

Constructor Detail

SessionFactory	back to summary
public SessionFactory(KeyCache cache, ProxyDataFactory proxyDataFactory)

Method Detail

createKeyPasswordProvider back to summary

createKeyPasswordProvider	back to summary
protected KeyPasswordProvider createKeyPasswordProvider(CredentialsProvider provider) Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.createKeyPasswordProvider. Doc from org.eclipse.jgit.transport.sshd.SshdSessionFactory.createKeyPasswordProvider. Creates a `KeyPasswordProvider` for a new session. Parameters provider:CredentialsProvider the `CredentialsProvider` to delegate to for user interactions Returns:KeyPasswordProvider a new `KeyPasswordProvider`, or `null` to use the global `KeyPasswordProviderFactory` Annotations @Override

protected KeyPasswordProvider createKeyPasswordProvider(CredentialsProvider provider)

Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.createKeyPasswordProvider.

Doc from org.eclipse.jgit.transport.sshd.SshdSessionFactory.createKeyPasswordProvider.

Creates a KeyPasswordProvider for a new session.

Parameters

provider:CredentialsProvider: the CredentialsProvider to delegate to for user interactions

Returns:KeyPasswordProvider

a new KeyPasswordProvider, or null to use the global KeyPasswordProviderFactory

Annotations

@Override

createServerKeyDatabase back to summary

createServerKeyDatabase	back to summary
protected ServerKeyDatabase createServerKeyDatabase(File homeDir, File sshDir) Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.createServerKeyDatabase. Doc from org.eclipse.jgit.transport.sshd.SshdSessionFactory.createServerKeyDatabase. Creates a `ServerKeyDatabase` to verify server host keys. The default implementation returns a `ServerKeyDatabase` that recognizes the two openssh standard files `~/.ssh/known_hosts` and `~/.ssh/known_hosts2` as well as any files configured via the `UserKnownHostsFile` option in the ssh config file. Parameters homeDir:File home directory to use for ~ replacement sshDir:File representing ~/.ssh/ Returns:ServerKeyDatabase the `ServerKeyDatabase` Annotations @Override

protected ServerKeyDatabase createServerKeyDatabase(File homeDir, File sshDir)

Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.createServerKeyDatabase.

Doc from org.eclipse.jgit.transport.sshd.SshdSessionFactory.createServerKeyDatabase.

Creates a ServerKeyDatabase to verify server host keys. The default implementation returns a ServerKeyDatabase that recognizes the two openssh standard files ~/.ssh/known_hosts and ~/.ssh/known_hosts2 as well as any files configured via the UserKnownHostsFile option in the ssh config file.

Parameters

homeDir:File: home directory to use for ~ replacement
sshDir:File: representing ~/.ssh/

Returns:ServerKeyDatabase

the ServerKeyDatabase

Annotations

@Override

createSshConfigStore back to summary

createSshConfigStore	back to summary
protected SshConfigStore createSshConfigStore(File homeDir, File configFile, String localUserName) Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.createSshConfigStore. Doc from org.eclipse.jgit.transport.sshd.SshdSessionFactory.createSshConfigStore. Obtains a `SshConfigStore`, or `null` if no SSH config is to be used. The default implementation returns `null` if `configFile == null` and otherwise an OpenSSH-compatible store reading host entries from the given file. Parameters homeDir:File may be used for ~-replacements by the returned config store configFile:File to use, or `null` if none localUserName:String user name of the current user on the local OS Returns:SshConfigStore A `SshConfigStore`, or `null` if none is to be used Annotations @Override

protected SshConfigStore createSshConfigStore(File homeDir, File configFile, String localUserName)

Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.createSshConfigStore.

Doc from org.eclipse.jgit.transport.sshd.SshdSessionFactory.createSshConfigStore.

Obtains a SshConfigStore, or null if no SSH config is to be used. The default implementation returns null if configFile == null and otherwise an OpenSSH-compatible store reading host entries from the given file.

Parameters

homeDir:File: may be used for ~-replacements by the returned config store
configFile:File: to use, or null if none
localUserName:String: user name of the current user on the local OS

Returns:SshConfigStore

A SshConfigStore, or null if none is to be used

Annotations

@Override

getConnectorFactory back to summary

getConnectorFactory	back to summary
protected ConnectorFactory getConnectorFactory() Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.getConnectorFactory. Doc from org.eclipse.jgit.transport.sshd.SshdSessionFactory.getConnectorFactory. Gets a `ConnectorFactory`. If this returns `null`, SSH agents are not supported. The default implementation uses `ConnectorFactory#getDefault()` Returns:ConnectorFactory the factory, or `null` if no SSH agent support is desired Annotations @Override

protected ConnectorFactory getConnectorFactory()

Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.getConnectorFactory.

Doc from org.eclipse.jgit.transport.sshd.SshdSessionFactory.getConnectorFactory.

Gets a ConnectorFactory. If this returns null, SSH agents are not supported.

The default implementation uses ConnectorFactory#getDefault()

Returns:ConnectorFactory

the factory, or null if no SSH agent support is desired

Annotations

@Override

getDefaultIdentities back to summary

getDefaultIdentities	back to summary
protected List<Path> getDefaultIdentities(File sshDir) Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.getDefaultIdentities. Doc from org.eclipse.jgit.transport.sshd.SshdSessionFactory.getDefaultIdentities. Gets a list of default identities, i.e., private key files that shall always be tried for public key authentication. Typically those are ~/.ssh/id_dsa, ~/.ssh/id_rsa, and so on. The default implementation returns the files defined in `SshConstants#DEFAULT_IDENTITIES`. Parameters sshDir:File the directory that represents ~/.ssh/ Returns:List<Path> a possibly empty list of paths containing default identities (private keys) Annotations @Override

protected List<Path> getDefaultIdentities(File sshDir)

Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.getDefaultIdentities.

Doc from org.eclipse.jgit.transport.sshd.SshdSessionFactory.getDefaultIdentities.

Gets a list of default identities, i.e., private key files that shall always be tried for public key authentication. Typically those are ~/.ssh/id_dsa, ~/.ssh/id_rsa, and so on. The default implementation returns the files defined in SshConstants#DEFAULT_IDENTITIES.

Parameters

sshDir:File: the directory that represents ~/.ssh/

Returns:List<Path>

a possibly empty list of paths containing default identities (private keys)

Annotations

@Override

getDefaultKeys back to summary

protected Iterable<KeyPair> getDefaultKeys(File sshDir)

Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.getDefaultKeys.

Doc from org.eclipse.jgit.transport.sshd.SshdSessionFactory.getDefaultKeys.

Determines the default keys. The default implementation will lazy load the default identity files.

Subclasses may override and return an Iterable of whatever keys are appropriate. If the returned iterable lazily loads keys, it should be an instance of AbstractResourceKeyPairProvider so that the session can later pass it the password provider wrapped as a FilePasswordProvider via AbstractResourceKeyPairProvider#setPasswordFinder(FilePasswordProvider) so that encrypted, password-protected keys can be loaded.

The default implementation uses exactly this mechanism; class CachingKeyPairProvider may serve as a model for a customized lazy-loading Iterable implementation

If the Iterable returned has the keys already pre-loaded or otherwise doesn't need to decrypt encrypted keys, it can be any Iterable, for instance a simple List.

Parameters

sshDir:File: to look in for keys

Returns:Iterable<KeyPair>

an Iterable over the default keys

Annotations

@Override

getDefaultKnownHostsFiles back to summary

protected List<Path> getDefaultKnownHostsFiles(File sshDir)

Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.getDefaultKnownHostsFiles.

Doc from org.eclipse.jgit.transport.sshd.SshdSessionFactory.getDefaultKnownHostsFiles.

Gets the list of default user known hosts files. The default returns ~/.ssh/known_hosts and ~/.ssh/known_hosts2. The ssh config UserKnownHostsFile overrides this default.

Parameters

sshDir:File: directory containing ssh configurations

Returns:List<Path>

the possibly empty list of default known host file paths.

Annotations

@Override

getDefaultPreferredAuthentications back to summary

protected String getDefaultPreferredAuthentications()

Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.getDefaultPreferredAuthentications.

Doc from org.eclipse.jgit.transport.sshd.SshdSessionFactory.getDefaultPreferredAuthentications.

Gets the list of default preferred authentication mechanisms. If null is returned the openssh default list will be in effect. If the ssh config defines PreferredAuthentications the value from the ssh config takes precedence.

Returns:String

a comma-separated list of mechanism names, or null if none

Annotations

@Override

getSshConfig back to summary

protected File getSshConfig(File sshDir)

Overrides org.eclipse.jgit.transport.sshd.SshdSessionFactory.getSshConfig.

Doc from org.eclipse.jgit.transport.sshd.SshdSessionFactory.getSshConfig.

Determines the ssh config file. The default implementation returns ~/.ssh/config. If the file does not exist and is created later it will be picked up. To not use a config file at all, return null.

Parameters

sshDir:File: representing ~/.ssh/

Returns:File

the file (need not exist), or null if no config file shall be used

Annotations

@Override

public final Class SshdSessionFactoryBuilder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface SshdSessionFactoryBuilder.ConfigStoreFactory

Method Summary

Method Detail

private Class SshdSessionFactoryBuilder.State

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class SshdSessionFactoryBuilder.State.SessionFactory

Constructor Summary

Method Summary

Constructor Detail

Method Detail