Petals Documentation > Petals ESB > Petals Components > Page Comparison - Petals-BC-FTP 3.9.0+ (v.4 vs v.5)

Petals-BC-FTP 3.9.0+

Version 4 by Christophe DENEUX
on Mar 18, 2020 12:46.
<< Changes from 3 to 4
compared with
Version 5 by Christophe DENEUX
on Mar 19, 2020 11:02.
Changes from 5 to 6 >>
Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (66)

View Page History
...
* *dir:* List the content of a folder.

These operations are described in an embedded WSDL.
These operations are available in two modes:
* through a service provider implemented by a service unit. It's the recommended way,
* through an integration service directly provided by the component.

{info}All attachment are processed by using XOP rules. (XML-binary Optimized Packaging : [http://www.w3.org/TR/xop10/] ){info} [http://www.w3.org/TR/xop10/]).{info}
{column}
{column:width=350px}
...
{section}

h1. Exposing a FTP connection as a service
h1. The integration service

In provide mode, the component expose an external service in the JBI environment to send FTP commands on an FTP server.
The component exposes directly a generic FTP service without deploying a service unit (*Integration service mode*). This generic service can be deactivate removing the file '{{component.wsdl}}' from the component archive.

The component can expose directly a generic FTP service without deploying a service unit (*Generic mode*) or use a service-unit (*Service-unit mode*).
In integration service mode, parameters for the FTP connection are set in the XML message request in a connection node added to the operation payload as following:
{code:lang=xml}
<?xml version="1.0" encoding="UTF-8"?>
<ftp:... xmlns:ftp="http://petals.ow2.org/components/ftp/version-3">
<ftp:connection>
<ftp:server>?</ftp:server>
<ftp:port>?</ftp:port>
<ftp:user>?</ftp:user>
<ftp:password>?</ftp:password>
<!--Optional:-->
<ftp:folder>?</ftp:folder>
<ftp:transfer-type>ascii|binary</ftp:transfer-type>
<ftp:connection-mode>active|passive (optional, default is active)</ftp:connection-mode>
<ftp:delete-processed-files>true|false(optional, default is active)</ftp:delete-processed-files>
<ftp:encoding>?</ftp:encoding>
</ftp:connection>
</ftp:...>
{code}

In generic mode, parameter for the FTP connection are set in the XML message request in a connection node (see [Generic Mode configuration|#GenericModeConfiguration]).
Example of a PUT request :
{code:lang=xml}
<?xml version="1.0" encoding="UTF-8"?>
<ftp:put xmlns:ftp="http://petals.ow2.org/components/ftp/version-3">
<ftp:body>xml body</ftp:body>
<ftp:filename>file name on the FTP server</ftp:filename>
<ftp:connection>
<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>
</ftp:connection>
</ftp:put>
{code}

h1. Exposing a FTP connection as a service

The component is able to expose an external service in the JBI environment to send FTP commands on an FTP server (*Service-unit mode*).

h2. Usage

{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
Example : \{http://petals.ow2.org/components/ftp/version-3}put

* All operations support wild card character
...

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}
{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:put>
{code}

The service does not return a message.

...

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


h3. MPut Operation

...

The IN message looks like :
{code:lang=xml}
{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: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}
{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: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 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

...

The IN message looks like :
{code:lang=xml}
{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:getAsAttachment>
{code}

The OUT message returned to the consumer contains the retrieved file, as attachment:
{code:lang=xml}
{code:lang=xml}<?xml version="1.0" encoding="UTF-8"?>
<tns:getAsAttachmentResponse xmlns:tns="http://petals.ow2.org/components/ftp/version-3">
<tns:attachment>
...
</tns:getAsAttachmentResponse>
{code}
The service might return a Fault when an element in the request is missing or if the FTP connection failed

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. MGet Operation

When the mget operation is set on the incoming IN message, the component retrieves files from the FTP server, according to the file names (or filters) set in the XML request.
\\
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}
{code:lang=xml}<?xml version="1.0" encoding="UTF-8"?>
<ver:mget xmlns:ver="http://petals.ow2.org/components/ftp/version-3">
<!--1 or more repetitions:-->
...
</ver:mget>
{code}

The OUT message returned to the consumer contains files, as attachments:
\\ {code:lang=xml}
{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:mgetResponse>
{code}
The service might return a Fault when an element in the request is missing or if the FTP connection failed
\\

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.
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:dir>{code}
The OUT message returned to the consumer is defined as follow :

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" />
{code}

The OUT message returned to the consumer is defined as follow :
{code:lang=xml}
{code:lang=xml}<tns:dirResponse xmlns:tns="http://petals.ow2.org/components/ftp/version-3">
<!--Zero or more repetitions:-->
<tns:filename>file1.txt</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 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}
...
</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.

The available exchange pattern is : *InOnly*.

h2. Configuration

{anchor:GenericModeConfiguration}

h3. Generic Mode

To allow the component to provide his generic service, the component must have a wsdl with the name : component.wsdl. An example of this file is available in the component.

To deactivate the generic service supplies by the component,simply erase the file : component.wsdl.

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>
<!--Optional:-->
<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}

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

<ftp:connection>
<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>
</ftp:connection>
</ftp:put>
{code}

h3. Service Unit Mode

...