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

Class Factory

java.lang.Object

org.eclipse.jgit.internal.transport.sshd.agent.connector.Factory

All Implemented Interfaces:

ConnectorFactory

public class Factory
extends java.lang.Object
implements ConnectorFactory

An ConnectorFactory for connecting to an OpenSSH SSH agent.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jgit.transport.sshd.agent.ConnectorFactory

ConnectorFactory.ConnectorDescriptor

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	NAME

Constructor Summary

Constructors

Constructor	Description
Factory()

Method Summary

Modifier and Type	Method	Description
Connector	create(java.lang.String identityAgent, java.io.File homeDir)	Creates a new Connector.
ConnectorFactory.ConnectorDescriptor	getDefaultConnector()	Tells what kind of Connector this ConnectorFactory creates if ConnectorFactory.create(String, File) is called with identityAgent == null.
java.lang.String	getName()	Retrieves a name for this factory.
java.util.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.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

private static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

Factory

public Factory()

Method Detail

create

public Connector create(java.lang.String identityAgent,
                        java.io.File homeDir)
                 throws java.io.IOException

Description copied from interface: ConnectorFactory

Creates a new Connector.

Specified by:

create in interface ConnectorFactory

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:

java.io.IOException - if no connector can be created

isSupported

public boolean isSupported()

Description copied from interface: ConnectorFactory

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

Specified by:

isSupported in interface ConnectorFactory

Returns:

true if the factory can be used, false otherwise

getName

public java.lang.String getName()

Description copied from interface: ConnectorFactory

Retrieves a name for this factory.

Specified by:

getName in interface ConnectorFactory

Returns:

the name

getSupportedConnectors

public java.util.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.

This factory returns on Windows a ConnectorDescriptor for the internal name "pageant"; on Unix one for "SSH_AUTH_SOCK".

Specified by:

getSupportedConnectors in interface ConnectorFactory

Returns:

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

getDefaultConnector

public ConnectorFactory.ConnectorDescriptor getDefaultConnector()

Description copied from interface: ConnectorFactory

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

Specified by:

getDefaultConnector in interface ConnectorFactory

Returns:

a ConnectorFactory.ConnectorDescriptor for the default connector