Petals Documentation > Petals ESB > Petals Components > Petals-BC-Filetransfer 3.0.x & 3.1.x

Petals-BC-Filetransfer 3.0.x & 3.1.x

Only release >= 3.0

Features

The FileTransfer component is a Binding Component which supports file transfers.

This component allows to:

  • Expose a file system access as a service which provide a set of 8 operations:
    • 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.
  • 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.
All attachment are processed by using XOP rules.(XML-binary Optimized Packaging : http://www.w3.org/TR/xop10/ )

Exposing a file system access as a service (Provides mode)


All operation support wild card character.

Usage

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.

The IN message looks like :

<?xml version="1.0" encoding="UTF-8"?>
<ver:put xmlns:ver="http://petals.ow2.org/components/filetransfer/version-3">?</ver:put>

The service does not return a message.
The available exchange pattern is : InOnly.

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 :

<?xml version="1.0" encoding="UTF-8"?>
<ver:mput>
    <ver:attachments xmlns:ver="http://petals.ow2.org/components/filetransfer/version-3">
        <!--1 or more repetitions:-->
        <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:mput>

The service does not return a message.

The available exchange pattern is : InOnly.

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.

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

The IN message looks like : 

<?xml version="1.0" encoding="UTF-8"?>
<ver:get xmlns:ver="http://petals.ow2.org/components/filetransfer/version-3">
     <ver:filename>file name to retrieve</ver:filename>
</ver:get>

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 an IO error occurs.

The available exchange patterns is : InOut.

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

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.

The IN message looks like:

<?xml version="1.0" encoding="UTF-8"?>
<ver:getAsAttachment xmlns:ver="http://petals.ow2.org/components/filetransfer/version-3">
     <ver:filename>file name to retrieve</ver:filename>
 </ver:getAsAttachment>

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

<?xml version="1.0" encoding="UTF-8"?>
<tns:getAsAttachmentResponse xmlns:tns="http://petals.ow2.org/components/filetransfer/version-3">
  <tns:attachment>
    <tns:filename><xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:test1.xml"/></tns:filename>
  </tns:attachment>
</tns:getAsAttachmentResponse>

The service might return a Fault when an element in the request is missing or if an IO error occurs.

The available exchange pattern is : InOut.

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 recursion, sub folders are ignored.

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

<?xml version="1.0" encoding="UTF-8"?>
<ver:mget xmlns:ver="http://petals.ow2.org/components/filetransfer/version-3">
<\!\--1 or more repetitions:-\->
<ver:filename>*.xml</ver:filename>
<ver:filename>myFile.txt</ver:filename>
</ver:mget>

The OUT message returned to the consumer contains files, as attachments:

<?xml version="1.0" encoding="UTF-8"?>
<tns:mgetResponse xmlns:tns="http://petals.ow2.org/components/filetransfer/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:myFile.txt"/></tns:filename>
  </tns:attachments>
</tns:mgetResponse>

The service might return a Fault when an element in the request is missing or if an IO error occurs.

The available exchange pattern is : InOut.

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 :

<ver:checkFile xmlns:ver="http://petals.ow2.org/components/filetransfer/version-3">
         <ver:filename>?</ver:filename>
</ver:checkFile>

The OUT message returned to the consumer looks like :

<ver:checkFileResponse xmlns:ver="http://petals.ow2.org/components/filetransfer/version-3">
         <ver:filename>?</ver:filename>
         <ver:exist>true|false</ver:exist>
</ver:checkFileResponse>

The service might return an ioFault.
The available exchange pattern is : InOut.

Del Operation

When the del operation is set on the incoming IN message, the component deletes the remote file. The IN message looks like :

<?xml version="1.0" encoding="UTF-8"?>
<ver:del xmlns:ver="http://petals.ow2.org/components/filetransfer/version-3">
<ver:filename>?</ver:filename>
</ver:del>

The service does not return a message.

The available exchange pattern is : InOnly.

Dir Operation

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

<?xml version="1.0" encoding="UTF-8"?>
<ver:dir xmlns:ver="http://petals.ow2.org/components/filetransfer/version-3" />

The OUT message returned to the consumer looks like :

<?xml version="1.0" encoding="UTF-8"?>
<tns:dirResponse xmlns:tns="http://petals.ow2.org/components/filetransfer/version-3">
         <tns:filename>file.xml</tns:filename>
         <tns:filename>file1.xml</tns:filename>
         <tns:filename>file2.xml</tns:filename>
</tns:dirResponse>

The service might return an ioFault.
The available exchange pattern is : InOut.

Configuration

Service Unit descriptor

Example of a File Transfer Service Unit descriptor that provides a Service:

<?xml version="1.0" encoding="UTF-8"?>
    <!--
        JBI descriptor for the PEtALS' "petals-bc-filetransfer" component
        (FileTransfer). Originally created for the version 3.0 of the component.
    -->
<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">

    <!--
        Import a Service into PEtALS or Expose a PEtALS Service => use a BC.
    -->
    <jbi:services binding-component="true">

        <!-- Import a Service into PEtALS => provides a Service. -->
        <jbi:provides endpoint-name="myFileTransferSUEndpointName"
            interface-name="filetransfer:FileTransfer" service-name="filetransfer:myFileTransferSUServiceName">

            <!-- CDK specific elements -->
            <petalsCDK:wsdl>FileTransferService.wsdl</petalsCDK:wsdl>
            <petalsCDK:validate-wsdl>true</petalsCDK:validate-wsdl>

            <!-- Component specific elements -->
            <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>
Configuration of a Service Unit to provide a service (JBI)

Parameter Description
Default
Required
provides Describe the JBI service that will be exposed into the JBI bus. Interface (QName), Service (QName) and Endpoint (String) attributes are required. - Yes

Configuration of a Service Unit to provide a service (CDK)

Parameter Description
 Default
 Required
timeout Timeout in milliseconds of a synchronous send. This parameter is used by the method sendSync (Exchange exchange) proposes by the CDK Listeners classes.
Set it to 0 for an infinite timeout. 		30000 No
exchange-properties This sections defines the list of properties to set to the JBI exchange when processing a service. - No
message-properties This sections defines the list of properties to set to the JBI message when processing a service. - No
validate-wsdl Activate the validation of the WSDL when deploying a service unit. true No
wsdl
Path to the WSDL document describing services and operations exposed by the provided JBI endpoints defined in the SU.
The value of this parameter is :
  • an URL
  • a file relative to the root of the SU package
    If not specified, a basic WSDL description is automaticaly provided by the CDK.
- No
forward-attachments
Defines if attachment will be forwarded from IN message to OUT message.
false No
forward-message-properties
Defines if the message properties will be forwarded from IN message to OUT message. false No
forward-security-subject
Defines if the security subject will be forwarded from IN message to OUT message. false No

Configuration of a Service Unit to provide a service (File Transfer)

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
No
backup-directory The directory where files are moved before being read.Environment variables are supported with the form ${myEnvVariable}. system's temporary directory
No
folder Working directory where files are written or retrieved. Environment variables are supported with the form ${myEnvVariable}  
Yes

Interceptor

Example of an interceptor configuration:

<?xml version="1.0" encoding="UTF-8"?>
<!--...-->
<petalsCDK:su-interceptors>
  <petalsCDK:send>
    <petalsCDK:interceptor name="myInterceptorName">
      <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
      <petalsCDK:param name="myParamName2">myParamValue2</petalsCDK:param>
    </petalsCDK:interceptor>
  </petalsCDK:send>
  <petalsCDK:accept>
    <petalsCDK:interceptor name="myInterceptorName">
      <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
    </petalsCDK:interceptor>
  </petalsCDK:accept>
  <petalsCDK:send-response>
    <petalsCDK:Interceptor name="myInterceptorName">
      <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
    </petalsCDK:Interceptor>
  </petalsCDK:send-response>
  <petalsCDK:accept-response>
    <petalsCDK:Interceptor name="myInterceptorName">
      <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
    </petalsCDK:Interceptor>
  </petalsCDK:accept-response>
</petalsCDK:su-interceptors>
<!--...-->

Interceptors configuration for SU (CDK)

Parameter Description Default Required
send Interceptor dedicated to send phase, for an exchange sent by a consumer - No
accept Interceptor dedicated to receive phase, for an exchange received by a provider - No
send-response Interceptor dedicated to send phase, for an exchange (a response) received by a consumer - No
accept-response Interceptor dedicated to receive phase, for an exchange sent (a response) by a provider - No
interceptor - name Logical name of the interceptor instance. It can be referenced to add extended parameters by a SU Interceptor configuration. - Yes
param[] - name The name of the parameter to use for the interceptor for this SU - No
param[] The value of the parameter to use for the interceptor for this SU - No

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
service-unit.zip
+ META-INF
    - jbi.xml (as defined above)
    - service.wsdl (optional)

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.

Configurations

Service Unit descriptor

Example 1: use of the parameter transfer-mode

<?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>

Example 2 : use of the parameter base-msg

<?xml version="1.0" encoding="UTF-8"?>
<!-- JBI descriptor for the Petals' "petals-bc-filetransfer" component (FileTransfer).
    Originally created for the version 3.0 of the component. -->
<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">
    <!-- Import a Service into Petals or Expose a Petals Service => use a BC. -->
    <jbi:services binding-component="true">
        <!-- Expose a Petals Service => consumes a Service. -->
        <jbi:consumes interface-name="itfNs:ftAttachmentBaseMsg"
            service-name="generatedNs:ftAttachmentBaseMsgService" endpoint-name="ftAttachmentBaseMsgEndpoint"
            xmlns:itfNs="http://petals.ow2.org/filetransfer">
            <!-- CDK specific elements -->
            <petalsCDK:timeout>30000</petalsCDK:timeout>
            <petalsCDK:mep>InOnly</petalsCDK:mep>
            <!-- Component specific elements -->
            <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>
Configuration of a Service Unit to consume a service (JBI)

Parameter Description Default Required
consumes Refer JBI service to invoke into the JBI bus.
You can define an explicit endpoint: interface (QName) / Service (QName) / Endpoint (String) attributes.
Or define implicit endpoint, to let the container routing according to QOS configurations (HA...):
-by Interface attribute (QName)
-by Service attribute (QName) 		- Yes


Configuration of a Service Unit to consume a service (CDK)

Parameter Description Default Required
mep Message exchange pattern abbreviation. This parameter can be used in conjunction with the method of the CDK Listeners: createMessageExchange(Extensions extensions).
This method returns a CDK Exchange corresponding to the type of the specified pattern. 		- Yes
operation Operation to call on a service. This parameter can be used in conjunction with the sending methods of the Listeners. If no operation is specified in the Message Exchange to send, this parameter will be used. - No
timeout Timeout in milliseconds of a synchronous send. This parameter can be used in conjunction with the sendSync(Exchange exchange) method of the Listeners. Set 0 for an infinite timeout. 30000 No


Configuration of a Service Unit to consume a service (File Transfer)
Attribute Description Default Value Required
folder Working directory where files are written or retrieved. $ {myEnvVariable} environment variables are supported.
-
Yes
backup-directory The directory where files are moved before being read.Environment variables are supported with the form ${myEnvVariable}.
default system temporary directory
No
polling-period Polling period in milliseconds
1000
No
filename Pattern used filter files to read
*
No
transfer-mode The mode of transfer of the received file(s) as message payload.
Accepted values : content, attachment.
attachment
No
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).
-
No
processor-pool-size For each service-unit, the component create a poller. This parameter defines the maximum number of processor thread created by the poller to process file. If no more processor thread are available, file to process are queued.
5
No
processor-pool-timeout Define eviction time in milliseconds for processor thread created by the poller.
10000ms
No
The parameter "transfer-mode" and "base-msg" can not be used at the same time.

