Contact Us 1-800-596-4880
  1. Homepage
  2. FTPS Connector (1.7)

  3. FTPS Connector Reference

All Connectors

FTPS Connector Reference - Mule 4

FTPS Connector v1.7

Anypoint Connector for FTPS (FTPS Connector) enables you to manipulate files in an FTPS server.

Configurations

Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

FTPS Connection

The connection types to provide to this configuration.

x

Default write encoding(DEPRECATED)

String

This parameter is deprecated and not taken into account.

Time Between Size Check

Number

This value specifies the wait time between size checks to determine if a file is ready to be read.

Time Between Size Check Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Specify the time unit to use in the wait time between size checks.

MILLISECONDS

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when appropriate.

Connection Types

FTPS Connection

This configuration corresponds to a specialization of FTP connection provider that supports SSL.

Parameters
Name Type Description Default Value Required

Working Directory

String

The directory to consider the root of every relative path used with this connector

Proxy

One of: * HTTP Tunnel Proxy * HTTPS Tunnel Proxy

Enables you to set HTTP or HTTPS tunnel proxy.

Transfer Mode

Enumeration, one of:

  • BINARY

  • ASCII

Transfer mode to use

BINARY

Passive

Boolean

Specifies whether to use passive mode. Set to false to switch to active mode.

true

Enable Remote Verification

Boolean

Specifies whether or not to verify if the remote host taking part of a data connection is the same as the host to which the control connection is attached.

true

Control Encoding

String

Set the control encoding (for example UTF-8) to use in the control channel with the remote server. This does NOT set the encoding for the content of the files to transfer.

ISO-8859-1

Ftps Mode

One of:

  • FtpsExplicitMode

  • FtpsImplicitMode

TLS Configuration

Tls

Connection Timeout

Number

Connection timeout value

10

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to use in the Connection Timeout

SECONDS

Response Timeout

Number

Response timeout value

10

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to use in the Response Timeout

SECONDS

Host

String

x

Port

Number

21

Username

String

Password

String

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Pooling Profile

Pooling Profile

Characteristics of the connection pool

Supported Operations

Associated Sources

Operations

Copy

<ftps:copy>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Source Path

String

x

Target Path

String

x

Create Parent Directories

Boolean

true

Overwrite

Boolean

false

Rename To

String

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • FTPS:ILLEGAL_PATH

  • FTPS:RETRY_EXHAUSTED

  • FTPS:FILE_ALREADY_EXISTS

  • FTPS:CONNECTIVITY

Create Directory

<ftps:create-directory>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Directory Path

String

x

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • FTPS:ILLEGAL_PATH

  • FTPS:RETRY_EXHAUSTED

  • FTPS:FILE_ALREADY_EXISTS

  • FTPS:CONNECTIVITY

  • FTPS:ACCESS_DENIED

Delete

<ftps:delete>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Path

String

x

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • FTPS:ILLEGAL_PATH

  • FTPS:RETRY_EXHAUSTED

  • FTPS:CONNECTIVITY

  • FTPS:ACCESS_DENIED

List

<ftps:list>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Directory Path

String

x

Recursive

Boolean

false

File Matching Rules

Matcher

Matcher to filter the listed files

Time Between Size Check

Number

Time Between Size Check Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Message of [Any] payload and [Ftp File Attributes] attributes

For Configurations

Throws

  • FTPS:ILLEGAL_PATH

  • FTPS:ACCESS_DENIED

Move

<ftps:move>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Source Path

String

x

Target Path

String

x

Create Parent Directories

Boolean

true

Overwrite

Boolean

false

Rename To

String

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • FTPS:ILLEGAL_PATH

  • FTPS:RETRY_EXHAUSTED

  • FTPS:FILE_ALREADY_EXISTS

  • FTPS:CONNECTIVITY

Read

<ftps:read>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

File Path

String

x

Lock

Boolean

false

Time Between Size Check

Number

Time Between Size Check Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Ftp File Attributes

