Scheduling Service Invocations

Version 3 by Vincent Zurczak
on Sep 01, 2011 13:00.

<< Changes from 2 to 3

compared with

Version 4 by Vincent Zurczak
on Feb 12, 2012 19:00.

Changes from 4 to 5 >>

Key

This line was removed.

This word was removed. This word was added.

This line was added.

Changes (6)

View Page History

...

Start Petals Studio.

In the menu, select *File > New > Service-Unit Project*. Petals Service Consumer*.

If you do not see it, go into *File > New > Other...* Then, select *Service-Unit Project* *Petals Service Consumer* under the *Petals* category.

...

In the *Use Case* list, select *Miscellaneaous*.
In the *Petals Component* list, select *Quartz // petals-se-quartz*.

In the *Component Usage* list, select *Consume a Petals service (or Expose it outside the bus)*.

In the *Component Version* list, select the version of the Petals-SE-Quartz that you are using in Petals.

\\

In the scope of this tutorial, we are going to work with the version 1.12 of the Quartz component.

Which gives us:

...

This page also defines the operation to invoke and the Message Exchange Pattern (MEP).
The Message Exchange Pattern (MEP) defines the interactions between the Quartz component and the invoked service.
With this component, only operations that work with the InOnly MEP can be invoked.

\\

You can obviously fill-in these fields by hand.
However, the most efficient way is to use the [Petals Services explorer|Getting familiar with the Petals Services view] (provided it was populated).

...

Click *Select a service*. A selection dialog shows up, providing filtering assistance.

!petals-studio-tuto-consumes-quartz-2bis.jpg!

\\
When you have selected your service, click *OK*.
The wizard fields are filled-in automatically.

!petals-studio-tuto-consumes-quartz-3.jpg!

\\
{note}
The values for the interface, service and end-point names must match the values defined in the jbi.xml of the invoked service.
Indeed, this service must be a Petals service, and thus be described in a jbi.xml.
As a reminder, the jbi.xml values and the WSDL values (if the WSDL exists) of the invoked service must be exactly the same.

For this reason, filling-in the information by hand or modifying it is discouraged.
{note}

\\
Click *Next*.

h2. Defining the project name

This page defines the name and the location of the project that will be created.
Indeed, this wizard will result in the creation of a project containing all the required elements for a Quartz service-unit.

\\
Enter a project name for your project.
If you do not want your project to be created in the default workspace, uncheck *Use default location*.
Then click *Browse...* and select the location where the project will be created.

!petals-studio-tuto-consumes-quartz-4.jpg!

\\
{note}
Petals service-units have a naming convention.
For a service-unit which consumes (calls) a service, the convention is *su\-*_<Protocol or Technology>_*\-*_<Service name>_*\-consume*
{note}

\\
Then, click *Next*.

h2. Specifying the Quartz parameters

This page defines information which are specific to the Petals Quartz component.
There are only two parameters here:
* The first one is a [CRON expression|http://en.wikipedia.org/wiki/CRON_expression], which defines a time policies used to determine the invocation frequency.
* The second parameter is a static XML message that will be sent to the target service when a time policy triggers an invocation.

The meaning of these parameters can be read in the documentation of the [Petals-SE-Quartz|petalscomponents:Petals-SE-Quartz] component.

\\ !petals-studio-tuto-consumes-quartz-5.jpg!

\\
{note}
The current tooling is very basic for this component.
There is neither an editor for CRON expressions, nor generation facilities for the XML message.
{note}

{tip}
You can use SoapUI to generate a skeleton of XML message for the target service.
For this, you only need the WSDL definition of the invoked service. SoapUI will do the rest.
{tip}

{note}
The XML message must be valid with respect to the WSDL of the target service.
It must respect the XML schemas associated with the input message of the invoked operation.
{note}

Click *Next*.

h2. Specifying the CDK parameters

The CDK is the Petals framework to develop JBI components.
The Petals-SE-Quartz component was developed with this framework.

This page requires information related to the CDK.
If the service to consume is described by a WSDL, then there is a list of the possible operations that can be invoked.
Otherwise, you have three parameters to complete here (others are optional or have default values):
* The name space of the invoked operation's name (WSDL operations are QNames).
* The local part of the invoked operation's name (WSDL operations are QNames).
* The Message Exchange Pattern (MEP).

\\
With this component, only operations that work with the *InOnly* MEP can be invoked.
The wizard only shows these operations.

The meaning of all the CDK parameters for Quartz can be found in the documentation of the [Petals-SE-Quartz|petalscomponents:Petals-SE-Quartz] component.
When the invocation is created, the static XML message is sent with the given MEP, and addressed to the invoked operation of the target service (this service being identified by the triplet service, interface and end-point name).

\\ !petals-studio-tuto-consumes-quartz-6.jpg!

\\

Click *Finish* to complete the wizard.

...

h2. Checking the result

When the wizard has completed, a new project has been created and is visible in your workspace.

It contains a jbi.xml file, located under *src/main/jbi*.
This hierarchy allows you to work with Apache Maven then (a pom.xml was also created at the root of the project).
There is nothing else in the project.

\\ !petals-studio-tuto-consumes-quartz-7.jpg!

h1. Updating, packaging and deploying

h2. Further edition and packaging

After completion, the newly created jbi.xml file has been open in the Service-Unit editor.
Regarding Quartz configurations, the wizards are complete and provide all the options.
Thus, you do not need to edit the jbi.xml.

However, if you need to update it manually, be careful: the XML message must be contained in a CDATA section.
Here is a sample configuration of the Quartz component.

{code:lang=xml}
<?xml version="1.0" encoding="UTF-8"?>

<jbi:jbi version="1.0"
xmlns:generatedNs="http://petals.ow2.org/components/hl7/version-1"
xmlns:jbi="http://java.sun.com/xml/ns/jbi"
xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
xmlns:quartz="http://petals.ow2.org/components/quartz/version-1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">


<jbi:services binding-component="false">


<jbi:consumes
interface-name="generatedNs:PetalsHl7PortType"
service-name="generatedNs:PetalsHl7Service"
endpoint-name="PetalsHl7ServicePort">


<petalsCDK:timeout>30000</petalsCDK:timeout>
<petalsCDK:operation xmlns:sendInOnlyNs="http://petals.ow2.org/components/hl7/version-1">sendInOnlyNs:sendInOnly</petalsCDK:operation>
<petalsCDK:mep>InOnly</petalsCDK:mep>


<quartz:cron-expression>0 0 12 * * ? </quartz:cron-expression>
<quartz:content><![CDATA[
<text>hello</text>]]></quartz:content>
</jbi:consumes>
</jbi:services>
</jbi:jbi>
{code}

\\
The project contains everything the Quartz component needs.
You can now package it before deploying it.

\\
The created project being a [Service-Unit project|Working with Service Unit projects], you can [package it as any Service-Unit project|Working with Service Unit projects#Export for Petals].
It results in the creation of a Service Assembly for the Petals-SE-Quartz component. Its location depends on your export choices.

h2. Deployment

The deployment of the created service assembly can be achieved with the Petals web console.
Or you can do it by dropping the service assembly in the *install* directory of your Petals installation.
This second option should only be used in development steps.

\\
First, make sure the Petals-SE-Quartz is installed in your Petals environment.
Then, install the service assembly in your Petals, using one of the two ways indicated above.

\\
There is no need to update configuration of the Quartz component to make it work.
Using the default settings is enough to make the service-unit work.

Wiki

All versions of Petals Studio

Helpful links

Scheduling Service Invocations

Changes (6)