Petals-BC-FTP 3.3

Version 45 by Mathieu Carrolle
on Jul 23, 2010 17:56.

<< Changes from 44 to 45

compared with

Version 46 by Mathieu Carrolle
on Jul 23, 2010 18:02.

Changes from 46 to 47 >>

Key

This line was removed.

This word was removed. This word was added.

This line was added.

Changes (5)

View Page History

...

{section}
{column}

h1. Feature

The FTP component is a Binding Component (BC) which supports FTP command.

This component provide a set of 5 operation:

* *put:* Write the received JBI messages in a file with a specified name.
* *mput:* Write the JBI message attachments it receives into files.
* *get:* Retrieve *Xml* file corresponding to a pattern, from a folder. Return it as message payload.
* *getAsAttachment:* Retrieve the first file corresponding to a pattern, from a folder*.\* Return it as message's attachment.(XOP standard)
* *mGet:* Retrieve files corresponding to a pattern, from a folder*.\* Return them as message's attachment.
* *checkFile:* Check the availability of a file.
* *del:* Delete one file.
* *dir:* List the content of a folder.

These operations are described in an embedded WSDL.
{info}All attachment are processed by using XOP rules.(XML-binary Optimized Packaging : [http://www.w3.org/TR/xop10/] ){info}

h1. Exposing a FTP connection as a service

In provide mode, the component expose an external service in the JBI environment to send FTP commands on an FTP server.

This service can either connects to an FTP server configured in the ServiceUnit, or retrieve the FTP server information in the XML message request (*Dynamic mode*).

{info}All operations support wild card character{info}

h2. Usage

When using the FTP service, you can optionnaly define the FTP connection information in your XML request. If you don't, the service unit parameters are used.
\\
To configure the FTP connection in your XML message request, you have to provide a connection element.
\\ {code:lang=xml}
...
<ver:connection>
<ver:server>?</ver:server>
<ver:port>?</ver:port>
<ver:user>?</ver:user>
<ver:password>?</ver:password>

<ver:folder>?</ver:folder>
<ver:transfer-type>ascii|binary</ver:transfer-type>
<ver:connection-mode>active|passive (optional, default is active)</ver:connection-mode>
<ver:delete-processed-files>true|false(optional, default is active)</ver:delete-processed-files>
<ver:encoding>?</ver:encoding>
</ver:connection>
...
{code}

{info}Operation need to be call explicitely in the form : \{service-namespace}operation

Example : \{[http://petals.ow2.org/components/ftp/version-3|http://petals.ow2.org/components/sftp/version-1]}put{info}

h3. Put Operation

When the put operation is set on the incoming IN message, the component write the XML message to the FTP server.
\\

The IN message looks like :

{code:lang=xml}<?xml version="1.0" encoding="UTF-8"?>
<ver:put xmlns:ver="http://petals.ow2.org/components/ftp/version-3">
<ver:body>xml body</ver:body>
<ver:filename>file name on the FTP server</ver:filename>

<ver:connection>
...
</ver:connection>
</ver:put>
{code}
The service does not return a message.

The service might return an error when an element in the request is missing or if the FTP connection failed.

The available exchange pattern is : *InOnly*.
\\

h3. MPut Operation

When the mput operation is set on the incoming IN message, the component write the attachments on the FTP server.

The IN message looks like :

{code:lang=xml}<?xml version="1.0" encoding="UTF-8"?>
<ver:mput xmlns:ver="http://petals.ow2.org/components/ftp/version-3">
<ver:attachments>
<ver:filename><xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:test1.xml"/></ver:filename>
<ver:filename><xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:test2.xml"/></ver:filename>
</ver:attachments>

<ver:connection>
...
</ver:connection>
</ver:mput>
{code}
The service does not return a message.
\\

The service might return an error when an element in the request is missing or if the FTP connection failed.

The available exchange pattern is : *InOnly*.
\\

h3. Get Operation

When the get operation is set on the incoming IN message, the component retrieve ONE file from the FTP server and return it as an XML message content.
\\

The name of the file to retrieve is set in the XML IN content of the message.
\\

The IN message looks like :
\\
{code:lang=xml}<?xml version="1.0" encoding="UTF-8"?>
<ver:get xmlns:ver="http://petals.ow2.org/components/ftp/version-3">
<ver:filename>file name to retrieve</ver:filename>

<ver:connection>
...
</ver:connection>
</ver:get>
{code}
The OUT message returned to the consumer is the content of the XML file
\\

The service might return a Fault when an element in the request is missing or if the FTP connection failed
\\

The available exchange patterns is : *InOut*.

{info}Only xml file could be processed otherwise an error will be raised.{info}

h3. GetAsAttachment Operation

When the get operation is set on the incoming IN message, the component retrieve ONE file from the FTP server and return it as an attachment.

The name of the file to retrieve is set in the XML IN content of the message.

The IN message looks like :
{code:lang=xml}<?xml version="1.0" encoding="UTF-8"?>
<ver:getAsAttachment xmlns:ver="http://petals.ow2.org/components/ftp/version-3">
<ver:filename>file name to retrieve</ver:filename>

<ver:connection>
...
</ver:connection>

</ver:getAsAttachment>
{code}

The OUT message returned to the consumer contains files, as attachments, and an XML message report :

The OUT message returned to the consumer contains the retrieved file, as attachment:

{code:lang=xml}<?xml version="1.0" encoding="UTF-8"?>
<tns:getAsAttachmentResponse xmlns:tns="http://petals.ow2.org/components/ftp/version-3">

...

There is no recursivity, sub folders are ignored.

Each file is set in the OUT message as an attachment. The IN message looks like :

\\
{code:lang=xml}<?xml version="1.0" encoding="UTF-8"?>

...

</ver:mget>
{code}

The OUT message returned to the consumer contains files, as attachments, and an XML message report :

\\
{code:lang=xml}<?xml version="1.0" encoding="UTF-8"?>

...

<tns:mgetResponse xmlns:tns="http://petals.ow2.org/components/ftp/version-3">
<tns:attachments>
<tns:filename><xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:test1.xml"/></tns:filename>
<tns:filename><xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:test2.xml"/></tns:filename>
</tns:attachments>
</tns:mgetResponse>
{code}
The service might return a Fault when an element in the request is missing or if the FTP connection failed
\\

The available exchange pattern is : *InOut*.

h3. Dir Operation

When the dir operation is set on the incoming IN message, the component returns the file names listed from the FTP
server.
The IN message looks like :{code:lang=xml}
<?xml version="1.0" encoding="UTF-8"?><ver:dir xmlns:ver="http://petals.ow2.org/components/ftp/version-3>

<ver:connection>
...
</ver:connection>
</ver:dir>{code}
The OUT message returned to the consumer is defined as follow :

{code:lang=xml}<tns:dirResponse xmlns:tns="http://petals.ow2.org/components/ftp/version-3">

<tns:filename>file1.txt</tns:filename>
<tns:filename>linux.jpg</tns:filename>
</tns:dirResponse>
{code}
The service might return a Fault when an element in the request is missing or if the FTP connection failed

The available exchange pattern is : *InOut*.

h3. Del Operation

When the del operation is set on the incoming IN message, the component delete the remote file.
The IN message looks like :
{code:lang=xml}
<?xml version="1.0" encoding="UTF-8"?><ver:del xmlns:ver="http://petals.ow2.org/components/ftp/version-3>
<ver:filename>?</ver:filename>

<ver:connection>
...
</ver:connection>
</ver:del>
{code}
The service does not return a message.
The service might return an Error when an element in the request is missing or if the FTP connection failed.
The available exchange pattern is : InOnly.

h2. Configuration

{include:0 CDK SU Provide Configuration}

  *Service Unit attributes to provide services*
{table-plus}

|| Attribute || Description || Default value || Required ||
| server | IP or DNS name of the server | | {center}Yes{center} \\ {center}except when using FtpService{center} |

...

| port | the port number of the FTP server | {center}21{center} | {center}No{center} |
| user | the user login name used to connect to the server | | {center}Yes{center} \\ {center}except when using FtpService{center} |
| password | the user password | | {center}Yes{center}\\ {center}except when using FtpService{center} |
| folder | the folder on the FTP server | | {center}No{center} |
| filename | file name for the standard PUT operation (write the XML message content on the FTP server) | {center}content.xml{center} | {center}No{center} |
| connection-mode | In Active mode, the connection port is set by the client. In Passive mode, it is set by the server (default is Active) | {center}active{center} | {center}No{center} |
| transfer-type | transfer mode used for put or get files ascii/binary | {center}ascii{center} | {center}No{center} |
| delete-processed-files | If true, the service delete the files processed by operation get or mget | {center}false{center} | {center}No{center} |
| encoding | Set the encoding encoding value used to process FTP operation. | {center}Default JVM Encoding{center} | {center}No{center} |
{table-plus}

h3. Service Unit descriptor

The service unit is configurable via its extensions in the jbi.xml file:
\\
{code:lang=xml}<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns:jbi="http://java.sun.com/xml/ns/jbi"
   xmlns:ftp="http://petals.ow2.org/components/ftp/version-3"
   xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
   version="1.0">

<jbi:services binding-component="true">
   <jbi:provides
       interface-name="ftp:Ftp"
       service-name="ftp:myFTPSUServiceName"
       endpoint-name="myFTPSUEndpointName">

       
       <petalsCDK:timeout>30000</petalsCDK:timeout>
       <petalsCDK:validate-wsdl>true</petalsCDK:validate-wsdl>
       <petalsCDK:wsdl>FtpService.wsdl</petalsCDK:wsdl>

       
       <ftp:server>192.168.1.206</ftp:server>
       <ftp:port>21</ftp:port>
       <ftp:user>user1</ftp:user>
       <ftp:password>test</ftp:password>
       <ftp:folder>/home/user1/integration</ftp:folder>
       <ftp:transfer-type>binary</ftp:transfer-type>
       <ftp:connection-mode>active</ftp:connection-mode>
       <ftp:delete-processed-files>false</ftp:delete-processed-files>
       <ftp:encoding>UTF-8</ftp:encoding>
       </jbi:provides>
   </jbi:services>
</jbi:jbi>{code}

h3. Service Unit content

The Service Unit has to contain the following elements, packaged in an archive:
\\
* The META-INF/jbi.xml descriptor file, has described above,
* An optional wsdl file describing the related service

{code}service-unit.zip
+ META-INF
- jbi.xml (as defined above)
- service.wsdl (optional)
{code}

h1. Component Configuration

The following attributes can be set during the installation phase to configure the component, using the params element of the jbi-install-component ANT task:

{include:0 CDK Component Configuration Table}

{include:0 CDK Parameter scope}
{column}
{column:width=25%}
{panel:title=Table of contents}{toc}{panel}
{panel:title=Contributors}{contributors:order=name|mode=list}{panel}
{column}
{section}

Wiki

All versions of Petals ESB

Helpful links

Petals-BC-FTP 3.3

Changes (5)