Features

The Quartz Service-Engine schedules jobs to trigger services invocations within the JBI bus. The jobs are based on time policies.
Concretely, when a job is triggered, the Quartz component sends a pre-defined message to execute the target service.

This component only acts as a service consumer and does not act as a service provider.

This component relies on the Quartz open source project.
For more details about Quartz usage, visit its website at http://www.quartz-scheduler.org/

Recommended usage

This component should be used to plan and launch service execution at determined moments.
As an example, you can use it to execute a given service every day at noon, or execute another service every 3 hours...
Each service-unit consumes one service, i.e. manages the invocation of one JBI service based a time (CRON) expression.

General information

Since this component only supports consuming configurations, no WSDL is required.
However, the messages sent by this component must respect the WSDL of the invoked service.
One way to ensure that is to generate the message's XML skeleton from the WSDL of the target service.
A tool like SoapUI works well for this kind of task.

The messages sent by this component are sent with the InOnly pattern.
It is not possible to add file attachments in the sent messages. These messages only have an XML payload.
This message is sent every time the time expression is reached.

Time expressions are CRON expressions. The syntax is explained on the website of the Quartz project.
Below are given some sample CRON expressions and their meaning.

Component Configuration

This component has no specific parameter in its configuration.
It only has the inherited ones from the CDK.

Service Configuration

Service Unit Descriptor

The Quartz component is configured with a CRON expression, a service to call and an XML message request to send to the service.
You have to deploy a Service Unit with a JBI descriptor containing a consumes section with the right parameters.

Here is a sample of a SU JBI descriptor to call a Hello service with <text>hello</text> message, at 10:15am every day during the year 2005.

<?xml version="1.0" encoding="UTF-8"?>

<!-- JBI descriptor for PEtALS' "petals-se-quartz" (QUARTZ), version 1.1 -->
<jbi:jbi version="1.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:jbi="http://java.sun.com/xml/ns/jbi"
    xmlns:quartz="http://petals.ow2.org/components/quartz/version-1"
    xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
    xmlns:generatedNs="http://petals.ow2.org/components/hello/version-3.0">

  <jbi:services binding-component="false">
    <jbi:consumes
        interface-name="generatedNs:Hello"
        service-name="generatedNs:HelloSrv"
        endpoint-name="HelloSrvEndpoint">

      <!-- CDK specific elements -->
      <petalsCDK:operation>sayHelloOperation</petalsCDK:operation>
      <petalsCDK:mep>InOnly</petalsCDK:mep>

      <!-- Component specific elements -->
      <quartz:cron-expression>0 15 10 * * ? 2005</quartz:cron-expression>
      <quartz:content><![CDATA[
                           <text>hello</text>
                      ]]></quartz:content>
    </jbi:consumes>
  </jbi:services>
</jbi:jbi>

A JBI descriptor for a Quartz service-unit can only define one consumes block.

Configuration of a Service Unit to create a scheduler into Petals ESB:

Service Unit content

The service unit must only contain the JBI descriptor.

The directory structure of a SU for the Petals-SE-Quartz looks like this:

su-quartz-SchedulerName-consume.zip
   + META-INF
     - jbi.xml