Petals-BC-Filetransfer 3.x

Version 47 by Roland Naudin
on Sep 27, 2010 15:02.

<< Changes from 46 to 47

compared with

Version 48 by Roland Naudin
on Sep 28, 2010 17:50.

Changes from 48 to 49 >>

Key

This line was removed.

This word was removed. This word was added.

This line was added.

Changes (12)

View Page History

...

h3. Put Operation

When the _put_ operation is set on the incoming IN message, the component writes the XML message to the configured directory.

The created file takes the name described in the service unit (filename parameter) otherwise the operation name is taken. For each file created, the system date is appended to this file name.

...

h3. MPut Operation

When the _mput_ operation is set on the incoming IN message, the component writes the attachments on the configured directory.

The IN message looks like :
{code:lang=xml}

...

h3. Get Operation

When the _get_ operation is set on the incoming IN message, the component retrieves ONE file from the configured directory and return it as an XML message content.

...

h3. GetAsAttachement Operation

When the _getAsAttachment_ operation is set on the incoming IN message, the component retrieve ONE file from the configured directory according to the filename(or filter) set in the XML request.

The retrieved file is set in the OUT message as an attachment.

...

h3. MGet Operation

When the _mget_ operation is set on the incoming IN message, the component retrieves files from the configured directory, according to the filenames (or filters) set in the XML request.

There is no recursivity, recursion, sub folders are ignored.

Each file is set in the OUT message as an attachment.

...

h3. CheckFile Operation

When the _check_ operation is set on the incoming IN message, the component check

if the specified file exist. The IN message looks like :
{code:lang=xml}

...

h3. Del Operation

When the _del_ operation is set on the incoming IN message, the component deletes 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/filetransfer/version-3">

...

h3. Dir Operation

When the _dir_ operation is set on the incoming IN message, the component returns the file names listed from the configured directory.

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

...

|| Attribute || Description || Default value || Required ||
| filename \\ | The name of the file where the JBI message (the XML content) will be written in. \\

...

