File connector used to manipulate file systems mounted on the host operation system.

This class serves as both extension definition and configuration. Operations are based on the standard BaseFileSystemOperations

Configurations

Config

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

The connection types that can be provided to this configuration.

x 

Default Write Encoding

String

 

Connection Types

Local FileSystem Connection
Parameters
Name Type Description Default Value Required

Working Directory

String

Directory to be considered as the root of every relative path used with this connector. Defaults to the user's home

 

Reconnection

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

 

Associated Operations

Operations

Copy

http://www.mulesoft.org/schema/mule/file: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

  • FILE:ILLEGAL_PATH  

  • FILE:FILE_ALREADY_EXISTS  

  • FILE:CONNECTIVITY  

  • FILE:RETRY_EXHAUSTED  

Create Directory

http://www.mulesoft.org/schema/mule/file: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

  • FILE:ILLEGAL_PATH  

  • FILE:FILE_ALREADY_EXISTS  

  • FILE:CONNECTIVITY  

  • FILE:ACCESS_DENIED  

  • FILE:RETRY_EXHAUSTED  

Delete

http://www.mulesoft.org/schema/mule/file: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

  • FILE:ILLEGAL_PATH  

  • FILE:CONNECTIVITY  

  • FILE:ACCESS_DENIED  

  • FILE:RETRY_EXHAUSTED  

List

http://www.mulesoft.org/schema/mule/file: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 to filter the listed files

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Message of [Binary] payload and [Local File Attributes] attributes

For Configurations.

Throws

  • FILE:ILLEGAL_PATH  

  • FILE:CONNECTIVITY  

  • FILE:ACCESS_DENIED  

  • FILE:RETRY_EXHAUSTED  

Move

http://www.mulesoft.org/schema/mule/file: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

  • FILE:ILLEGAL_PATH  

  • FILE:FILE_ALREADY_EXISTS  

  • FILE:CONNECTIVITY  

  • FILE:RETRY_EXHAUSTED  

Read

http://www.mulesoft.org/schema/mule/file: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

 

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 if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Binary

Attributes Type

For Configurations.

Throws

  • FILE:ILLEGAL_PATH  

  • FILE:CONNECTIVITY  

  • FILE:ACCESS_DENIED  

  • FILE:RETRY_EXHAUSTED  

  • FILE:FILE_LOCK  

Rename

http://www.mulesoft.org/schema/mule/file: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

  • FILE:ILLEGAL_PATH  

  • FILE:FILE_ALREADY_EXISTS  

  • FILE:CONNECTIVITY  

  • FILE:ACCESS_DENIED  

  • FILE:RETRY_EXHAUSTED  

Write

http://www.mulesoft.org/schema/mule/file: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

String

Encoding when trying to write a String file. If not set, defaults to the configuration one or the Mule default

 

Create Parent Directories

Boolean

true

 

Lock

Boolean

false

 

Write Mode

Enumeration, one of:

  • OVERWRITE

  • APPEND

  • CREATE_NEW

How the file is going to be written

OVERWRITE

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • FILE:ILLEGAL_PATH  

  • FILE:ILLEGAL_CONTENT  

  • FILE:FILE_ALREADY_EXISTS  

  • FILE:CONNECTIVITY  

  • FILE:ACCESS_DENIED  

  • FILE:RETRY_EXHAUSTED  

Types

Reconnection

Field Type Default Value

Fails Deployment

Boolean

Reconnection Strategy

Reconnect

Field Type Default Value

Frequency

Number

Count

Number

Reconnect Forever

Field Type Default Value

Frequency

Number

Local File Attributes

Field Type Default Value

Creation Time

DateTime

Directory

Boolean

Last Access Time

DateTime

Last Modified Time

DateTime

Name

String

Path

String

Regular File

Boolean

Size

Number

Symbolic Link

Boolean

Matcher

Field Type Default Value

Created Since

DateTime

Created Until

DateTime

Updated Since

DateTime

Updated Until

DateTime

Accessed Since

DateTime

Accessed Until

DateTime

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 Default Value

Initial Buffer Size

Number

Buffer Size Increment

Number

Max Buffer Size

Number

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Repeatable File Store Stream

Field Type Default Value

Max In Memory Size

Number

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB