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

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.

 

Basic Configuration

<ftps:config>

Connection Management

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

x 

port

String

x 

username

String

x 

password

String

x 

transferMode

FTPSTransferMode

Choose between active and passive modes

PASSIVE

 

sslEncryptionMode

FTPSSSLMode

Choose between implicit and explicit modes

IMPLICIT

 

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

 

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

 

Processors

Write

<ftps:write>

Write processor

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

 

appendContents

Boolean

whether to append contents to an existing file or override it (default).

false

 

oHost

String

host setting override

 

oPort

String

port setting override

 

oTransferMode

FTPSTransferMode

transfer mode setting override

 

oSSLEncryptionMode

FTPSSSLMode

SSL encryption mode setting override

 

oUsername

String

username setting override

 

oPassword

String

password setting override

 

oServerKeyStorePath

String

server keystore path setting override

 

oServerKeyStorePassword

String

server keystore password setting override

 

oDisableServerCertificateValidation

Boolean

disable server certificate validation setting override

 

oUploadTmpDir

String

upload temp directory setting override

 

oStreaming

Boolean

streaming setting override

 

oReportedIpAddress

String

reported IP address setting override for Active Mode

 

oMinActivePort

Integer

minimum client port setting override for Active Mode

 

oMaxActivePort

Integer

maximum client port setting override for Active Mode

 

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

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

 

moveToFilename

String

New filename to use under the move to directory. If no value is set, the original filename will be used

 

pollingInitialDelay

long

The period to wait before checking the server for updates

1000

 

pollingFrequency

long

The period to wait between checking the server for updates

1000

 

sizeCheckWaitTime

long

The period to wait between file size change detection cycles

0

 

zeroSizedIgnored

boolean

ignore zero-sized files

false

 

zeroSizeCheckWaitTime

long

The period to wait between file size change detection cycles for zero-sized files

2000

 

zeroSizeCheckMaxRetries

Integer

Maximum number of size check attempts for zero-sized files

10

 

Returns

Return Java Type Description

void