ftpserver

1.0.1

Namespace	http://www.mulesoft.org/schema/mule/ftpserver
Schema Location	http://www.mulesoft.org/schema/mule/ftpserver/1.0/mule-ftpserver.xsd
Version	1.0
Minimum Mule Version	3.2

Module Overview

FTP server for Integration tests.

With this module you can start a FTP server on your local machine

Summary

Configuration
<ftpserver:config> Configure an instance of this module

Message Processors
<ftpserver:contains-files> check if a file exists.
<ftpserver:remove> Remove created files
<ftpserver:start-server> Starts the server
<ftpserver:stop-server> Stops the server

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:ftpserver="http://www.mulesoft.org/schema/mule/ftpserver"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/ftpserver
               http://www.mulesoft.org/schema/mule/ftpserver/1.0/mule-ftpserver.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necesary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
Type	Name	Default Value	Description
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
xs:int	port		FTP server port.
xs:boolean	secure	false	Optional. Defines if is FTP over ssh.

Message Processors

<ftpserver:contains-files>

check if a file exists.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
file		File
path		Path

Child Elements

<ftpserver:remove>

Remove created files

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
path		Path to be removed.

Child Elements

<ftpserver:start-server>

Starts the server

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

<ftpserver:stop-server>

Stops the server

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.