Skip to content

NIFI-9509 Add PatchedSFTPEngine to correct SFTP rename flags handling#5618

Closed
exceptionfactory wants to merge 1 commit intoapache:mainfrom
exceptionfactory:NIFI-9509
Closed

NIFI-9509 Add PatchedSFTPEngine to correct SFTP rename flags handling#5618
exceptionfactory wants to merge 1 commit intoapache:mainfrom
exceptionfactory:NIFI-9509

Conversation

@exceptionfactory
Copy link
Contributor

Description of PR

NIFI-9509 Adds a PatchedSFTPEngine that extends the standard SSHJ SFTPEngine to workaround rename flag handling in SSHJ 0.32.0.

As described in SSHJ issue 751, initial support for SFTP rename flags introduced communication problems for SFTP servers that do not support SFTP protocol version 5 or higher. This patched approach can be removed once a new version of SSHJ introduces similar conditional handling of SFTP rename flags.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

  • Is there a JIRA ticket associated with this PR? Is it referenced
    in the commit message?

  • Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.

  • Has your PR been rebased against the latest commit within the target branch (typically main)?

  • Is your initial contribution a single, squashed commit? Additional commits in response to PR reviewer feedback should be made on this branch and pushed to allow change tracking. Do not squash or use --force when pushing to allow for clean monitoring of changes.

For code changes:

  • Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder?
  • Have you written or updated unit tests to verify your changes?
  • Have you verified that the full build is successful on JDK 8?
  • Have you verified that the full build is successful on JDK 11?
  • If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
  • If applicable, have you updated the LICENSE file, including the main LICENSE file under nifi-assembly?
  • If applicable, have you updated the NOTICE file, including the main NOTICE file found under nifi-assembly?
  • If adding new Properties, have you added .displayName in addition to .name (programmatic access) for each of the new properties?

For documentation related changes:

  • Have you ensured that format looks appropriate for the output in which it is rendered?

Note:

Please ensure that once the PR is submitted, you check GitHub Actions CI for build issues and submit an update to your PR as soon as possible.

- SSHJ 0.32.0 introduced support for rename flags in SFTP commands without checking the protocol version
- PatchedSFTPEngine overrides the rename method to check the SFTP protocol version
@joewitt
Copy link
Contributor

joewitt commented Dec 21, 2021

super cool . this lets us make progress while the we wait to see if sshj merges your PR.

checking locally. will merge if good

@asfgit asfgit closed this in 9747d6a Dec 21, 2021
krisztina-zsihovszki pushed a commit to krisztina-zsihovszki/nifi that referenced this pull request Jun 28, 2022
… SFTP rename flags handling

- SSHJ 0.32.0 introduced support for rename flags in SFTP commands without checking the protocol version
- PatchedSFTPEngine overrides the rename method to check the SFTP protocol version

Signed-off-by: Joe Witt <joewitt@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants