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 |
The name of this configuration. With this name can be later referenced. |
x |
||
host |
Domain or IP address of the server |
localhost |
|
|
port |
Port of the FTP server |
|
||
transferMode |
Choose between active and passive modes |
PASSIVE |
|
|
keyStorePath |
Specify where the SSL Certificate is located |
|
||
keyStorePassword |
Specify the password for SSL Certificate |
|
||
disableCertificateValidation |
Server certificate validation required |
false |
|
|
clientKeyStorePath |
Specify where the SSL Certificate is located |
|
||
clientKeyStorePassword |
Specify the password for SSL Certificate |
|
||
disableClientCertificateValidation |
Client certificate validation required |
true |
|
|
username |
Username for the FTPS Server |
|
||
password |
Password for the FTPS Server |
|
||
sslEncryptionMode |
Choose between implicit and explicit modes |
IMPLICIT |
|
|
reportedIpAddress |
Reportable IP address to be used in Active Mode |
|
||
minActivePort |
Minimum port for Active data transfers |
|
||
maxActivePort |
Maximum port for Active data transfers |
|
||
uploadTmpDir |
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 |
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 |
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.
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 |
Specify which config to use |
x |
||
filePath |
The path to the file to be read from the server. |
/ |
|
|
fileName |
Prefix for the new file to be created |
|
||
payload |
event where to read the payload from |
#[payload] |
|
Returns
Return Java Type | Description |
---|---|
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 |
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 |
The path to the file to be read from the server |
/ |
|
|
fileName |
The filename to be read from the server (wildcards supported) |
|
||
moveToDir |
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 |