motiejus
/
jgit
1
Fork 0
Code Releases Activity

[doc] Add README and package-info to the SSH bundles 

Explain in the JSch bundle that it is essentially unmaintained. Add
descriptions in both bundles explaining how to use it, or how to use
an alternate implementation.

Change-Id: Idaf46c33b14543279f78a55cb7c6bd42b06ee6b8
Signed-off-by: Thomas Wolf <thomas.wolf@paranor.ch>
This commit is contained in:
Thomas Wolf 2021-10-31 14:57:30 +01:00
parent 83eddaf7fd
commit f6ef2f6201
4 changed files with 140 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
org.eclipse.jgit.ssh.apache/README.md Normal file
View File

@ -0,0 +1,61 @@
# JGit SSH support via Apache MINA sshd
This bundle provides an implementation of git transport over SSH implemented via
[Apache MINA sshd](https://mina.apache.org/sshd-project/).
## 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:
```java
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 `SshSessionFactory` for 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.

6
org.eclipse.jgit.ssh.apache/src/org/eclipse/jgit/transport/sshd/package-info.java Normal file
View File

@ -0,0 +1,6 @@
/**
* Provides a JGit {@link org.eclipse.jgit.transport.SshSessionFactory}
* implemented via <a href="https://mina.apache.org/sshd-project/">Apache MINA
* sshd</a>.
*/
package org.eclipse.jgit.transport.sshd;

59
org.eclipse.jgit.ssh.jsch/README.md Normal file
View File

@ -0,0 +1,59 @@
# JGit SSH support via JSch
This bundle provides an implementation of git transport over SSH implemented via JSch.
**This bundle should be considered deprecated**. It is essentially unmaintained, and
the JGit project may decide anytime to remove it completely without further ado.
The officially supported SSH transport is in bundle `org.eclipse.jgit.ssh.apache` and is
built upon [Apache MINA sshd](https://mina.apache.org/sshd-project/).
## 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. The bundle in an OSGi fragment
to ensure that the service loader works in an OSGi environment without the need to
install a service loader bridge.
Note that JGit simply uses the first `SshSessionFactory` provided by the `ServiceLoader`.
## 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 `SshSessionFactory` for JGit explicitly (see below).
## 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:
```java
SshSessionFactory customFactory = ...; // Get it from wherever
FetchCommand fetch = git.fetch()
.setTransportConfigCallback(transport -> {
if (transport instanceof SshTransport) {
((SshTransport) transport).setSshSessionFactory(customFactory);
}
})
...
.call();
```
## 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.

14
org.eclipse.jgit.ssh.jsch/src/org/eclipse/jgit/transport/ssh/jsch/package-info.java Normal file
View File

@ -0,0 +1,14 @@
/**
* Provides a JGit {@link org.eclipse.jgit.transport.SshSessionFactory}
* implemented via JSch.
* <p>
* This package should be considered <b>deprecated</b>. It is essentially
* unmaintained and the JGit project may decide to remove it completely without
* further ado at any time.
* </p>
* <p>
* The officially supported Java SSH implementation for JGit is in bundle
* {@code org.eclipse.jgit.ssh.apache} and is built upon
* <a href="https://mina.apache.org/sshd-project/">Apache MINA sshd</a>.
*/
package org.eclipse.jgit.transport.ssh.jsch;