Package org.eclipse.jgit.transport.sshd.agent

Interface ConnectorFactory

All Known Implementing Classes:

Factory

public interface ConnectorFactory

A factory for creating Connectors. This is a service provider interface; implementations are discovered via the ServiceLoader, or can be set explicitly on a SshdSessionFactory.

Since:

6.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ConnectorFactory.ConnectorDescriptor	ConnectorFactory.ConnectorDescriptors describe available Connectors a ConnectorFactory may provide.

Method Summary

Modifier and Type	Method	Description
Connector	create(String identityAgent, File homeDir)	Creates a new Connector.
static ConnectorFactory	getDefault()	Retrieves the currently set default ConnectorFactory.
ConnectorFactory.ConnectorDescriptor	getDefaultConnector()	Tells what kind of Connector this ConnectorFactory creates if create(String, File) is called with identityAgent == null.
String	getName()	Retrieves a name for this factory.
Collection<ConnectorFactory.ConnectorDescriptor>	getSupportedConnectors()	Tells which kinds of SSH agents this ConnectorFactory supports.
boolean	isSupported()	Tells whether this ConnectorFactory is applicable on the currently running platform.
static void	setDefault(ConnectorFactory factory)	Sets a default ConnectorFactory.

Method Detail

getDefault

static ConnectorFactory getDefault()

Retrieves the currently set default ConnectorFactory. This is the factory that is used unless overridden by the SshdSessionFactory.

Returns:

the current default factory; may be null if none is set and the ServiceLoader cannot find any suitable implementation

setDefault

static void setDefault(ConnectorFactory factory)

Sets a default ConnectorFactory. This is the factory that is used unless overridden by the SshdSessionFactory.

If no default factory is set programmatically, an implementation is discovered via the ServiceLoader.

Parameters:

factory - ConnectorFactory to set, or null to revert to the default behavior of using the ServiceLoader.

create

@NonNull
Connector create(String identityAgent,
                 File homeDir)
          throws IOException

Creates a new Connector.

Parameters:

identityAgent - identifies the wanted agent connection; if null, the factory is free to provide a Connector to a default agent. The value will typically come from the IdentityAgent setting in ~/.ssh/config.

homeDir - the current local user's home directory as configured in the SshdSessionFactory

Returns:

a new Connector

Throws:

IOException - if no connector can be created

isSupported

boolean isSupported()

Tells whether this ConnectorFactory is applicable on the currently running platform.

Returns:

true if the factory can be used, false otherwise

getName

String getName()

Retrieves a name for this factory.

Returns:

the name

getSupportedConnectors

@NonNull
Collection<ConnectorFactory.ConnectorDescriptor> getSupportedConnectors()

Tells which kinds of SSH agents this ConnectorFactory supports.

An implementation of this method should document the possible values it returns.

Returns:

an immutable collection of ConnectorFactory.ConnectorDescriptors, including getDefaultConnector() and not including a descriptor for internal name "none"

getDefaultConnector

ConnectorFactory.ConnectorDescriptor getDefaultConnector()

Tells what kind of Connector this ConnectorFactory creates if create(String, File) is called with identityAgent == null.

Returns:

a ConnectorFactory.ConnectorDescriptor for the default connector