Petals Documentation > Petals ESB > Petals Components > Components User Guide > Petals-BC-Filetransfer > Petals-BC-Filetransfer 5.2.0+

Petals-BC-Filetransfer 5.2.0+

This version must be installed on [Petals ESB 5.4.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/ )
Table of contents
Contributors
No contributors found for: authors on selected page(s)

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

All operations support wild card character.
All operations are in namespace http://petals.ow2.org/components/filetransfer/version-5.

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-5">?</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 xmlns:ver="http://petals.ow2.org/components/filetransfer/version-5">
    <ver:attachments>
        <!--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 nominal response. It might return fault on following conditions, otherwise an error is returned:

  • when no attachment is provided in the request, the fault 'fileAttachmentExpected' is returned.

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. By default, the file is moved to the backup directory configured at service unit level.

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-5">
     <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 fault on following conditions, otherwise an error is returned:

  • when the element 'filename' is missing in the request, the fault 'filenameMissing' is returned,
  • when the expected file is not found, the fault 'noFileFound' is returned,
  • when the expected file is not a XML file, the fault 'xmlFileExpected' is returned,
  • when the expected file is locked for writing by another process, the fault 'fileLocked' is returned.

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. By default, the file is moved to the backup directory configured at service unit level.
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-5">
     <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-5">
  <tns:file-content>
    <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:test1.xml"/>
  </tns:file-content>
</tns:getAsAttachmentResponse>

The service might return fault on following conditions, otherwise an error is returned:

  • when the element 'filename' is missing in the request, the fault 'filenameMissing' is returned,
  • when the expected file is not found, the fault 'noFileFound' is returned,
  • when the expected file is locked for writing by another process, the fault 'fileLocked' is returned.

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. By default, the files returned are moved to the backup directory configured at service unit level.
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-5">
   <\!\--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-5">
  <tns:file-content><xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:test1.xml"/></tns:file-content>
  <tns:file-content><xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:myFile.txt"/></tns:file-content>
</tns:mgetResponse>

The service might returns error but no fault.

If a file matching request criteria is locked for writing by another process, it will not be returned until it is unlocked.

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-5">
         <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-5">
         <ver:filename>?</ver:filename>
         <ver:exist>true|false</ver:exist>
</ver:checkFileResponse>

The service might return fault on following conditions, otherwise an error is returned:

  • when the element 'filename' is missing in the request, the fault 'filenameMissing' is returned.

The available exchange pattern is : InOut.

Del Operation

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

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

The service does not return a nominal response. It might return fault on following conditions, otherwise an error is returned:

  • when the element 'filename' is missing in the request, the fault 'filenameMissing' is returned.

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. A wild card expression can be given to filter files returned. f no wild card expression is given, or if it is empty, all files will be listed:

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

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-5">
         <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

All needed information must be defined in the service-unit JBI descriptor. This JBI descriptor is configured through parameters divided in following groups:

  • JBI parameters that defines the service provider identification,
  • CDK parameters that are parameters driving the service provider implementation at CDK layer,
  • CDK interceptor parameters that are parameters driving interceptors at CDK layer,
  • Dedicated parameters that are parameters driving the service provider implementation at component layer.

Placeholder

A placeholder is a specific value that is resolved at runtime against a property available in the property file set at component level. It is mainly used in the service unit JBI descriptor to be able to configure your service providers and/or your service consumers.

<service-unit-parameter>${dgfip.quotient-familial.base-url}</service-unit-parameter>

Its syntax is: '${placeholder-name[:default-value]}',

  • if no property with name 'placeholder-name' exists in the component property file, the default value 'default-value' is used. If no default value is defined, the literal value '${placeholder-name}' is used,
  • if a placeholder name must contain the character ':' (colon), it must be escaped by the character '\', example: ${placeholder-name-with-\:-colon:default-value}',
  • if a placeholder default value must contain the character ':' (colon), it must be escaped by the character '\', example: ${placeholder-name:default-value-with-\:-colon}'.
  • the escape character can be escaped by itself.

Placeholders are not supported for each service unit parameter, check your documentation before to use them.
It is also possible to change a placeholder value at runtime reloading the component property file. It is not sufficient, the parameter associated to the placeholder must be changeable at runtime. So check component documentation to know that.

CDK parameters defining service provider implementation

The following parameters correspond to the CDK configuration of the service provider implementation.

