e7838b9c08
Once a factory supports different SSH agents on the same platform, which is planned for Windows once we use Apache MINA sshd 2.8.0, client code may need to have a way to specify which SSH agent shall be used when the SSH config doesn't define anything. Add a mechanism by which a ConnectorFactory can tell what Connectors it may provide. Client code can use this to set the identityAgent parameter of ConnectorFactory.create() to the wanted default if it would be null otherwise. A ConnectorDescriptor is a pair of strings: an internal name, and a display name. The latter is included because client code might want to communicate agent names to the user, be it in error messages or in some chooser dialog where a user could define which of several alternative SSH agents should be used as default. The internal name is intended to be used in the IdentityAgent directive in ~/.ssh/config. Also make the ConnectorFactory discovered via the ServiceLoader accessible and overrideable. Provide static get/setDefault() methods, similar to the SshSessionFactory itself. Change-Id: Ie3d077395d32dfddc72bc8627e92b23636938182 Signed-off-by: Thomas Wolf <thomas.wolf@paranor.ch> |
||
|---|---|---|
| .. | ||
| .settings | ||
| META-INF | ||
| resources | ||
| src/org/eclipse/jgit | ||
| .classpath | ||
| .fbprefs | ||
| .gitignore | ||
| .project | ||
| BUILD | ||
| README.md | ||
| about.html | ||
| build.properties | ||
| plugin.properties | ||
| pom.xml | ||
README.md
JGit SSH support via Apache MINA sshd
This bundle provides an implementation of git transport over SSH implemented via Apache MINA sshd.
Service registration
This bundle declares a service for the java.util.ServiceLoader for interface
org.eclipse.jgit.transport.ssh.SshSessionFactory. The core JGit bundle uses the service
loader to pick up an implementation of that interface.
Note that JGit simply uses the first SshSessionFactory provided by the ServiceLoader.
If the service loader cannot find the session factory, either ensure that the service
declaration is on the Classpath of bundle org.eclipse.jgit, or set the factory explicitly
(see below).
In an OSGi environment, one might need a service loader bridge, or have a little OSGi
fragment for bundle org.eclipse.jgit that puts the right service declaration onto the
Classpath of that bundle. (OSGi fragments become part of the Classpath of their host
bundle.)
Configuring an SSH implementation for JGit
The simplest way to set an SSH implementation for JGit is to install it globally via
SshSessionFactory.setInstance(). This instance will be used by JGit for all SSH
connections by default.
It is also possible to set the SSH implementation individually for any git command
that needs a transport (TransportCommand) via a org.eclipse.jgit.api.TransportConfigCallback.
To do so, set the wanted SshSessionFactory on the SSH transport, like:
SshSessionFactory customFactory = ...; // Get it from wherever
FetchCommand fetch = git.fetch()
.setTransportConfigCallback(transport -> {
if (transport instanceof SshTransport) {
((SshTransport) transport).setSshSessionFactory(customFactory);
}
})
...
.call();
Using a different SSH implementation
To use a different SSH implementation:
- Do not include this bundle in your product.
- Include the bundle of the alternate implementation.
- If the service loader finds the alternate implementation, nothing more is needed.
- Otherwise ensure the service declaration from the other bundle is on the Classpath of bundle
org.eclipse.jgit, - or set the
SshSessionFactoryfor JGit explicitly (see above).
Using an external SSH executable
JGit has built-in support for not using any Java SSH implementation but an external SSH executable. To use an external SSH executable, set environment variable GIT_SSH to the path of the executable. JGit will create a sub-process to run the executable and communicate with this sup-process to perform the git operation.