For Configurations

Throws

  • FTPS:ILLEGAL_PATH

  • FTPS:FILE_LOCK

  • FTPS:RETRY_EXHAUSTED

  • FTPS:CONNECTIVITY

  • FTPS:ACCESS_DENIED

Rename

<ftps:rename>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Path

String

x

New Name

String

x

Overwrite

Boolean

false

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • FTPS:ILLEGAL_PATH

  • FTPS:RETRY_EXHAUSTED

  • FTPS:FILE_ALREADY_EXISTS

  • FTPS:CONNECTIVITY

  • FTPS:ACCESS_DENIED

Write

<ftps:write>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Path

String

x

Content

Binary

Content to be written into the file

#[payload]

Encoding (DEPRECATED)

String

This parameter is deprecated and not taken into account for the operation execution.

Create Parent Directories

Boolean

true

Lock

Boolean

false

Write Mode

Enumeration, one of:

  • OVERWRITE

  • APPEND

  • CREATE_NEW

How to write the file

OVERWRITE

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • FTPS:ILLEGAL_PATH

  • FTPS:FILE_LOCK

  • FTPS:RETRY_EXHAUSTED

  • FTPS:FILE_ALREADY_EXISTS

  • FTPS:CONNECTIVITY

  • FTPS:ACCESS_DENIED

  • FTPS:ILLEGAL_CONTENT

Sources

On New or Updated File

<ftps:listener>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use

x

Directory

String

Recursive

Boolean

Whether or not to also catch files created on sub directories

true

Matcher

Matcher

Watermark Enabled

Boolean

false

Time Between Size Check

Number

Wait time, in milliseconds, between size checks to determine if a file is ready to be read.

Time Between Size Check Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to use in the wait time between size checks

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Primary Node Only

Boolean

Whether to execute this source only on the primary node when running in a cluster

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Streaming Strategy

Configure to use repeatable streams

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Reconnection Strategy

A retry strategy in case of connectivity errors

Auto Delete

Boolean

false

Move To Directory

String

Rename To

String

Apply Post Action When Failed

Boolean

true

Output

Type

Binary

Attributes Type

Ftp File Attributes

For Configurations

Types

Tls

Field Type Description Default Value Required

Enabled Protocols

String

A comma separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma separated list of cipher suites enabled for this context.

Trust Store

Truststore

Key Store

Key Store

Revocation Check

Truststore

Configures the TLS truststore.

Field Type Description Default Value Required

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

Password

String

Password used to protect the truststore.

Type

String

Type of truststore.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

Key Store

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field Type Description Default Value Required

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible.

Type

String

Type of keystore used.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the key store.

Algorithm

String

Encryption algorithm that the keystore uses.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Verify the last element of the certificate chain only.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method, which is the method not specified in the Prefer Crls field.

Soft Fail

Boolean

Avoid verification failure when the revocation server cannot be reached or is busy.

Custom Ocsp Responder

Configures a custom OCSP responder for certification revocation checks.

Field Type Description Default Value Required

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certicate for the OCSP response. If specified, the alias must be in the truststore.

Crl File

Specifies the location of the certification revocation list (CRL) file.

Field Type Description Default Value Required

Path

String

Path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Count

Number

How many reconnection attempts to make.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Pooling Profile

Field Type Description Default Value Required

Max Active

Number

Controls the maximum number of Mule components that can be borrowed from a session at one time. When set to a negative value, there is no limit to the number of components that may be active at one time. When maxActive is exceeded, the pool is said to be exhausted.

Max Idle

Number

Controls the maximum number of Mule components that can sit idle in the pool at any time. When set to a negative value, there is no limit to the number of Mule components that may be idle at one time.

Max Wait

Number

Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the exhaustedAction is set to WHEN_EXHAUSTED_WAIT.

Min Eviction Millis

Number

Determines the minimum amount of time an object may sit idle in the pool before it is eligible for eviction. When non-positive, no objects will be evicted from the pool due to idle time alone.