The service provider is defined into the section 'provides' of the JBI descriptor, containing:

Parameter
Description
Default
Required
Support placeholders
interface-name
 Interface name of the service provider. Must match the one defined in the WSDL.
-
Yes
No
service-name
 Service name of the service provider. Must match the one defined in the WSDL.
-
Yes
No
endpoint-name
 Endpoint name of the service provider. Must match the one defined in the WSDL. The value 'autogenerate' will force Petals ESB to generate an endpoint name as UUID at deployment time.
-
Yes
No
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
Yes
su-interceptors
 Service unit interceptor configuration. See Service unit interceptor configuration.
-
No
No
exchange-properties
 This sections defines the list of properties to set to the JBI exchange when processing a service.
-
No
No
message-properties
 This sections defines the list of properties to set to the JBI message when processing a service.
-
No
No
validate-wsdl
 Activate the validation of the WSDL when deploying a service unit.
true
No
No
forward-security-subject
 Defines if the security subject will be forwarded from IN message to OUT message.
false
No
No
forward-message-properties
 Defines if the message properties will be forwarded from IN message to OUT message.
false
No
No
forward-attachments
 Defines if attachment will be forwarded from IN message to OUT message.
false
No
No
activate-flow-tracing
 Enable ('true') or disable ('false') the flow tracing for this service provider. This value overrides the value defined at component level and can be overridden at incoming exchange level.
Value defined at component
No
Yes
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 automatically provided by the CDK.
-
Yes
No

CDK parameters driving interceptors

The following parameters drive interceptors at CDK layer.

Interceptors can be defined to inject some post or pre-processing in the service provider processing or service consumer processing.

Using interceptor is very sensitive and must be manipulated only by power users. A 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"?>
<jbi:jbi xmlns:jbi="http://java.sun.com/xml/ns/jbi" xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5">
   <jbi:services>
      <jbi:provides|consumes>
         <!--...-->
         <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>
         <!--...-->
      </jbi:provides|consumes>
      <!--...-->
   </jbi:services>
</jbi:jbi>

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 defined at component level, see CDK Component 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

Dedicated configuration

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 after to be 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
is-read-only For operations getting files, if set to 'true', files are not moved to the backup directory (see backup-directory).
false
Yes
locking-wait-time For operations getting files, the maximum wait time (in seconds) for a locked file to be unlocked before to return the fault 'fileLocked'.
Value of 'locking-wait-time' defined at component level
No
locking-poll-interval For operations getting files, the polling interval (in milliseconds) to check the maximum wait time for locked files.
Value of 'locking-poll-interval' defined at component level
No

Service Unit content

The service unit has to contain the following elements, packaged in the archive:

  • the META-INF/jbi.xml descriptor file as described above,
  • it is also highly recommended to provide a WSDL description for service provider embedded in the service-unit. The service provider contract must implement the interface "{http://petals.ow2.org/components/filetransfer/version-5}FileTransfer" defined in the abstract WSDL 'FileTransferInterface.wsdl' available as resource in the component archive.
service-unit.zip
  + META-INF
    - jbi.xml (as defined above)
  - service.wsdl (recommended)

Example

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

<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi version="1.0"
    xmlns:filetransfer="http://petals.ow2.org/components/filetransfer/version-5"
    xmlns:generateNs="http://petals.ow2.org/filetransfer"
    xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
    xmlns:jbi="http://java.sun.com/xml/ns/jbi"
    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="generateNs:myFileTransferSUServiceName">

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

            <!-- Component specific elements -->
            <filetransfer:filename>gettingstarted.xml</filetransfer:filename>
            <filetransfer:backup-directory>${PETALS_HOME}/filetransfer/backup</filetransfer:backup-directory>
            <filetransfer:folder>${PETALS_HOME}/filetransfer/out</filetransfer:folder>
        </jbi:provides>
    </jbi:services>
</jbi:jbi>

Invoking service on incoming file (Consumes mode)

