Overview of the ServiceMix 2.x Quartz Example
This document describes how to run the Qaurtz example and provides details about what it does. For information on the business use case, please refer to: Use Case for Quartz.
The Quartz example illustrates the following:
- use of declarative programming
- how to use a Quartz timer
- how to use tracing
The source code for the Quartz example is located in the ServiceMix installation directory under the examples\quartz-binding
directory in the servicemix.xml
file. It is recommended that you refer to the source code while reading this document.
This example shows how to use a Quartz component to set off a trigger that sends messages to a trace component. The trace component logs the messages to the console as they arrive
Running the Quartz Example
From a command shell, go to the Quartz example directory:
cd [servicemix_install_dir]\examples\quartz-binding
Then type:
[servicemix_install_dir]\bin\servicemix servicemix.xml
where servicemix_install_dir
is the directory in which ServiceMix was installed.
Stopping the Quartz Example
To terminate the Quartz example type "CTRL-C" in the command shell in which it is running and answer "y" to the "Terminate batch job (y/n)?" question.
How it Works
The diagram below illustrates the flow of messages through the Quartz components.
Messages flow through the components as follows:
- Every 5 seconds the timer component sends a message to trace through the Normalized Message Router (NMR).
- trace transforms the normalized message into a string and logs it to the console.
[INFO] TraceComponent - -Exchange: org.servicemix.jbi.messaging.InOnlyImpl@4fdf11 received IN message: org.servicemix.jbi.messaging.NormalizedMessageImpl@1be0369{properties: {org.servicemix.jms.message=ACTIVEMQ_TEXT_MESSAGE: id = 0 ActiveMQMessage{ , jmsMessageID = null, bodyAsBytes = org.activemq.io.util.ByteArray@1d1fc02, readOnlyMessage = true, jmsClientID = 'ID:Lisas-2828-1126207917359-23:0' , jmsCorrelationID = 'null' , jmsDestination = demo.org.servicemix.result, jmsReplyTo = null, jmsDeliveryMode = 2, jmsRedelivered = false, jmsType = 'null' , jmsExpiration = 0, jmsPriority = 4, jmsTime stamp = 1126207938593, properties = {}, readOnlyProperties = true, entryBrokerName = 'ID:Lisas-2828-1126207917359-0:0' , entryClusterName = 'default' , consumerNos = [0], transactionId = 'null' , xaTransacted = false, consumerIdentifer = 'ID:Lisas-2828-1126207917359-14:0' , messageConsumed = false, transientConsumed = true, sequenceNumber = 7, deliveryCount = 1, dispatchedFromDLQ = false, messageAcknowledge = org.activemq.ActiveMQSession@1de7497, jmsMessageIdentity = null, producerKey = ID:Lisas-2828-1126207917359-29: }, text = <?xml version="1.0" encoding="UTF-8"?> <timer><name>My Example Job</name><group>ServiceMix</group><fullname>ServiceMix.My Example Job</fullname><description/><fireTime> Thu Sep 08 12:32:18 PDT 2005</fireTime></timer>}}
Details
The following table provides more details about the function of each component and bean in the servicemix.xml file.
Component or Bean ID |
Description |
---|---|
timer |
The timer component shows the use of the QuartzComponent class. Every 5 seconds, until the program is terminated, the timer component kicks off an instance of a SimpleTrigger, which is associated with an instance of JobDetail. The job has a property called "name" with a value of "My Example Job" and another property called "group" with a value of "ServiceMix." The resulting message is converted to a normalized message and routed through the NMR. |
trace |
Receives normalized messages via the NMR. It transforms the normalized message into a string and logs it to the console. |
Issues
The ServiceMix 2.0.2 distribution has a known logging bug, so output is not logged to the console. This can be corrected in the source distribution of ServiceMix 2.0.2, by replacing the jencks-all-1.1.1.jar with the jencks-all-1.1.2.jar file. Upgrading to 2.0.3 will also resolve the problem. 2.0.3 release is a developer's release at this time. Please see Download for the latest developer's release.
This procedure explains the work around for 2.0.2.
- Download the jencks-all-1.2.jar here.
Copy the jar file to [servicemix_src_install_dir]\assembly\target\servicemix-2.0.2\bin\servicemix-2.0.2\lib, where [servicemix_src_install_dir] is the directory in which the ServiceMix distribution is located.
- Delete jencks-all-1.1.1.jar from that directory.
Place a copy of the jar file in the ServiceMix web directory at [servicemix_src_install_dir]\servicemix-2.0.2\tooling\servicemix-web\target\servicemix-web\WEB-INF as well.
- To run the example in the source distribution:
cd [servicemix_src_install_dir]\assembly\target\servicemix-2.0.2\bin\servicemix-2.0.2\bin ..\..\bin\servicemix servicemix.xml
Note: It is not necessary to build the source distribution if you have previously done so. If ServiceMix has not been built, execute the above steps before building. The procedure on how to build the source distribution can be found here.
Related Documentation
For more information on the following topics please see:
For a brief explanation of the XML tags in the servicemix.xml
file, please see: