Skip to content

GH-8559: Document how to enable SOCKS for SFTP #8565

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 28, 2023
Merged

GH-8559: Document how to enable SOCKS for SFTP #8565

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b35a4a
GH-8559: Document how to enable SOCKS for SFTP
artembilan Feb 28, 2023
8fb09e6
Fix language in doc
artembilan Feb 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...src/main/java/org/springframework/integration/sftp/session/DefaultSftpSessionFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,8 @@ public DefaultSftpSessionFactory(boolean isSharedSession) {
}

/**
* 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) {
Expand Down
3 changes: 3 additions & 0 deletions src/reference/asciidoc/sftp.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down