Upgrade and Migrate SFTP Connector to Version 2.0 - Mule 4

Upgrade Anypoint Connector for SFTP (SFTP Connector) to version 2.0.0.

Supported Upgrade Paths

From Version	To Version
1.6.0	2.0.0

From Version

To Version

1.6.0

2.0.0

Changes in This Release

This release contains the following changes:

The system property mule.sftp.useHomeDirectory was removed. SFTP Connector now uses the default home directory.
SFTP Connector 2.0.0 no longer supports the jcraft library. The connector now uses the apache mina sshd library.
The List operation no longer fetches the content of each file. Now, the payload of each list item contains the complete path to the found file or directory.
The SFTP Regular Size file attribute is renamed to Regular File because its behavior is not related to size. The file attribute value can be a file (true) or a directory (false).
SFTP Connector 2.0.0 does not support ciphers 3des-ctr and arcfour. For more information, refer to Supported Ciphers project.
The SFTP proxy protocol works only with HTTP and SOCKS5.
SFTP Connector no longer uses javax.activation to resolve the media types of the files. The connector now uses Apache Tika, which can result in different media file interpretations.
The connector changed the classes to manage the date from LocalDateTime to ZonedDateTime.
The deprecated Encoding parameter in the configuration and Write operation is removed. The connector uses the Mule’s default encoding.

Requirements

Ensure that you meet these requirements before you perform the upgrade:

Software	Version
Mule	4.3.0 and later
Anypoint Studio	7.5.0 and later
JDK	8

Software

Version

Mule

4.3.0 and later

Anypoint Studio

7.5.0 and later

JDK

Upgrade Prerequisites

Before you perform the upgrade, you must complete the following:

Create a backup of your files, data, and configurations in case you need to restore to them.

Upgrade Steps

Follow these steps to perform the upgrade:

In Anypoint Studio, create a Mule project.
In Mule Palette, click Search in Exchange.
In Add Dependencies to Project, enter SFTP in the search field.
In Available modules, select SFTP Connector and click Add.
Click Finish.
Verify that the SFTP Connector mule-sftp-connector version is 2.0.0 in the pom.xml file in the Mule project.

Studio upgrades the connector automatically.

Post Upgrade Steps

After you install the latest version of the connector, follow these steps to complete the upgrade:

Verify the Upgrade

After you install the latest version of the connector, verify the upgrade:

In Studio, verify that there are no errors in the Problems or Console views.
Verify that there are no problems in the project pom.xml file.
Test the connection to verify that the operations work.

Supported Ciphers

The Apache Mina SSHD library does not support ciphers 3des-ctr and arcfour. Additionally, the library introduces aes128-gcm, aes256-gcm, and cc20p1305_openssh as alternatives.

For details, review the following table:

JSCH - SFTP Connector 1.6 MINA SSHD - SFTP Connector 2.0

JSCH - SFTP Connector 1.6	MINA SSHD - SFTP Connector 2.0
`blowfish-cbc`	`blowfish-cbc` (Deprecated)
`3des-cbc`	`3des-cbc` (Deprecated)
`3des-ctr`	Not supported.
`aes128-cbc`	`aes128-cbc`
`aes128-ctr`	`aes128-ctr`
Not supported.	`aes128-gcm`
`aes192-cbc`	`aes192-cbc`
`aes192-ctr`	`aes192-ctr`
`aes256-cbc`	`aes256-cbc`
`aes256-ctr`	`aes256-ctr`
Not supported.	`aes256-gcm`
`arcfour`	Not supported.
`arcfour128`	`arcfour128` (Deprecated)
`arcfour256`	`arcfour256` (Deprecated)
Not supported.	`cc20p1305_openssh`

blowfish-cbc

blowfish-cbc (Deprecated)

3des-cbc

3des-cbc (Deprecated)

3des-ctr

Not supported.

aes128-cbc

aes128-ctr

Not supported.

aes128-gcm

aes192-cbc

aes192-ctr

aes256-cbc

aes256-ctr

Not supported.

aes256-gcm

arcfour

Not supported.

arcfour128

arcfour128 (Deprecated)

arcfour256

arcfour256 (Deprecated)

Not supported.

cc20p1305_openssh

Troubleshooting

Reverting the Upgrade

If you need to revert to the previous version of SFTP Connector, go to Anypoint Studio and in the project’s pom.xml file, change the mule-sftp-connector dependency version 2.0.0 to the previous version.