The system date is appended on each created file. | The operation name | {center}No{center} |
| backup-directory | The directory where files are moved before being read.Environment variables are supported with the form $\{myEnvVariable\}. | system's temporary directory | {center}No{center} |
| folder | Working directory where files are written or retrieved. Environment variables are supported with the form $\{myEnvVariable\} | | {center}Yes{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 version="1.0"
   xmlns:filetransfer="http://petals.ow2.org/components/filetransfer/version-3"
   xmlns:jbi="http://java.sun.com/xml/ns/jbi" xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
   xmlns:generateNs="http://petals.ow2.org/filetransfer" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

   
   <jbi:services binding-component="true">

       
       <jbi:provides endpoint-name="myFileTransferSUEndpointName"
           interface-name="filetransfer:FileTransfer" service-name="filetransfer:myFileTransferSUServiceName">

           
           <petalsCDK:wsdl>FileTransferService.wsdl</petalsCDK:wsdl>
           <petalsCDK:validate-wsdl>true</petalsCDK:validate-wsdl>

           
           <filetransfer:folder>${PETALS_HOME}/filetransfer/out</filetransfer:folder>
           <filetransfer:backup-directory>${PETALS_HOME}/filetransfer/backup</filetransfer:backup-directory>
           <filetransfer:filename>gettingstarted.xml</filetransfer:filename>
       </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. Invoking service on incoming file (Consumes mode)

If you want to invoke a service in the JBI bus with files, put the files in the configured directory (folder). At each configured polling period (polling-period), the component fetchs the incoming files.

For each received files and according to the transfer mode (transfer-mode or base-msg), the component creates a new message exchange and attachs the file, either as source or attachment.

If a file is put as a attachment, the name of the attachment is set to the name of the file, and in the source of the message exchange, the component put a XML structure ccording to xop rules.

The resulted message exchange(s) are sent to the target endpoint.

During the transfer, if the backup directory (backup-directory) is set, the transfered file is moved into it and never deleted by the component. Otherwise the file is moved to the system temporary directory.

When deploying a service unit like in the following code snippet, all the files put in the directory $PETALS_HOME/filetransfer/in would be set as the payload of an invocation to the _ftContentNoBaseMsgService_ service.

h2. Configurations

{include:0 CDK SU Consume Configuration}
\\

{center}{*}Service Unit attributes to provide services{*}{center}

{center}{*}Configuration of a Service Unit to consume a service (File Transfer)*
{center}

|| Attribute || Description || Default Value || Required ||
| folder | Working directory where files are written or retrieved. $ \{myEnvVariable\} environment variables are supported. | {center}\-{center} | {center}Yes{center} |

...

| backup-directory | The directory where files are moved before being read.Environment variables are supported with the form $\{myEnvVariable\}. | | system's temporary directory | | {center}No{center} |
| polling-period | Polling period in milliseconds | {center}1000{center} | {center}No{center} |
| filename | Pattern used filter files to read | {center}\*{center} | {center}No{center} |
| transfer-mode | The mode of transfer of the received file(s) as message payload. \\
Accepted values : content, attachment. | {center}attachment{center} | {center}No{center} |
| base-message | The skeleton of XML-message to send to the consumed service. It may contain *$content* or *$attachment*, or none of them. This is the way the component should link the file with the returned message. \\
* *$content* will be replaced by the file content.
* *$attachment* will set the file in attachment. It will be replaced by a xop:include element which references the attachment (MTOM-like). | | {center}No{center} |

{note}The parameter "transfer-mode" and "base-msg" can not be used at the same time.{note}

h3. Service Unit descriptor

The service unit is configurable via its extensions in the jbi.xml file.

*Example 1{*}*: used parameter* *transfer{*}*\-mode*
{code:lang=xml}
<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
   xmlns:wsdl="http://petals.ow2.org/filetransfer"
   xmlns:filetransfer="http://petals.ow2.org/components/filetransfer/version-3"
   xmlns:jbi="http://java.sun.com/xml/ns/jbi" version="1.0">
   <jbi:services binding-component="false">
       <jbi:consumes interface-name="wsdl:ftContentNoBaseMsg"
           service-name="wsdl:ftContentNoBaseMsgService"
           endpoint-name="ftContentNoBaseMsgEndpoint">

           <petalsCDK:timeout>20</petalsCDK:timeout>
           <petalsCDK:mep>InOnly</petalsCDK:mep>
           <petalsCDK:operation>simplefiletransfer</petalsCDK:operation>
           <filetransfer:folder>${PETALS_HOME}/filetransfer/in</filetransfer:folder>
           <filetransfer:polling-period>3000</filetransfer:polling-period>
           <filetransfer:transfer-mode>content</filetransfer:transfer-mode>
       </jbi:consumes>
   </jbi:services>
</jbi:jbi>
{code}

*Example 2 : used parameter base-msg*
{code:lang=xml}
<?xml version="1.0" encoding="UTF-8"?>

<jbi:jbi version="1.0"
   xmlns:filetransfer="http://petals.ow2.org/components/filetransfer/version-3"
   xmlns:generatedNs="http://petals.ow2.org/filetransfer" xmlns:jbi="http://java.sun.com/xml/ns/jbi"
   xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   
   <jbi:services binding-component="true">
       
       <jbi:consumes interface-name="itfNs:ftAttachmentBaseMsg"
           service-name="generatedNs:ftAttachmentBaseMsgService" endpoint-name="ftAttachmentBaseMsgEndpoint"
           xmlns:itfNs="http://petals.ow2.org/filetransfer">
           
           <petalsCDK:timeout>30000</petalsCDK:timeout>
           <petalsCDK:mep>InOnly</petalsCDK:mep>
           
           <filetransfer:folder>${PETALS_HOME}/filetransfer/in4
           </filetransfer:folder>
           <filetransfer:polling-period>1000</filetransfer:polling-period>
           <filetransfer:base-message>
<![CDATA[<customMessage><attachments><filein>$attachment</filein></attachments></customMessage>]]>
</filetransfer:base-message>
       </jbi:consumes>
   </jbi:services>
</jbi:jbi>
{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-Filetransfer 3.x

Changes (12)