Eviction Check Interval Millis

Number

Specifies the number of milliseconds between runs of the object evictor. When non-positive, no object evictor is executed.

Exhausted Action

Enumeration, one of:

  • WHEN_EXHAUSTED_GROW

  • WHEN_EXHAUSTED_WAIT

  • WHEN_EXHAUSTED_FAIL

Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are:

  • WHEN_EXHAUSTED_FAIL Will throw a NoSuchElementException

  • WHEN_EXHAUSTED_WAIT Will block by invoking Object.wait(long) until a new or idle object is available

  • WHEN_EXHAUSTED_GROW Will create a new Mule instance and return it, essentially making maxActive meaningless. If a positive maxWait value is supplied, it will block for, at most, that many milliseconds, after which a NoSuchElementException is thrown. If maxThreadWait is a negative value, it is blocked indefinitely.

Initialisation Policy

Enumeration, one of:

  • INITIALISE_NONE

  • INITIALISE_ONE

  • INITIALISE_ALL

Determines how components in a pool should be initialized. The possible values are:

  • INITIALISE_NONE Will not load any components into the pool on startup

  • INITIALISE_ONE Will load one initial component into the pool on startup

  • INITIALISE_ALL Will load all components in the pool on startup

Disabled

Boolean

Whether pooling should be disabled

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Ftp File Attributes

Field Type Description Default Value Required

Timestamp

DateTime

Name

String

x

Size

Number

x

Regular File

Boolean

false

Directory

Boolean

false

Symbolic Link

Boolean

false

Path

String

x

File Name

String

x

Matcher

Field Type Description Default Value Required

Timestamp Since

DateTime

Timestamp Until

DateTime

Not Updated In The Last

Number

Updated In The Last

Number

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

SECONDS

Case Sensitive

Boolean

Enables you to configure an external file system matcher as case sensitive or insensitive.

true

Filename Pattern

String

Path Pattern

String

Directories

Enumeration, one of:

  • REQUIRE

  • INCLUDE

  • EXCLUDE

INCLUDE

Regular Files

Enumeration, one of:

  • REQUIRE

  • INCLUDE

  • EXCLUDE

INCLUDE

Sym Links

Enumeration, one of:

  • REQUIRE

  • INCLUDE

  • EXCLUDE

INCLUDE

Min Size

Number

Max Size

Number

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

In Memory Size

Number

Defines the maximum memory the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

SHA-256

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property can be set only if useSecureHash is false.

Object Store

Object Store

The object store where the redelivery counter for each message is stored.

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of instances that is initially be allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

100

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

100

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

In Memory Objects

Number

The maximum amount of instances to keep in memory. If more than this is required, then content starts to buffer on the disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

FTPS Explicit Mode

Field Type Description Default Value Required

Prot Setting

Enumeration, one of:

  • CLEAR

  • PRIVATE

Prot Setting Exporter Sub Type

Field Type Description Default Value Required

Prot Setting

Enumeration, one of:

  • CLEAR

  • PRIVATE

x

HTTP Tunnel Proxy

Field Type Description Default Value Required

Host

String

The FTP proxy server host, such as www.mulesoft.com, localhost, or 192.168.0.1, etc.

Port

Number

Port number of the FTP proxy server to connect.

Username

String

Username for the FTP proxy server. Required if the proxy server is authenticated.

Password

String

Password for the FTP proxy server. Required if the proxy server is authenticated.

HTTPS Tunnel Proxy

Field Type Description Default Value Required

Tls Context Factory

Tls

Host

String

The FTP proxy server host, such as www.mulesoft.com, localhost, or 192.168.0.1, etc.

Port

Number

Port number of the FTP proxy server to connect.

Username

String

Username for the FTP proxy server. Required if the proxy server is authenticated.

Password

String

Password for the FTP proxy server. Required if the Proxy server is authenticated.

See Also

Back to top
View on GitHub