JBoss.orgCommunity Documentation
The HornetQ distribution comes with over 70 run out-of-the-box examples demonstrating many of the features.
The examples are available in the distribution, in the examples
directory. Examples are split into JMS and core examples. JMS examples show how a particular
feature can be used by a normal JMS client. Core examples show how the equivalent feature
can be used by a core messaging client.
A set of Java EE examples are also provided which need the JBoss Application Server installed to be able to run.
To run a JMS example, simply cd into the appropriate example
directory and type ./build.sh (or build.bat if you
are on Windows).
Here's a listing of the examples with a brief description.
HornetQ also supports Application-Layer failover, useful in the case that replication is not enabled on the server side.
With Application-Layer failover, it's up to the application to register a JMS
ExceptionListener with HornetQ which will be called by
HornetQ in the event that connection failure is detected.
The code in the ExceptionListener then recreates the JMS
connection, session, etc on another node and the application can continue.
Application-layer failover is an alternative approach to High Availability (HA). Application-layer failover differs from automatic failover in that some client side coding is required in order to implement this. Also, with Application-layer failover, since the old session object dies and a new one is created, any uncommitted work in the old session will be lost, and any unacknowledged messages might be redelivered.
The bridge example demonstrates a core bridge deployed on one
server, which consumes messages from a local queue and forwards them to an address
on a second server.
Core bridges are used to create message flows between any two HornetQ servers which are remotely separated. Core bridges are resilient and will cope with temporary connection failure allowing them to be an ideal choice for forwarding over unreliable connections, e.g. a WAN.
The browser example shows you how to use a JMS QueueBrowser with HornetQ.
Queues are a standard part of JMS, please consult the JMS 1.1 specification for full details.
A QueueBrowser is used to look at messages on the queue
without removing them. It can scan the entire content of a queue or only messages
matching a message selector.
The client-kickoff example shows how to terminate client
connections given an IP address using the JMX management API.
The client-side-failoverlistener example shows how to register a listener to monitor
failover events
The client-side-load-balancing example demonstrates how
sessions created from a single JMS Connection can
be created to different nodes of the cluster. In other words it demonstrates how
HornetQ does client-side load-balancing of sessions across the cluster.
This example demonstrates a clustered JMS durable subscription
This is similar to the message grouping example except that it demonstrates it working over a cluster. Messages sent to different nodes with the same group id will be sent to the same node and the same consumer.
The clustered-queue example demonstrates a JMS queue deployed
on two different nodes. The two nodes are configured to form a cluster. We then
create a consumer for the queue on each node, and we create a producer on only one
of the nodes. We then send some messages via the producer, and we verify that both
consumers receive the sent messages in a round-robin fashion.
The clustered-jgroups example demonstrates how to form a two
node cluster using JGroups as its underlying topology discovery technique, rather than
the default UDP broadcasting. We then create a consumer for the queue on each node,
and we create a producer on only one of the nodes. We then send some messages via the
producer, and we verify that both consumers receive the sent messages in a round-robin fashion.
The clustered-standalone example demonstrates how to configure
and starts 3 cluster nodes on the same machine to form a cluster. A subscriber for a
JMS topic is created on each node, and we create a producer on only one of the
nodes. We then send some messages via the producer, and we verify that the 3
subscribers receive all the sent messages.
This example demonstrates how to configure a cluster using a list of connectors rather than UDP for discovery
This example demonstrates how to set up a cluster where cluster connections are one way, i.e. server A -> Server B -> Server C
The clustered-topic example demonstrates a JMS topic deployed
on two different nodes. The two nodes are configured to form a cluster. We then
create a subscriber on the topic on each node, and we create a producer on only one
of the nodes. We then send some messages via the producer, and we verify that both
subscribers receive all the sent messages.
With HornetQ you can specify a maximum consume rate at which a JMS MessageConsumer will consume messages. This can be specified when creating or deploying the connection factory.
If this value is specified then HornetQ will ensure that messages are never consumed at a rate higher than the specified rate. This is a form of consumer throttling.
The dead-letter example shows you how to define and deal with
dead letter messages. Messages can be delivered unsuccessfully (e.g. if the
transacted session used to consume them is rolled back).
Such a message goes back to the JMS destination ready to be redelivered. However, this means it is possible for a message to be delivered again and again without any success and remain in the destination, clogging the system.
To prevent this, messaging systems define dead letter messages: after a specified unsuccessful delivery attempts, the message is removed from the destination and put instead in a dead letter destination where they can be consumed for further investigation.
The delayed-redelivery example demonstrates how HornetQ can be
configured to provide a delayed redelivery in the case a message needs to be
redelivered.
Delaying redelivery can often be useful in the case that clients regularly fail or roll-back. Without a delayed redelivery, the system can get into a "thrashing" state, with delivery being attempted, the client rolling back, and delivery being re-attempted in quick succession, using up valuable CPU and network resources.
HornetQ diverts allow messages to be transparently "diverted" or copied from one address to another with just some simple configuration defined on the server side.
The durable-subscription example shows you how to use a durable
subscription with HornetQ. Durable subscriptions are a standard part of JMS, please
consult the JMS 1.1 specification for full details.
Unlike non-durable subscriptions, the key function of durable subscriptions is that the messages contained in them persist longer than the lifetime of the subscriber - i.e. they will accumulate messages sent to the topic even if there is no active subscriber on them. They will also survive server restarts or crashes. Note that for the messages to be persisted, the messages sent to them must be marked as durable messages.
The embedded example shows how to embed JMS
within your own code using POJO instantiation and no config files.
The embedded example shows how to embed JMS within your own code using regular HornetQ XML files.
The expiry example shows you how to define and deal with
message expiration. Messages can be retained in the messaging system for a limited
period of time before being removed. JMS specification states that clients should
not receive messages that have been expired (but it does not guarantee this will not
happen).
HornetQ can assign an expiry address to a given queue so that when messages are expired, they are removed from the queue and sent to the expiry address. These "expired" messages can later be consumed from the expiry address for further inspection.
This examples shows how to build the hornetq resource adapteras a rar for deployment in other Application Server's
The http-transport example shows you how to configure HornetQ
to use the HTTP protocol as its transport layer.
Usually, JMS Objects such as ConnectionFactory, Queue and Topic instances are looked up from JNDI
before being used by the client code. This objects are called "administered objects"
in JMS terminology.
However, in some cases a JNDI server may not be available or desired. To come to the rescue HornetQ also supports the direct instantiation of these administered objects on the client side so you don't have to use JNDI for JMS.
HornetQ allows an application to use an interceptor to hook into the messaging system. Interceptors allow you to handle various message events in HornetQ.
The jaas example shows you how to configure HornetQ to use JAAS
for security. HornetQ can leverage JAAS to delegate user authentication and
authorization to existing security infrastructure.
The jms-brige example shows how to setup a bridge
between two standalone HornetQ servers.
The large-message example shows you how to send and receive
very large messages with HornetQ. HornetQ supports the sending and receiving of huge
messages, much larger than can fit in available RAM on the client or server.
Effectively the only limit to message size is the amount of disk space you have on
the server.
Large messages are persisted on the server so they can survive a server restart. In other words HornetQ doesn't just do a simple socket stream from the sender to the consumer.
The last-value-queue example shows you how to define and deal
with last-value queues. Last-value queues are special queues which discard any
messages when a newer message with the same value for a well-defined last-value
property is put in the queue. In other words, a last-value queue only retains the
last value.
A typical example for last-value queue is for stock prices, where you are only interested by the latest price for a particular stock.
The management example shows how to manage HornetQ using JMS
Messages to invoke management operations on the server.
The management-notification example shows how to receive
management notifications from HornetQ using JMS messages. HornetQ servers emit
management notifications when events of interest occur (consumers are created or
closed, addresses are created or deleted, security authentication fails,
etc.).
The message-counters example shows you how to use message
counters to obtain message information for a JMS queue.
The message-group example shows you how to configure and use
message groups with HornetQ. Message groups allow you to pin messages so they are
only consumed by a single consumer. Message groups are sets of messages that has the
following characteristics:
Messages in a message group share the same group id, i.e. they have same JMSXGroupID string property values
The consumer that receives the first message of a group will receive all the messages that belongs to the group
The message-group2 example shows you how to configure and use
message groups with HornetQ via a connection factory.
Message Priority can be used to influence the delivery order for messages.
It can be retrieved by the message's standard header field 'JMSPriority' as defined in JMS specification version 1.1.
The value is of type integer, ranging from 0 (the lowest) to 9 (the highest). When messages are being delivered, their priorities will effect their order of delivery. Messages of higher priorities will likely be delivered before those of lower priorities.
Messages of equal priorities are delivered in the natural order of their arrival at their destinations. Please consult the JMS 1.1 specification for full details.
This example demonstrates how to set up a live server with multiple backups
This example demonstrates how to set up a live server with multiple backups but forcing failover back to the original live server
By default, HornetQ consumers buffer messages from the server in a client side
buffer before you actually receive them on the client side. This improves
performance since otherwise every time you called receive() or had processed the
last message in a MessageListener onMessage() method, the HornetQ
client would have to go the server to request the next message, which would then get
sent to the client side, if one was available.
This would involve a network round trip for every message and reduce performance. Therefore, by default, HornetQ pre-fetches messages into a buffer on each consumer.
In some case buffering is not desirable, and HornetQ allows it to be switched off. This example demonstrates that.
The non-transaction-failover example demonstrates two servers coupled
as a live-backup pair for high availability (HA), and a client using a non-transacted
JMS session failing over from live to backup when the live server is
crashed.
HornetQ implements failover of client connections between live and backup servers. This is implemented by the replication of state between live and backup nodes. When replication is configured and a live node crashes, the client connections can carry and continue to send and consume messages. When non-transacted sessions are used, once and only once message delivery is not guaranteed and it is possible that some messages will be lost or delivered twice.
The paging example shows how HornetQ can support huge queues
even when the server is running in limited RAM. It does this by transparently
paging messages to disk, and depaging
them when they are required.
Standard JMS supports three acknowledgement modes:
AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, and DUPS_OK_ACKNOWLEDGE. For a full description on these modes please
consult the JMS specification, or any JMS tutorial.
All of these standard modes involve sending acknowledgements from the client to the server. However in some cases, you really don't mind losing messages in event of failure, so it would make sense to acknowledge the message on the server before delivering it to the client. This example demonstrates how HornetQ allows this with an extra acknowledgement mode.
The producer-rte-limit example demonstrates how, with HornetQ,
you can specify a maximum send rate at which a JMS message producer will send
messages.
The queue-message-redistribution example demonstrates message
redistribution between queues with the same name deployed in different nodes of a
cluster.
The queue-selector example shows you how to selectively consume
messages using message selectors with queue consumers.
The Reattach Node example shows how a client can try to reconnect to
the same server instead of failing the connection immediately and
notifying any user ExceptionListener objects. HornetQ can be configured to automatically
retry the connection, and reattach to the server when it becomes available again across
the network.
An example showing how failback works when using replication, In this example a live server will replicate all its Journal to a backup server as it updates it. When the live server crashes the backup takes over from the live server and the client reconnects and carries on from where it left off.
An example showing how failback works when using replication, but this time with static connectors
An example showing how to configure multiple backups when using replication
An example showing how failover works with a transaction when using replication
The scheduled-message example shows you how to send a scheduled
message to a JMS Queue with HornetQ. Scheduled messages won't get delivered until a
specified time in the future.
The security example shows you how configure and use role based
queue security with HornetQ.
The send-acknowledgements example shows you how to use
HornetQ's advanced asynchronous send acknowledgements feature
to obtain acknowledgement from the server that sends have been received and
processed in a separate stream to the sent messages.
This example shows how to use embedded JMS using HornetQ's Spring integration.
The ssl-enabled shows you how to configure SSL with HornetQ to
send and receive message.
The static-selector example shows you how to configure a
HornetQ core queue with static message selectors (filters).
The static-selector-jms example shows you how to configure a
HornetQ queue with static message selectors (filters) using JMS.
The stomp example shows you how to configure a
HornetQ server to send and receive Stomp messages.
The stomp example shows you how to configure a
HornetQ server to send and receive Stomp messages via a Stomp 1.1 connection.
The stomp-websockets example shows you how to configure a
HornetQ server to send and receive Stomp messages directly from Web browsers (provided
they support Web Sockets).
The symmetric-cluster example demonstrates a symmetric cluster
set-up with HornetQ.
HornetQ has extremely flexible clustering which allows you to set-up servers in many different topologies. The most common topology that you'll perhaps be familiar with if you are used to application server clustering is a symmetric cluster.
With a symmetric cluster, the cluster is homogeneous, i.e. each node is configured the same as every other node, and every node is connected to every other node in the cluster.
HornetQ supports topic hierarchies. With a topic hierarchy you can register a subscriber with a wild-card and that subscriber will receive any messages sent to an address that matches the wild card.
The topic-selector-example1 example shows you how to send
message to a JMS Topic, and subscribe them using selectors with HornetQ.
The topic-selector-example2 example shows you how to
selectively consume messages using message selectors with topic consumers.
The transaction-failover example demonstrates two servers coupled
as a live-backup pair for high availability (HA), and a client using a transacted JMS
session failing over from live to backup when the live server is
crashed.
HornetQ implements failover of client connections between live and backup servers. This is implemented by the sharing of a journal between the servers. When a live node crashes, the client connections can carry and continue to send and consume messages. When transacted sessions are used, once and only once message delivery is guaranteed.
The transactional example shows you how to use a transactional
Session with HornetQ.
The xa-heuristic example shows you how to make an XA heuristic
decision through HornetQ Management Interface. A heuristic decision is a unilateral
decision to commit or rollback an XA transaction branch after it has been
prepared.
The xa-receive example shows you how message receiving behaves
in an XA transaction in HornetQ.
The xa-send example shows you how message sending behaves in an
XA transaction in HornetQ.
To run a core example, simply cd into the appropriate example
directory and type ant
Most of the Java EE examples can be run the following way. simply cd into the
appropriate example directory and type mvn test. This will use Arquillian to run the Application
Server and deploy the application. Note that you must have jboss AS 7 installed and the JBOSS_HOME environment
variable set. Please refer to the examples documentation for further instructions.
An example that shows using an EJB and JMS together within a transaction.
This example demonstrates how to configure several properties on the HornetQ JCA resource adaptor.
This example demonstrates how to configure the HornetQ resource adapter to talk to a remote HornetQ server
A simple set of examples of message driven beans, including failover examples.