Component Configuration

Configuration of the component (CDK)

Parameter Description Default Required Scope
acceptor-pool-size The size of the thread pool used to accept Message Exchanges from the NMR. Once a message is accepted, its processing is delegated to the processor pool thread. 3
Yes
Runtime
processor-pool-size The size of the thread pool used to process Message Exchanges. Once a message is accepted, its processing is delegated to one of the thread of this pool. 10 Yes
Runtime
processor-max-pool-size The maximum size of the thread pool used to process Message Exchanges. The difference between this size and the processorpool-size represents the dynamic threads that can be created and destroyed during overhead processing time.
50
No Runtime
notifications Enable the notifications mode. The component produces and consumes generic notifications when receiving and sending messages. See the Petals View documentation for further details.
false
No
Installation
notif-retry-policy-min The notification retry policy is triggered if the notification component is not reachable at the starting of the component.
Delay before the first notification retry is attempted, in second.
1 bounds to notifications Installation
notif-retry-policy-max The notification retry policy is triggered if the notification component is not reachable at the starting of the component.
The maximum delay value authorized, in second. 		60 bounds to notifications Installation
notif-retry-policy-factor The notification retry policy is triggered if the notification component is not reachable at the starting of the component.
The factor applies on the previous attempt, for each new attempt.
2
bounds to notifications Installation
notif-retry-policy-nb The notification retry policy is triggered if the notification component is not reachable at the starting of the component.
Number of retry once the maximum delay value is reached.
1000
bounds to notifications Installation
properties-file Name of the file containing properties used as reference by other parameters. Parameters of service-units and other parameters of the component reference the property name in the following pattern ${myPropertyName}. At runtime, the expression is replaced by the value of the property.

