From dfe45c7c2946c076aa504ea69e58bc7795260a49 Mon Sep 17 00:00:00 2001
From: Artem Bilan <abilan@vmware.com>
Date: Tue, 28 Feb 2023 17:33:31 -0500
Subject: [PATCH] GH-8559: Document how to enable SOCKS for SFTP (#8565)

* GH-8559: Document how to enable SOCKS for SFTP

Fixes https://github.com/spring-projects/spring-integration/issues/8559

An out-of-the-box `SshClient` does not provide a smooth HTTP/SOCKS proxy configuration.

* Mention in the `sftp.adoc` that `JGitSshClient`, configured with SOCKS,
can be injected into a `DefaultSftpSessionFactory`
* Fix Javadocs for `DefaultSftpSessionFactory`, respectively

* Fix language in doc

Co-authored-by: Gary Russell <grussell@vmware.com>

---------

Co-authored-by: Gary Russell <grussell@vmware.com>
---
 .../integration/sftp/session/DefaultSftpSessionFactory.java   | 4 ++--
 src/reference/asciidoc/sftp.adoc                              | 3 +++
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/DefaultSftpSessionFactory.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/DefaultSftpSessionFactory.java
index aedabb1f86..53cf9c10f0 100644
--- a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/DefaultSftpSessionFactory.java
+++ b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/DefaultSftpSessionFactory.java
@@ -115,8 +115,8 @@ public class DefaultSftpSessionFactory implements SessionFactory<SftpClient.DirE
 	}
 
 	/**
-	 * Intended for use in tests so the MINA SSHD can be mocked.
-	 * @param sshClient The SshClient instance.
+	 * Instantiate based on the provided {@link SshClient}, e.g. some extension for HTTP/SOCKS.
+	 * @param sshClient the {@link SshClient} instance.
 	 * @param isSharedSession true if the session is to be shared.
 	 */
 	public DefaultSftpSessionFactory(SshClient sshClient, boolean isSharedSession) {
diff --git a/src/reference/asciidoc/sftp.adoc b/src/reference/asciidoc/sftp.adoc
index e7b05eb7bc..00e80b2b02 100644
--- a/src/reference/asciidoc/sftp.adoc
+++ b/src/reference/asciidoc/sftp.adoc
@@ -75,6 +75,9 @@ Under the covers, the SFTP Session Factory relies on the https://mina.apache.org
 However, Spring Integration also supports the caching of SFTP sessions.
 See <<sftp-session-caching>> for more information.
 
+NOTE: The `DefaultSftpSessionFactory` can use an externally configured or extended `SshClient`.
+For example, the `org.eclipse.jgit.internal.transport.sshd.JGitSshClient` extension from the `org.eclipse.jgit:org.eclipse.jgit.ssh.apache` library may be used to provide support for HTTP/SOCKS proxies.
+
 [IMPORTANT]
 =====
 The `SshClient` supports multiple channels (operations) over a connection to the server.