Package org.eclipse.jgit.transport.sshd

Class SshdSessionFactoryBuilder

java.lang.Object

org.eclipse.jgit.transport.sshd.SshdSessionFactoryBuilder

public final class SshdSessionFactoryBuilder
extends Object

A builder API to configure SshdSessionFactories.

Since:

5.8

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SshdSessionFactoryBuilder.ConfigStoreFactory	A factory interface for creating a SshConfigStore.

Constructor Summary

Constructors

Constructor	Description
SshdSessionFactoryBuilder()

Method Summary

Modifier and Type	Method	Description
SshdSessionFactory	build(KeyCache cache)	Builds a SshdSessionFactory as configured, using the given KeyCache for caching keys.
SshdSessionFactoryBuilder	setConfigFile(Function<File,File> supplier)	Sets a function that returns the SSH config file, given the SSH directory.
SshdSessionFactoryBuilder	setConfigStoreFactory(SshdSessionFactoryBuilder.ConfigStoreFactory factory)	Sets a factory for the SshConfigStore to use.
SshdSessionFactoryBuilder	setConnectorFactory(ConnectorFactory factory)	Sets an explicit ConnectorFactory.
SshdSessionFactoryBuilder	setDefaultIdentities(Function<File,List<Path>> supplier)	Sets a function that returns the default private key files, given the SSH directory.
SshdSessionFactoryBuilder	setDefaultKeysProvider(Function<File,Iterable<KeyPair>> provider)	Sets a function that returns the default private keys, given the SSH directory.
SshdSessionFactoryBuilder	setDefaultKnownHostsFiles(Function<File,List<Path>> supplier)	Sets a function that returns the default known hosts files, given the SSH directory.
SshdSessionFactoryBuilder	setHomeDirectory(File homeDirectory)	Sets the home directory to use for SshdSessionFactories created by build(KeyCache).
SshdSessionFactoryBuilder	setKeyPasswordProvider(Function<CredentialsProvider,KeyPasswordProvider> factory)	Sets a factory function to create a KeyPasswordProvider.
SshdSessionFactoryBuilder	setPreferredAuthentications(String authentications)	Sets the default preferred authentication mechanisms to use for SshdSessionFactories created by build(KeyCache).
SshdSessionFactoryBuilder	setProxyDataFactory(ProxyDataFactory proxyDataFactory)	Sets the ProxyDataFactory to use for SshdSessionFactories created by build(KeyCache).
SshdSessionFactoryBuilder	setServerKeyDatabase(BiFunction<File,File,ServerKeyDatabase> factory)	Sets a function that creates a new ServerKeyDatabase, given the SSH and home directory.
SshdSessionFactoryBuilder	setSshDirectory(File sshDirectory)	Sets the SSH directory to use for SshdSessionFactories created by build(KeyCache).
SshdSessionFactoryBuilder	withDefaultConnectorFactory()	Removes a previously set ConnectorFactory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SshdSessionFactoryBuilder

public SshdSessionFactoryBuilder()

Method Detail

setProxyDataFactory

public SshdSessionFactoryBuilder setProxyDataFactory(ProxyDataFactory proxyDataFactory)

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

Parameters:

proxyDataFactory - to use

Returns:

this SshdSessionFactoryBuilder

setHomeDirectory

public SshdSessionFactoryBuilder setHomeDirectory(File homeDirectory)

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

Parameters:

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

Returns:

this SshdSessionFactoryBuilder

setSshDirectory

public SshdSessionFactoryBuilder setSshDirectory(File sshDirectory)

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

Parameters:

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

Returns:

this SshdSessionFactoryBuilder

setPreferredAuthentications

public SshdSessionFactoryBuilder setPreferredAuthentications(String authentications)

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

Parameters:

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

Returns:

this SshdSessionFactoryBuilder

setConfigFile

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 - returning a File for the SSH config file to use, or returning null if no config file is to be used

Returns:

this SshdSessionFactoryBuilder

setConfigStoreFactory

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 - to set

Returns:

this SshdSessionFactoryBuilder

setDefaultKnownHostsFiles

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 - to get the default known hosts files

Returns:

this SshdSessionFactoryBuilder

setDefaultIdentities

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 - to get the default private key files

Returns:

this SshdSessionFactoryBuilder

setDefaultKeysProvider

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 - to get the default private key files

Returns:

this SshdSessionFactoryBuilder

setKeyPasswordProvider

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 - to create a KeyPasswordProvider

Returns:

this SshdSessionFactoryBuilder

setServerKeyDatabase

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 - to create a ServerKeyDatabase

Returns:

this SshdSessionFactoryBuilder

setConnectorFactory

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 ServiceLoader to find an ConnectorFactory.

Parameters:

factory - ConnectorFactory to use

Returns:

this SshdSessionFactoryBuilder

Since:

6.0

withDefaultConnectorFactory

public SshdSessionFactoryBuilder withDefaultConnectorFactory()

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

Returns:

this SshdSessionFactoryBuilder

Since:

6.0

build

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 - to use for caching ssh keys; may be null if no caching is desired.

Returns:

the SshdSessionFactory