This version must be installed on Petals ESB 5.1.0+

Scheduling service invocations (Consumes mode)

Usage

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. This Petals component is based on Quarts version 2.2.2.
Below are given some sample CRON expressions and their meaning.

Table of contents

1 Scheduling service invocations (Consumes mode)

1.1 Usage
1.2 JBI Descriptor

1.2.1.1 Interceptor

1.3 Service-Unit content

2 Configuring the component

2.1.1.1 Interceptor

3 Monitoring the component

3.1 Using metrics

3.1.1 Common metrics
3.1.2 Dedicated metrics

3.2 Receiving alerts

3.2.1 Common alerts
3.2.2 Dedicated alerts

Contributors

No contributors found for: authors on selected page(s)

CRON expression	Meaning
0 0 12 * * ?	Fire at 12pm (noon) every day.
0 15 10 ? * *	Fire at 10:15am every day.
0 15 10 * * ? 2005	Fire at 10:15am every day during the year 2005.
0 * 14 * * ?	Fire every minute starting at 2pm and ending at 2:59pm, every day.
0 0/5 14 * * ?	Fire every 5 minutes starting at 2pm and ending at 2:55pm, every day.
0 0/5 14,18 * * ?	Fire every 5 minutes starting at 2pm and ending at 2:55pm, AND fire every 5 minutes starting at 6pm and ending at 6:55pm, every day.
0 0-5 14 * * ?	Fire every minute starting at 2pm and ending at 2:05pm, every day.
0 10,44 14 ? 3 WED	Fire at 2:10pm and at 2:44pm every Wednesday in the month of March.
0 15 10 ? * MON-FRI	Fire at 10:15am every Monday, Tuesday, Wednesday, Thursday and Friday.
0 15 10 15 * ?	Fire at 10:15am on the 15th day of every month.
0 15 10 L * ?	Fire at 10:15am on the last day of every month.
0 15 10 ? * 6L	Fire at 10:15am on the last Friday of every month.
0 15 10 ? * 6L	Fire at 10:15am on the last Friday of every month.
0 15 10 ? * 6L 2002-2005	Fire at 10:15am on every last friday of every month during the years 2002, 2003, 2004 and 2005.
0 15 10 ? * 6#3	Fire at 10:15am on the third Friday of every month.
0 0 12 1/5 * ?	Fire at 12pm (noon) every 5 days every month, starting on the first day of the month.

JBI Descriptor

The Quartz component is configured with a CRON expression, the identifiers of 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: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="true">
    <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 consume a service (JBI)

Parameter	Description	Default	Required
consumes	Refer JBI service to invoke into the JBI bus. You can define an explicit endpoint: interface (QName) / Service (QName) / Endpoint (String) attributes. Or define implicit endpoint, to let the container routing according to QOS configurations (HA...): -by Interface attribute (QName) -by Service attribute (QName)	-	Yes

Configuration of a Service Unit to consume a service (CDK)

Parameter	Description	Default	Required
mep	Message exchange pattern abbreviation. This parameter can be used in conjunction with the method of the CDK Listeners: `createMessageExchange(Extensions extensions)`. This method returns a CDK Exchange corresponding to the type of the specified pattern.	-	Yes
operation	Operation to call on a service. This parameter can be used in conjunction with the sending methods of the Listeners. If no operation is specified in the Message Exchange to send, this parameter will be used.	-	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

Configuration of a Service Unit to consume a service (Quartz)

Parameter	Description	Default	Required
cron-expression	A CRON expression, for example *0 30 10-13 ? WED,FRI**: trigger that fires at 10:30, 11:30, 12:30, and 13:30, on every Wednesday and Friday.	-	Yes
content	The XML message to send to the scheduled service. Must be included in a CDATA section, as shown in the sample jbi.xml above.	-	Yes

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 must only contain the JBI descriptor.

The directory structure of a SU for the Quartz component looks like this:

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

Configuring the component

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

Configuration of the component, CDK part

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

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

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.

Petals Components Wiki

All versions of Petals ESB

Helpful links

Petals-BC-Quartz 1.5.3+

Scheduling service invocations (Consumes mode)

Usage

JBI Descriptor

Interceptor

Service-Unit content

Configuring the component

Interceptor

Monitoring the component

Using metrics

Common metrics

Dedicated metrics

Receiving alerts

Common alerts

Dedicated alerts

Labels