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 

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 will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

Connection Types

Local FileSystem Connection

A ConnectionProvider which provides instances of FileSystem from instances of FileConnector

Parameters
Name Type Description Default Value Required

Working Directory

String

The directory to be considered as the root of every relative path used with this connector. If not provided, it will default to the value of the user.home system property. If that system property is not set, then the connector will fail to initialise.

 

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

<file:copy>

Copies the file at the sourcePath into the targetPath.

If targetPath doesn't exist, and neither does its parent, then an attempt will be made to create depending on the value of the createParentFolder argument. If such argument is , then an IllegalArgumentException will be thrown.

If the target file already exists, then it will be overwritten if the overwrite argument is true. Otherwise, IllegalArgumentException will be thrown.

As for the sourcePath, it can either be a file or a directory. If it points to a directory, then it will be copied recursively.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Source Path

String

the path to the file to be copied

x 

Target Path

String

the target directory where the file is going to be copied

x 

Create Parent Directories

Boolean

whether or not to attempt creating any parent directories which don't exists.

true

 

Overwrite

Boolean

whether or not overwrite the file if the target destination already exists.

false

 

Rename To

String

copied file's new name. If not provided, original file name will be kept.

 

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

<file:create-directory>

Creates a new directory on directoryPath

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Directory Path

String

the new directory's name

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

<file:delete>

Deletes the file pointed by path, provided that it's not locked

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Path

String

the path to the file to be deleted

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

<file:list>

Lists all the files in the directoryPath which match the given matcher.

If the listing encounters a directory, the output list will include its contents depending on the value of the recursive parameter.

If recursive is set to true but a found directory is rejected by the matcher, then there won't be any recursion into such directory.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Directory Path

String

the path to the directory to be listed

x 

Recursive

Boolean

whether to include the contents of sub-directories. Defaults to false.

false

 

File Matching Rules

a matcher used to filter the output list

 

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

<file:move>

Moves the file at the sourcePath into the targetPath.

If targetPath doesn't exist, and neither does its parent, then an attempt will be made to create depending on the value of the createParentFolder argument. If such argument is false, then an IllegalArgumentException will be thrown.

If the target file already exists, then it will be overwritten if the overwrite argument is true. Otherwise, IllegalArgumentException will be thrown.

As for the sourcePath, it can either be a file or a directory. If it points to a directory, then it will be moved recursively.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Source Path

String

the path to the file to be copied

x 

Target Path

String

the target directory

x 

Create Parent Directories

Boolean

whether or not to attempt creating any parent directories which don't exists.

true

 

Overwrite

Boolean

whether or not overwrite the file if the target destination already exists.

false

 

Rename To

String

moved file's new name. If not provided, original file name will be kept.

 

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

<file:read>

Obtains the content and metadata of a file at a given path. The operation itself returns a Message which payload is a InputStream with the file's content, and the metadata is represent as a LocalFileAttributes object that's placed as the message Message#getAttributes() attributes.

If the lock parameter is set to true, then a file system level lock will be placed on the file until the input stream this operation returns is closed or fully consumed. Because the lock is actually provided by the host file system, its behavior might change depending on the mounted drive and the operation system on which mule is running. Take that into consideration before blindly relying on this lock.

This method also makes a best effort to determine the mime type of the file being read. A MimetypesFileTypeMap will be used to make an educated guess on the file's mime type. The user also has the chance to force the output encoding and mimeType through the outputEncoding and outputMimeType optional parameters.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

File Path

String

the path to the file to be read

x 

Lock

Boolean

whether or not to lock the file. Defaults to false.

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

<file:rename>

Renames the file pointed by path to the name provided on the to parameter

to argument should not contain any path separator. IllegalArgumentException will be thrown if this precondition is not honored.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Path

String

the path to the file to be renamed

x 

New Name

String

the file's new name

x 

Overwrite

Boolean

whether or not overwrite the file if the target destination already exists.

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

<file:write>

Writes the content into the file pointed by path.

If the directory on which the file is attempting to be written doesn't exist, then the operation will either throw IllegalArgumentException or create such folder depending on the value of the createParentDirectory.

If the file itself already exists, then the behavior depends on the supplied mode.

This operation also supports locking support depending on the value of the lock argument, but following the same rules and considerations as described in the read operation. not set, then it defaults to FileConnectorConfig#getDefaultWriteEncoding()

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Path

String

the path of the file to be written

x 

Content

Binary

the content to be written into the file. Defaults to the current Message payload

#[payload]

 

Encoding

String

when content is a String, this attribute specifies the encoding to be used when writing. If

 

Create Parent Directories

Boolean

whether or not to attempt creating any parent directories which don't exists.

true

 

Lock

Boolean

whether or not to lock the file. Defaults to false

false

 

Write Mode

Enumeration, one of:

  • OVERWRITE

  • APPEND

  • CREATE_NEW

a FileWriteMode. Defaults to OVERWRITE

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 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 will fail 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 ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

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

Local File Attributes

Field Type Description Default Value Required

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

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

Initial Buffer Size

Number

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

Buffer Size Increment

Number

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

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower 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

Max In Memory Size

Number

Defines the maximum memory that 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