If you want to invoke a service provider in Petals ESB with files, put the files in the configured directory (folder}). At each configured polling period ({{polling-period), the component fetches 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 attaches 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 according to MTOM optimization 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.

A InOut service provider can be exposed to be consumed through files. The content of its reply will be ignored. By default the message exchange pattern used to send messages to the service provider is 'InOnly'. Just set the right value into the parameter mep in the section consumes of the SU JBI descriptor.

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.

Configuration

All needed information must be defined in the service-unit JBI descriptor. This JBI descriptor is configured through parameters divided in following groups:

  • JBI parameters that defines the service provider identification,
  • CDK parameters that are parameters driving the service consumer implementation at CDK layer,
  • CDK interceptor parameters that are parameters driving interceptors at CDK layer,
  • Dedicated parameters that are parameters driving the service consumer implementation at component layer.

Placeholder

A placeholder is a specific value that is resolved at runtime against a property available in the property file set at component level. It is mainly used in the service unit JBI descriptor to be able to configure your service providers and/or your service consumers.

<service-unit-parameter>${dgfip.quotient-familial.base-url}</service-unit-parameter>

Its syntax is: '${placeholder-name[:default-value]}',

  • if no property with name 'placeholder-name' exists in the component property file, the default value 'default-value' is used. If no default value is defined, the literal value '${placeholder-name}' is used,
  • if a placeholder name must contain the character ':' (colon), it must be escaped by the character '\', example: ${placeholder-name-with-\:-colon:default-value}',
  • if a placeholder default value must contain the character ':' (colon), it must be escaped by the character '\', example: ${placeholder-name:default-value-with-\:-colon}'.
  • the escape character can be escaped by itself.

Placeholders are not supported for each service unit parameter, check your documentation before to use them.
It is also possible to change a placeholder value at runtime reloading the component property file. It is not sufficient, the parameter associated to the placeholder must be changeable at runtime. So check component documentation to know that.

CDK parameters defining service consumer implementation

The following parameters correspond to the CDK configuration of the service consumer implementation.

A service consumer is defined into the section 'consumes' of the JBI descriptor, containing:

Parameter
Description
Default
Required
Support placeholders
interface-name
 Interface name of the service provider to invoke.
-
Yes
No
service-name
 Service name of the service provider to invoke.
-
No
No
endpoint-name
 Endpoint name of the service provider to invoke.
-
No
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
Yes
operation
 Operation to call on the service provider. If no operation is specified in the Message Exchange to send, this parameter will be used.
-
No
No
activate-flow-tracing
 Enable ('true') or disable ('false') the flow tracing for this service consumer. This value overrides the value defined at component level and can be overridden at incoming exchange level. Value defined at component level
No
Yes
propagate-flow-tracing-activation
 Control whether the flow tracing activation state must be propagated to next flow steps or not. If 'true', the flow tracing activation state is propagated to the invoked service provider. This value overrides the value defined at component level. Value defined at component
No
Yes
su-interceptors
 Service unit interceptor configuration. See Service unit interceptor configuration.
-
No
No
mep
 Message exchange pattern to use.
-
Yes
No

CDK parameters driving interceptors

The following parameters drive interceptors at CDK layer.

Interceptors can be defined to inject some post or pre-processing in the service provider processing or service consumer processing.

Using interceptor is very sensitive and must be manipulated only by power users. A 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"?>
<jbi:jbi xmlns:jbi="http://java.sun.com/xml/ns/jbi" xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5">
   <jbi:services>
      <jbi:provides|consumes>
         <!--...-->
         <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>
         <!--...-->
      </jbi:provides|consumes>
      <!--...-->
   </jbi:services>
</jbi:jbi>

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 defined at component level, see CDK Component 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

Dedicated configuration

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
external-processor-thread-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 incoming files until the service provider invocation. If no more processor thread is available, the associated incoming file to process will be postponed after the next polling period.
5
No
external-processor-thread-pool-timeout Define the max wait time, in millisecond, to get a thread from the pool. If not possible, the associated incoming file to process will be postponed after the next polling period.
10000ms
No
external-processor-block-size Define the number of incoming files processed concurrently in the sliding window, or '0' for no limitation.
0
No
external-processor-max-wait Define the max waiting time, in millisecond, that an incoming file waits to enter in the sliding window. If it can't, its processing will be postponed after the next polling period. This parameter has no sens if external-processor-block-size is set to '0'.
500ms
No

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

Service unit content

The service unit has to contain the following elements, packaged in the archive:

  • the META-INF/jbi.xml descriptor file as described above,.
service-unit.zip
  + META-INF
    - jbi.xml (as defined above)

Example

Example 1: use of the parameter 'transfer-mode'

<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi version="1.0"
    xmlns:providerNs="http://petals.ow2.org/filetransfer/my-provider"
    xmlns:filetransfer="http://petals.ow2.org/components/filetransfer/version-5"
    xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
    xmlns:jbi="http://java.sun.com/xml/ns/jbi"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <jbi:services binding-component="false">
        <jbi:consumes
            interface-name="providerNs:ftContentNoBaseMsg"
            service-name="providerNs:ftContentNoBaseMsgService"
            endpoint-name="ftContentNoBaseMsgEndpoint">

            <petalsCDK:timeout>20</petalsCDK:timeout>
            <petalsCDK:mep>InOnly</petalsCDK:mep>
            <petalsCDK:operation>providerNs: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:jbi version="1.0"
    xmlns:providerNs="http://petals.ow2.org/filetransfer/my-provider"
    xmlns:filetransfer="http://petals.ow2.org/components/filetransfer/version-5"
    xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
    xmlns:jbi="http://java.sun.com/xml/ns/jbi"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <jbi:services binding-component="true">
        <jbi:consumes
            interface-name="providerNs:ftAttachmentBaseMsg"
            service-name="providerNs:ftAttachmentBaseMsgService"
            endpoint-name="ftAttachmentBaseMsgEndpoint">

            <petalsCDK:timeout>30000</petalsCDK:timeout>
            <petalsCDK:mep>InOnly</petalsCDK:mep>
            <petalsCDK:operation>providerNs:simplefiletransfer</petalsCDK:operation>

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

Configuring the component

The component can be configured through the parameters of its JBI descriptor file. These parameters are divided in following groups:

  • JBI parameters that have not to be changed otherwise the component will not work,
  • CDK parameters that are parameters driving the processing of the CDK layer,
  • Dedicated parameters that are parameters specific to this component.

CDK parameters

The component configuration includes the configuration of the CDK. The following parameters correspond to the CDK configuration.

Parameter Description Default 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. 1
 Runtime
acceptor-retry-number Number of tries to submit a message exchange to a processor for processing before to declare that it cannot be processed. 40
 Installation
acceptor-retry-wait Base duration, in milliseconds, to wait between two processing submission tries. At each try, the new duration is the previous one plus this base duration. 250
 Installation
acceptor-stop-max-wait The max duration (in milliseconds) before, on component stop, each acceptor is stopped by force. 500
 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 Runtime
processor-max-pool-size The maximum size of the thread pool used to process Message Exchanges. The difference between this size and the processor-pool-size represents the dynamic threads that can be created and destroyed during overhead processing time.
50
 Runtime
processor-keep-alive-time When the number of processors is greater than the core, this is the maximum time that excess idle processors will wait for new tasks before terminating, in seconds.
300
 Runtime
processor-stop-max-wait The max duration (in milliseconds) of message exchange processing on stop phase (for all processors).
 15000
 Runtime
time-beetween-async-cleaner-runs The time (in milliseconds) between two runs of the asynchronous message exchange cleaner.
 2000
 Installation
properties-file Name of the file containing properties used as reference by other parameters. Parameters reference the property name using a placeholder in the following pattern ${myPropertyName}. At runtime, the expression is replaced by the value of the property.

The properties file can be reloaded using the JMX API of the component. The runtime configuration MBean provides an operation to reload these place holders. Check the service unit parameters that support this reloading.

The value of this parameter is :
  • an URL
  • a file relative to the PEtALS installation path
  • an absolute file path
  • an empty value to stipulate a non-using file.
 - Installation
monitoring-sampling-period Period, in seconds, of a sample used by response time probes of the monitoring feature. 300 Installation
activate-flow-tracing Enable ('true') or disable ('false') the flow tracing. This value can be overridden at service consumer or service provider level, or at exchange level. true Runtime
propagate-flow-tracing-activation Control whether the flow tracing activation state must be propagated to next flow steps or not. If 'true', the flow tracing activation state is propagated. This value can be overridden at service consumer level. true Runtime
component-interceptors Component interceptor configuration. See CDK Component interceptor configuration. - See Maven Petals plugin to known how to inject component interceptor configuration in component configuration

* Definition of CDK parameter scopes:

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

Interception configuration

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 manipulated only by power users. A 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"?>
<jbi:jbi xmlns:jbi="http://java.sun.com/xml/ns/jbi" xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5" ...>
   <jbi:component>
      <!--...-->
      <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>
      <!--...-->
   </jbi:component>
</jbi:jbi>

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 is referenced at service unit level to register this interceptor for services of the service unit. See 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

Dedicated configuration

These parameters drive features proposed by the component

Parameter Description Default Required Scope
locking-wait-time For operations getting files, the maximum wait time (in seconds) for a locked file to be unlocked before to return the fault 'fileLocked'. Can be overriden by service unit configuration.
5
No
Installation & Runtime
locking-poll-interval For operations getting files, the polling interval (in milliseconds) to check the maximum wait time for locked files. Can be overriden by service unit configuration.
500
No
Installation & Runtime

Business monitoring

MONIT traces

Each service provider exposed in Petals ESB is able to log MONIT traces with following information:

  • on service provider invocation, when receiving an incoming request, with following attributes:
    • traceCode set to provideFlowStepBegin,
    • flowInstanceId set to the flow instance identifier retrieved from the incoming request,
    • flowStepId set to an UUID value,
    • flowStepInterfaceName set to the service provider interface name,
    • flowStepServiceName set to the service provider service name,
    • flowStepOperationName set to the operation of the invoked service provider,
    • flowStepEndpointName set to the service provider endpoint name,
    • flowPreviousStepId set to the step identifier of the previous step, retrieved from the incoming request.
  • on external service provider invocation, when sending a request to the external service provider, with following attributes:
    • traceCode set to provideExtFlowStepBegin,
    • flowInstanceId set to the flow instance identifier retrieved from the incoming request,
    • flowStepId set to an UUID value,
    • flowPreviousStepId set to the step identifier of the previous step that is the internal processing of the incoming request into the BC.
  • on external service provider termination, when receiving the outgoing response of the external service provider, with following attributes:
    • traceCode set to provideExtFlowStepEnd or provideExtFlowStepFailure,
    • flowInstanceId set to the flow instance identifier retrieved from the incoming request,
    • flowStepId set to the flow step identifier defined for the external service provider invocation.
  • on service provider termination, when returning the outgoing response, with following attributes:
    • traceCode set to provideFlowStepEnd or provideFlowStepFailure,
    • flowInstanceId set to the flow instance identifier retrieved from the incoming request,
    • flowStepId set to the flow step identifier defined on incoming request receipt.

Flow tracing activation

The flow tracing (ie. MONIT traces generation) is defined according to the property 'org.ow2.petals.monitoring.business.activate-flow-tracing' of the incoming request. If the property does not exist, the parameter activate-flow-tracing of the service provider definition will be inspected. If no parameter is defined at service provider level, the component configuration parameter 'activate-flow-tracing' is used. Finally, by default, the flow tracing is enabled.

Monitoring the component

Using metrics

Several probes providing metrics are included in the component, and are available through the JMX MBean 'org.ow2.petals:type=custom,name=monitoring_<component-id>', where <component-id> is the unique JBI identifier of the component.

Common metrics

The following metrics are provided through the Petals CDK, and are common to all components:

Metrics, as MBean attribute Description Detail of the value Configurable
MessageExchangeAcceptorThreadPoolMaxSize The maximum number of threads of the message exchange acceptor thread pool integer value, since the last startup of the component yes, through acceptor-pool-size
MessageExchangeAcceptorThreadPoolCurrentSize The current number of threads of the message exchange acceptor thread pool. Should be always equals to MessageExchangeAcceptorThreadPoolMaxSize. instant integer value no
MessageExchangeAcceptorCurrentWorking The current number of working message exchange acceptors. instant long value no
MessageExchangeAcceptorMaxWorking The max number of working message exchange acceptors. long value, since the last startup of the component no
MessageExchangeAcceptorAbsoluteDurations The aggregated durations of the working message exchange acceptors since the last startup of the component. n-tuple value containing, in nanosecond:
  • the maximum duration,
  • the average duration,
  • the minimum duration.
 no
MessageExchangeAcceptorRelativeDurations The aggregated durations of the working message exchange acceptors on the last sample. n-tuple value containing, in nanosecond:
  • the maximum duration,
  • the average duration,
  • the minimum duration,
  • the 10-percentile duration (10% of the durations are lesser than this value),
  • the 50-percentile duration (50% of the durations are lesser than this value),
  • the 90-percentile duration (90% of the durations are upper than this value).
 no
MessageExchangeProcessorAbsoluteDurations The aggregated durations of the working message exchange processor since the last startup of the component. n-tuple value containing, in milliseconds:
  • the maximum duration,
  • the average duration,
  • the minimum duration.
 no
MessageExchangeProcessorRelativeDurations The aggregated durations of the working message exchange processor on the last sample. n-tuple value containing, in milliseconds:
  • the maximum duration,
  • the average duration,
  • the minimum duration,
  • the 10-percentile duration (10% of the durations are lesser than this value),
  • the 50-percentile duration (50% of the durations are lesser than this value),
  • the 90-percentile duration (90% of the durations are upper than this value).
 no
MessageExchangeProcessorThreadPoolActiveThreadsCurrent The current number of active threads of the message exchange processor thread pool instant integer value no
MessageExchangeProcessorThreadPoolActiveThreadsMax The maximum number of threads of the message exchange processor thread pool that was active integer value, since the last startup of the component no
MessageExchangeProcessorThreadPoolIdleThreadsCurrent The current number of idle threads of the message exchange processor thread pool instant integer value no
MessageExchangeProcessorThreadPoolIdleThreadsMax The maximum number of threads of the message exchange processor thread pool that was idle integer value, since the last startup of the component no
MessageExchangeProcessorThreadPoolMaxSize The maximum size, in threads, of the message exchange processor thread pool instant integer value yes, through http-thread-pool-size-max
MessageExchangeProcessorThreadPoolMinSize The minimum size, in threads, of the message exchange processor thread pool instant integer value yes, through http-thread-pool-size-min
MessageExchangeProcessorThreadPoolQueuedRequestsCurrent The current number of enqueued requests waiting to be processed by the message exchange processor thread pool instant integer value no
MessageExchangeProcessorThreadPoolQueuedRequestsMax The maximum number of enqueued requests waiting to be processed by the message exchange processor thread pool since the last startup of the component instant integer value no
ServiceProviderInvocations The number of service provider invocations grouped by:
  • interface name, as QName, the invoked service provider,
  • service name, as QName, the invoked service provider,
  • invoked operation, as QName,
  • message exchange pattern,
  • and execution status (PENDING, ERROR, FAULT, SUCCEEDED).
 integer counter value since the last startup of the component no
ServiceProviderInvocationsResponseTimeAbs The aggregated response times of the service provider invocations since the last startup of the component grouped by:
  • interface name, as QName, the invoked service provider,
  • service name, as QName, the invoked service provider,
  • invoked operation, as QName,
  • message exchange pattern,
  • and execution status (PENDING, ERROR, FAULT, SUCCEEDED).
 n-tuple value containing, in millisecond:
  • the maximum response time,
  • the average response time,
  • the minimum response time.
 no
ServiceProviderInvocationsResponseTimeRel The aggregated response times of the service provider invocations on the last sample, grouped by:
  • interface name, as QName, the invoked service provider,
  • service name, as QName, the invoked service provider,
  • invoked operation, as QName,
  • message exchange pattern,
  • and execution status (PENDING, ERROR, FAULT, SUCCEEDED).
 n-tuple value containing, in millisecond:
  • the maximum response time,
  • the average response time,
  • the minimum response time,
  • the 10-percentile response time (10% of the response times are lesser than this value),
  • the 50-percentile response time (50% of the response times are lesser than this value),
  • the 90-percentile response time (90% of the response times are lesser than this value).
 no

Dedicated metrics

No dedicated metric is available.

Receiving alerts

Several alerts are notified by the component through notification of the JMX MBean 'org.ow2.petals:type=custom,name=monitoring_<component-id>', where <component-id> is the unique JBI identifier of the component.

To integrate these alerts with Nagios, see Receiving Petals ESB defects in Nagios.

Common alerts

Defect JMX Notification
A message exchange acceptor thread is dead
  • type: org.ow2.petals.component.framework.process.message.acceptor.pool.thread.dead
  • no user data
No more thread is available in the message exchange acceptor thread pool
  • type: org.ow2.petals.component.framework.process.message.acceptor.pool.exhausted
  • no user data
No more thread is available to run a message exchange processor
  • type: org.ow2.petals.component.framework.process.message.processor.thread.pool.exhausted
  • no user data

Dedicated alerts

No dedicated alert is available.

Known problems

Encoding problem about filename on a filesystem mounted through Samba

An encoding problem can occurs about filename with Samba mounts.
Please check that the encoding is correctly configured at Samba level through the parameters 'unix charset' and 'display charset'.

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