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.

All attachment are processed by using XOP rules.(XML-binary Optimized Packaging : http://www.w3.org/TR/xop10/ )

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).

All operations support wild card character

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.

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

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

Example : {http://petals.ow2.org/components/ftp/version-3}put

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 :

<?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>
   <!--Optional:-->
   <ver:connection>
      ...
   </ver:connection>
</ver:put>

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.

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 :

<?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>
     <!--Optional:-->
   <ver:connection>
     ...
   </ver:connection>
</ver:mput>

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.

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 :

<?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>
    <!--Optional:-->
    <ver:connection>
      ...
    </ver:connection>
 </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 the FTP connection failed

The available exchange patterns is : InOut.

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

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 :

<?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>
    <!--Optional:-->
    <ver:connection>
      ...
    </ver:connection>
 </ver:getAsAttachment>

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

<?xml version="1.0" encoding="UTF-8"?>
<tns:getAsAttachmentResponse xmlns:tns="http://petals.ow2.org/components/ftp/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 the FTP connection failed

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

<?xml version="1.0" encoding="UTF-8"?>
<ver:mget xmlns:ver="http://petals.ow2.org/components/ftp/version-3">
    <!--1 or more repetitions:-->
    <ver:filename>*.xml</ver:filename>
    <ver:filename>myFile.txt</ver:filename>
    <!--Optional:-->
    <ver:connection>
     ...
    </ver:connection>
</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/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>

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.

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 :

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

The OUT message returned to the consumer is defined as follow :

<tns:dirResponse xmlns:tns="http://petals.ow2.org/components/ftp/version-3">
         <!--Zero or more repetitions:-->
         <tns:filename>file1.txt</tns:filename>
         <tns:filename>linux.jpg</tns:filename>
</tns:dirResponse>

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.

Del Operation

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

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

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.

Configuration

Service Unit descriptor

An example of a Service Unit descriptor to provide an FTP service:

<?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">
        
        <!-- CDK specific elements -->
        <petalsCDK:timeout>30000</petalsCDK:timeout>
        <petalsCDK:validate-wsdl>true</petalsCDK:validate-wsdl>
        <petalsCDK:wsdl>FtpService.wsdl</petalsCDK:wsdl>

        <!-- Component specific elements -->
        <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:max-idle-time>10000</ftp:max-idle-time>
        <ftp:max-connection>-1</ftp:max-connection>
</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 (FTP)

Parameter	Description	Default	Required
server	IP or DNS name of the server	-	Yes except when using FtpService
port	the port number of the FTP server	21	No
user	the user login name used to connect to the server	-	Yes except when using FtpService
password	the user password	-	Yes except when using FtpService
folder	the folder on the FTP server	-	No
filename	file name for the standard PUT operation (write the XML message content on the FTP server)	content.xml	No
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)	active	No
transfer-type	transfer mode used for put or get files ascii/binary	ascii	No
delete-processed-files	If true, the service delete the files processed by operation get or mget	false	No
encoding	Set the encoding encoding value used to process FTP operation	Default JVM Encoding	No
max-idle-time	Max idle connection time (milliseconds). Default value is 10000ms	10000 ms	No
max-connection	This parameter specifies the maximum number of simultaneous connection allowed by the FTP server.	-1 (unlimited)	No

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)

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