The document describes Mule's SFTP connector, which allows a Mule application to exchange files securely with external resources using the SSH protocol. The SFTP connector can be configured as an inbound endpoint to receive files or an outbound endpoint to send files. Setting up the SFTP endpoint involves dragging it into the appropriate place in the Mule flow and configuring properties like the host, port, path, user and password on tabs like General, Advanced, Reconnection and File. An example flow is provided that uses an SFTP inbound endpoint to receive files and a file outbound endpoint to write them locally.

1. SFTP CONNECTOR

2. SFTP CONNECTOR
• THE SFTP CONNECTOR IMPLEMENTS A SECURE FILE TRANSPORT CHANNEL SOTHAT YOUR MULE
APPLICATION CAN EXCHANGE FILES WITH EXTERNAL RESOURCES. SFTP USES THE SSH SECURITY
PROTOCOL TO TRANSFER MESSAGES. YOU CAN IMPLEMENT THE SFTP ENDPOINT AS AN INBOUND
ENDPOINT WITH A ONE-WAY EXCHANGE PATTERN, OR AS AN OUTBOUND ENDPOINT CONFIGURED FOR
EITHER A ONE-WAY OR REQUEST-RESPONSE EXCHANGE PATTERN.
PRUDHVI

3. CONFIGURATION
SFTP ENDPOINT CONFIGURATION CONSISTS OF TWO STAGES:
• DECIDE WHERE YOU WANT TO PLACE THE SFTP ENDPOINT WITHIN YOUR MULE FLOW, THEN DRAG IT FROM THE PALETTE TO
THE APPROPRIATE PLACE IN THE SEQUENCE OF BUILDING BLOCKS THAT MAKE UP YOUR MULE FLOW.
• IF YOU PLACE THE SFTP ENDPOINT AT THE BEGINNING OF THE FLOW, ITACTS AS AN INBOUND ENDPOINT (A MESSAGE
SOURCE), TRIGGERING THE FLOW WHENEVER IT RECEIVES A MESSAGE. (YOU CAN ALSO USE THE COMPOSITE SOURCE SCOPE
TO WRAP THE SFTP ENDPOINT ALONG WITH OTHER, SIMILAR ENDPOINTS (SUCH AS FILE OR UDP) SO THAT YOUR FLOW CAN
RECEIVE FILES THROUGH MULTIPLE TRANSPORT CHANNELS).
• IF YOU PLACE THE SFTP BUILDING BLOCK IN THE MIDDLE OR AT THE ENDOF THE FLOW, IT SERVES AS AN OUTBOUND
ENDPOINT, PASSING INFORMATION OUT OF THE FLOW TO EXTERNAL RESOURCES.
PRUDHVI

4. GENERAL TAB
PRUDHVI

5. GLOBAL ELEMENT PROPERTIES - GENERAL
TAB
PRUDHVI

6. ADVANCED TAB
PRUDHVI

7. RECONNECTION TAB
PRUDHVI

8. FILE TAB
PRUDHVI

9. ADVANCED TAB
PRUDHVI

10. TRANSFORMERS TAB
PRUDHVI

11. FILE TAB
PRUDHVI

12. EXAMPLE FLOW
<MULE XMLNS="HTTP://WWW.MULESOFT.ORG/SCHEMA/MULE/CORE" XMLNS:XSI="HTTP://WWW.W3.ORG/2001/XMLSCHEMA-INSTANCE"
XMLNS:SFTP="HTTP://WWW.MULESOFT.ORG/SCHEMA/MULE/SFTP" XMLNS:FILE="HTTP://WWW.MULESOFT.ORG/SCHEMA/MULE/FILE"
XMLNS:SPRING="HTTP://WWW.SPRINGFRAMEWORK.ORG/SCHEMA/BEANS" XSI:SCHEMALOCATION="
HTTP://WWW.SPRINGFRAMEWORK.ORG/SCHEMA/BEANS HTTP://WWW.SPRINGFRAMEWORK.ORG/SCHEMA/BEANS/SPRING-BEANS-CURRENT.XSD
HTTP://WWW.MULESOFT.ORG/SCHEMA/MULE/SFTP HTTP://WWW.MULESOFT.ORG/SCHEMA/MULE/SFTP/CURRENT/MULE-SFTP.XSD
HTTP://WWW.MULESOFT.ORG/SCHEMA/MULE/FILE HTTP://WWW.MULESOFT.ORG/SCHEMA/MULE/FILE/CURRENT/MULE-FILE.XSD
HTTP://WWW.MULESOFT.ORG/SCHEMA/MULE/CORE HTTP://WWW.MULESOFT.ORG/SCHEMA/MULE/CORE/CURRENT/MULE.XSD">
<!-- THIS PLACEHOLDER BEAN LETS YOU IMPORT THE PROPERTIES FROM THE SFTP.PROPERTIES FILE. -->
<SPRING:BEAN ID="PROPERTY-PLACEHOLDER" CLASS="ORG.SPRINGFRAMEWORK.BEANS.FACTORY.CONFIG.PROPERTYPLACEHOLDERCONFIGURER">
<SPRING:PROPERTY NAME="LOCATION" VALUE="CLASSPATH:SFTP.PROPERTIES"/>
</SPRING:BEAN>
<FLOW NAME="SFTP2FILE">
<SFTP:INBOUND-ENDPOINT HOST="${SFTP.HOST}" PORT="${SFTP.PORT}" PATH="/HOME/TEST/SFTP-FILES" USER="${SFTP.USER}"
PASSWORD="${SFTP.PASSWORD}">
<FILE:FILENAME-WILDCARD-FILTER PATTERN="*.TXT,*.XML"/>
</SFTP:INBOUND-ENDPOINT>
<FILE:OUTBOUND-ENDPOINT PATH="/TMP/INCOMING" OUTPUTPATTERN="#[MESSAGE.INBOUNDPROPERTIES.ORIGINALFILENAME]"/>
</FLOW>
</MULE>
PRUDHVI

13. THANK YOU
PRUDHVI