The value of this parameter is:
  • an URL
  • a file relative to the PEtALS installation path
  • an empty value to stipulate a non-using file
 - No Installation

Definition of CDK parameter scope :

  • Installation: The parameter can be set during the installation of the component, by using the installation MBean (see JBI specifications for details about the installation sequence). If the parameter is optional and has not been defined during the development of the component, it is not available at installation time.
  • Runtime: The paramater can be set during the installation of the component and during runtime. The runtime configuration can be changed using the CDK custom MBean named RuntimeConfiguration. If the parameter is optional and has not been defined during the development of the component, it is not available at installation and runtime times.

Interceptor

Interceptors can be defined to inject some post or pre processing in the component during service processing.

Using interceptor is very sensitive and must be manipulate only by power users. An non properly coded interceptor engaged in a component can lead to uncontrolled behaviors, out of the standard process.

Example of an interceptor configuration:

<?xml version="1.0" encoding="UTF-8"?>
<!--...-->
<petalsCDK:component-interceptors>
  <petalsCDK:interceptor active="true" class="org.ow2.petals.myInterceptor" name="myInterceptorName">
    <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
    <petalsCDK:param name="myParamName2">myParamValue2</petalsCDK:param>
  </petalsCDK:interceptor>
</petalsCDK:component-interceptors>
<!--...-->

Interceptors configuration for Component (CDK)

Parameter Description Default Required
interceptor - class Name of the interceptor class to implement. This class must extend the abstract class org.ow2.petals.component.common.interceptor.Interceptor. This class must be loadable from the component classloader, or in a dependent Shared Library classloader. - Yes
interceptor - name Logical name of the interceptor instance. It can be referenced to add extended parameters by a SU Interceptor configuration. - Yes
interceptor - active If true, the Interceptor instance is activated for every SU deployed on the component.
If false, the Interceptor can be activated:
-by the InterceptorManager Mbean at runtime, to activate the interceptor for every deployed SU.
-by a SU configuration 		- Yes
param[] - name The name of the parameter to use for the interceptor. - No
param[] The value of the parameter to use for the interceptor. - No

Table of contents
Contributors
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.