SFTP Connector

Properties   Configuration Settings  

The SFTP Component adds SSH-secured file transfer capabilities to your MuleSoft.

Remarks

The SFTP Connector adds a complete SFTP client to your Mule Project that enables it with SSH-secured file download and upload functionality.

SFTP Receive Connector

The SFTP Receive Connector will establish a connection to a server and download a group of files The SFTP Receive Connector requires that a single property be set: SSHHost. You may also set an SSHPort if the server is not running on the default SSH port. In order to authenticate with the SSH server, you will need to specify an SSHUser, and either SSHPassword or SSHCert depending upon the SSHAuthMode to be used.

The connector will connect to the SFTP server every PollingInterval and list the directory specified by RemotePath. All files that match the FileMask will be downloaded and submitted to the Mule Project as individual Mule Messages. In order to guarantee that files are not downloaded multiple times, you may set the DeleteMode.

Download Example

Drag and drop the SFTP Receive Connector into the source position of a flow. All that is necessary to get started is to configure the connection settings.

Just as an example, say you want to download a group of files stored on a remote machine in /home/Bob/files.

To configure the connector, one option is to specify a RemotePath of /home/Bob/files and an empty FileMask. Since FileMask defaults to *.*, all files in the RemotePath will be downloaded.

One mule event will be generated for each downloaded file. You can use a File Write connector behind the SFTP Receive connector to write the files to disk.

The received filename is available in the ReceivedFileName attribute on each Mule Message. To write the entire group of files to disk, you can set the Path property of the File Write connector to the following DataWeave code:

"C:\\my\\files\\" ++ attributes.ReceivedFileName

The Content can be left as payload. That is all that is required to begin downloading files.

SFTP Send Connector

The SFTP Send Connector will establish a connection to a server and upload a file. The bytes in the payload of the incoming Mule Message will be uploaded as a single file. The SFTP Send Connector requires both an SSHHost and a RemoteFile. You may also set an SSHPort if the server is not running on the default SSH port. In order to authenticate with the SSH server, you will need to specify an SSHUser, and either SSHPassword or SSHCert depending upon the SSHAuthMode to be used.

The connector will connect to the SFTP server whenever it has a message to send. The connector will attempt to upload to the specified RemotePath. If Overwrite is set to True, the connector will delete or overwrite remote files as necessary to complete the operation.

In order to prevent parallel processing by another application before your upload is complete, you may need to set a temporary upload directory via RemoteTempPath. If the temporary directory is set, the file will first be uploaded to the specified temporary directory, and will be moved to the final destination path once the upload has completed.

Upload Single Example

Add a File Read connector in front of the SFTP Send connector and configure it to read a particular target file. There is no need to transform the output of the File Read connector before passing it to the SFTP Send connector. Configure the SFTP Send connector with the above connection settings. That is all that is required to upload the file.

Upload Multiple Example

The Send operation only uploads a single file at a time so we will need to perform the Send operation once for each file.

To get started, add a File List connector to your flow and configure it to list a target folder. Behind the File List connector add a For Each Scope and configure it to iterate over the message payload. Inside the For Each Scope, add a SFTP Send operation and configure it with the above connection settings.

Set the RemoteFile property dynamically with DataWeave to preserve the uploaded filename. To do this, click the Mule Expression indicator on the RemoteFile property and add the following DataWeave code:

"/home/Spencer/files" ++ attributes.fileName

That is all that is required to upload a group of files.