Versions Compared

Old Version 13

changes.mady.by.user Lars Heinemann

Saved on

compared with

New Version 14

changes.mady.by.user Jean-Baptiste Onofré

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The ServiceMix FTP component provides JBI integration to the FTP servers. It can be used to read & write files over FTPor FTP or to periodically poll directories for new files.

Maven Archetype

...

FTP Poller

Installing the The servicemix-ftp component can be done in several ways:

  • drop the installer zip in an hotdeploy directory monitored by ServiceMix
  • using ant tasks

Note that when using ant tasks, the component is not started, you will have to start it manually using ant tasks or a console.

XBean deployment

You can deploy Service Units containing a file named xbean.xml for activating consumer and provider endpoints.

This xml file should respect the given syntax, though this is a spring based xml configuration file from where all beans of class HttpEndpoint are retrieved.
See a full example here.  Note that you have to define the ftp namespace with

...


<beans xmlns:ftp="http://servicemix.apache.org/ftp/1.0">
    ...
</beans>

-poller-service-unit archetype creates a FTP Poller Service Unit:

Code Block

mvn archetype:create \
  -DarchetypeGroupId=org.apache.servicemix.tooling \
  -DarchetypeArtifactId=servicemix-ftp-poller-service-unit \
  -DarchetypeVersion=2010.01 \
  -DgroupId=your.group.id \
  -DartifactId=your.artifact.id \
  -Dversion=your-version

FTP Sender

The servicemix-ftp-sender-service-unit archetype creates a FTP Sender Service Unit:

Code Block

mvn archetype:create \
  -DarchetypeGroupId=org.apache.servicemix.tooling \
  -DarchetypeArtifactId=servicemix-ftp-sender-service-unit \
  -DarchetypeVersion=2010.01 \
  -DgroupId=your.group.id \
  -DartifactId=your.artifact.id \
  -Dversion=your-version

Endpoint Configuration

FTP Poller Endpoint

FTP

Any numbers of endpoints can be specified in the xbean.xml file.

Poller endpoint

Poller endpoints can be used to poll a FTP server directory for files, download them, and send an InOnly JBI exchange to the configured JBI service.

...

Info
titlePoller endpoint attributes
borderStylesolidbgColor='lighblue'

Name

Type

Description

Required

service

QName

the service name of the proxied endpoint

yes

endpoint

String

the endpoint name of the proxied endpoint

yes

interfaceName

QName

the interface name of the proxied endpoint

no

targetService

QName

the service name of the target endpoint

one of targetService, targetInterface or targetUri must be specified

targetEndpoint

String

the endpoint name of the target endpoint

one of targetService, targetInterface or targetUri must be specified

targetInterface

QName

the interface name of the target endpoint

one of targetService, targetInterface or targetUri must be specified

targetUri

String

the uri of the target endpoint

one of targetService, targetInterface or targetUri must be specified

uri

URI

the ftp uri to access the FTP server (see #URI)

yes

autoCreateDirectory

boolean

creates dir if doesn't exist
(available since 2009.01)

true

archive

URI

sets the directory uri to archive files before deleting them
(available since 2009.01)

null

deleteFile

boolean

whether the file should be deleted from the FTP server after processing

no (defaults to true)

stateless

boolean

whether the polled file should be sent asynchronous or synchronous to the nmr

no (defaults to true)

recursive

boolean

whether subdirectories should be polled

no (defaults to true)

filter

java.io.FileFilter

a filter used when polling files: files that do not match this filter will be ignored

no

marshaler

FileMarshaler

a marshaler can be used to customize how the file is read / written (see #Marshalers)

no

lockManager

o.a.s.locks.LockManager

a custom lock manager can be used to cluster poller endpoints or to keep track of processed files when the deleteFile attribute is set to false

no

clientPool

FTPClientPool

 

no

FTP Sender

...

Endpoint

FTP Sender endpoints are used are provider endpoints (in the JBI sense) which accepts incoming InOnly exchanges and write the content of the exchange to a file on the FTP server.

Here is an example of a simple sender endpoint.:

Code Block
langxml
<ftp:sender service="test:service"
            endpoint="endpoint" 
            uri="ftp://servicemix:rocks@localhost/smx/test" />

...