PEtALS

Chapter 2. Service Configuration
Prev PEtALS-BC-Filetransfer Next

Table of Contents

2.1. Sending files
2.1.1. Service Unit descriptor
2.1.2. Usage
2.2. Receiving files
2.2.1. Service Unit descriptor
2.2.2. Usage

Figure 2.1. Consumes a JBI service on new file(s)

Consumes a JBI service on new file(s)

<jbi version="1.0" xmlns='http://java.sun.com/xml/ns/jbi'
    xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
    xmlns:petals="http://petals.objectweb.org/"
    xmlns:extensions="http://petals.objectweb.org/extensions/"
    xmlns:keyvalue="http://petals.objectweb.org/extensions/key-value/">

  <services binding-component="true">
    <consumes interface-name="Zip"
      service-name="petals:ZipService"
      endpoint-name="ZipEndpoint">

      <extensions:extensions>
        <keyvalue:extension>
          <address>/home/petals/filetransfer/scandirectory</address>
          <operation>zipfile</operation>
          <polling-period>5000</polling-period>
          <output-dir>/home/petals/filetransfer/outputdirectory</output-dir>
          <filename-filter>.xml</filename-filter>
        </keyvalue:extension>
      </extensions:extensions>

    </consumes>
  </services>
</jbi>

Table 2.1. service-unit attributes to provide services

AttributeDescriptionDefaultRequired
consumesName of the JBI service that will be called into the JBI environment. Only the interface (Qname) name can be provided (the container will choose a ServiceEndpoint for this interface), or you can only set service (qname) and endpoint (string) names, without the interface name. Yes

Table 2.2. extensions

AttributeDescriptionDefault ValueRequired
addressaddress of the polled directory. It is recommended to create absolute address. yes
operationoperation to invoke on the foreign JBI endpoint yes
attachmentsend the file(s) as JBI attchament if value is true or put the file content as JBI message payload.falseno
polling-periodthe directory polling period in ms.2000no
output-dirthe directory used to save files returned by foreign JBI endpoint$INSTALL/workno
filename-filterUsed to filter just a subset of the direcotry files. If a file name contains the filter value, it will be added in the outgoing attachment.[empty string]no
mepThe MEP to use for the message exchange. Possible values are 'in-only', 'in-opt-out', 'in-out', 'robust-in-only'in-onlyno
add-tagsA list of white space separated strings such as 'tag1 tag2 tagN'. These values will be used to wrap the incoming message. A simple message like '<data>simple message content</data>' will becomeWrapped message will be '<tag1><tag2><tagN><data>simple message content</data></tagN></tag2></tag1>' and written to file. no

If you want to send files to a JBI endpoint, put files in the directory defined by the address element. The filetransfer component will detect new files in the directory and then send them to the service and endpoint defined in the consumes section of the service unit descriptor.

In the previous code snippet, when '.xml' files are detected in the /home/petals/filetransfer/scandirectory directory, a message exchange will be created, its operation will be set the 'zipfile' and message will be sent to the 'ZipEndpoint'.

Figure 2.2. Provides a JBI service to write JBI messages into directory

Provides a JBI service to write JBI messages into directory

<jbi version="1.0" xmlns='http://java.sun.com/xml/ns/jbi'
  xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  xmlns:petals="http://petals.objectweb.org/"
  xmlns:extensions="http://petals.objectweb.org/extensions/"
  xmlns:keyvalue="http://petals.objectweb.org/extensions/key-value/">
  <services binding-component="true">

    <provides interface-name="TestOnJBIMessage"
      service-name="petals:TestOnJBIMessageService"
      endpoint-name="TestOnJBIMessageEndpoint">

      <extensions:extensions>
        <keyvalue:extension>
          <address>/home/petals/filetransfer/receive</address>
        </keyvalue:extension>
      </extensions:extensions>
    </provides>

  </services>
</jbi>

Table 2.3. service-unit attributes to provide services

AttributeDescriptionDefaultRequired
providesName of the JBI service that will be activated to expose the directory into the JBI environment. interface (qname), service (qname) and endpoint (string) name are required. Yes

Address is composed of these elements, which are destined to be configurable as extensions :

Table 2.4. address attributes for sending mails

AttributeDescriptionDefault ValueRequired
addressThe name of the local host directory to write incoming JBI message to. It is recommended to create absolute address. yes
file-nameThe file name prefix that will be used when created new files on incoming JBI messages.contentno
remove-tagsA list of white space separated strings such as 'tag1 tag2 tagN'. These values will be used to unwrap the incoming message content. A simple message like <tag1><tag2><tagN><data>simple message content</data></tagN></tag2></tag1>' will become '<data>simple message content</data>'. no
scriptThe name of a system script to be launched on incoming JBI message. If the script is not found in the path if will throw an HandlingException.  

When deploying a service unit like in the previous code snippet, all the JBI messages received on the TestOnJBIMessageService service will be analyzed and will produce new files in the /home/petals/filetransfer/receive directory defined in the extensions.

Prev Up Next
Chapter 1. Component Configuration Home Chapter 3. Samples