View Source

{section}
{column}
{info}Only release >= 3.0{info}
 
h1. Feature

The FileTransfer component is a Binding Component (BC) which supports file transfers. This component allows to:

Poll a configured directory for incoming files. At a poll, each file retrieved is put into a new JBI message, set as source or attachment. The message is sent to a target JBI service.


h1. Exposing a file system connector as a service


h2. Usage


h3. Put Operation

Request examples

h3. MPut Operation

Request examples

h3. Get Operation


h3. Get Operation

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} |
{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:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
version="1.0">

<jbi:services binding-component="true">
....
</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 a service on external event

h2. Configurations


h3. Service Unit descriptor

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}