The FTPS Connector allows you to establish a secure FTP connection

Additional Info

Requires Mule Enterprise License

Yes  

Requires Entitlement

Yes  

Mule Version

3.6.0 or higher

Configs


Basic Configuration

<ftps:config>

Configuration

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

host

String

Domain or IP address of the server

localhost

 

port

String

Port of the FTP server

 

transferMode

FTPSTransferMode

Choose between active and passive modes

PASSIVE

 

keyStorePath

String

Specify where the SSL Certificate is located

 

keyStorePassword

String

Specify the password for SSL Certificate

 

disableCertificateValidation

Boolean

Server certificate validation required

false

 

clientKeyStorePath

String

Specify where the SSL Certificate is located

 

clientKeyStorePassword

String

Specify the password for SSL Certificate

 

disableClientCertificateValidation

Boolean

Client certificate validation required

true

 

username

String

Username for the FTPS Server

 

password

String

Password for the FTPS Server

 

sslEncryptionMode

FTPSSSLMode

Choose between implicit and explicit modes

IMPLICIT

 

reportedIpAddress

String

Reportable IP address to be used in Active Mode

 

minActivePort

Integer

Minimum port for Active data transfers

 

maxActivePort

Integer

Maximum port for Active data transfers

 

uploadTmpDir

String

If set, the connector will try to upload files to the temporary directory and move them to their final destination once the upload completes."

 

maxConcurrentReads

Integer

If set, the connector will try to upload files to the temporary directory and move them to their final destination once the upload completes."

1

 

streaming

Boolean

Content streaming.

false

 


Partner Manager Configuration

<ftps:partner-manager-config>

Configuration Integrate with Anypoint Partner Manager to manage your FTPS Connector and record FTPS transmissions. The B2B Connector must be configured before enabling this feature.

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

partnerName

String

Partner name.

x 

standard

Standard

Format Standard.

 

standardVersion

String

Format Version.

 

messageType

String

Message Type.

 

Processors


Write

<ftps:write>

Write processor ../../../doc/ftps-connector.xml.sample ftps:write

XML Sample

<ftps:write config-ref="FTPS" filePath="/cloudhub/" fileName="this-one-file.json" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

filePath

String

The path to the file to be read from the server.

/

 

fileName

String

Prefix for the new file to be created

 

payload

InputStream

event where to read the payload from

#[payload]

 

Returns

Return Java Type Description

String

the definitive filename stored on the server

Sources


Read

<ftps:read>

read processor ../../../doc/ftps-connector.xml.sample ftps:read

XML Sample

<ftps:read config-ref="FTPS" filePath="/cloudhub" fileName="this-one-*" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

callback

SourceCallback

used to pass the payload of the read file to the next component in the flow

x 

filePath

String

The path to the file to be read from the server

/

 

fileName

String

The filename to be read from the server (wildcards supported)

 

moveToDir

String

Directory to move files to after they've been read. If no value is set, the file will be deleted

 

pollingFrequency

int

The period to wait between checking the server for updates

1000

 

Returns

Return Java Type Description

void