Apache ActiveMQ is an open source messaging framework. The ActiveMQ web site is not really clear on how to integrate it with the Spring framework. Therefore, I decided to write this post to explain how to use ActiveMQ in combination with Spring and clarify some points.
\nThe good news is that you can run JMS inside a servlet container (e.g. Apache Tomcat) without the need for a JCA adapter. This means you do not need Jencks or something similar.<\/p>\n
<\/p>\n
To get started, you can embed the configuration of a complete running environment in a Spring configuration file. Here is the example we’ll use for the remainder of this blog post:<\/p>\n
\n<beans xmlns="http:\/\/www.springframework.org\/schema\/beans"\n xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance"\n xmlns:amq="http:\/\/activemq.apache.org\/schema\/core"\n xmlns:jms="http:\/\/www.springframework.org\/schema\/jms"\n xsi:schemaLocation="http:\/\/www.springframework.org\/schema\/beans\u00a0http:\/\/www.springframework.org\/schema\/beans\/spring-beans.xsd\n http:\/\/www.springframework.org\/schema\/jms http:\/\/www.springframework.org\/schema\/jms\/spring-jms-2.5.xsd">\n <amq:broker brokername="test-broker" start="true">\n <amq:persistenceAdapter>\n <amq:amqPersistenceAdapter directory="\/opt\/activemq" maxFileLength="32mb"\/>\n <\/amq:persistenceAdapter>\n <amq:transportconnectors>\n <amq:transportconnector uri="tcp:\/\/localhost:7171"\/>\n <\/amq:transportconnectors>\n <\/amq:broker>\n <amq:connectionFactory id="amqConnectionFactory" brokerURL="vm:\/\/test-broker"\/>\n <bean class="org.springframework.jms.connection.CachingConnectionFactory" id="connectionFactory">\n <constructor-arg ref="amqConnectionFactory"\/>\n <property name="sessionCacheSize" value="100"\/>\n <\/bean>\n <amq:queue physicalName="testQueue" \/>\n <bean class="org.springframework.jms.core.JmsTemplate" id="jmsTemplate">\n <constructor-arg ref="connectionFactory"\/>\n <\/bean>\n <bean class="packageName.ClassName" id="queueProducer">\n <property name="jmsTemplate" ref="jmsTemplate"\/>\n <property name="queueName" value="testQueue"\/>\n <\/bean>\n <bean class="packageName.ClassName2" id="queueListener"\/>\n <jms:listener-container concurrency="10" connectionfactory="connectionFactory">\n <jms:listener destination="testQueue" ref="queueListener"\/>\n <\/jms:listener-container>\n<\/beans>\n<\/pre>\nThat’s a lot of configuration, but let’s analyze each one:<\/p>\n
\n<amq:broker brokername="test-broker" start="true">\n <amq:persistenceAdapter>\n <amq:amqPersistenceAdapter directory="\/opt\/activemq" maxFileLength="32mb"\/>\n <\/amq:persistenceAdapter>\n <amq:transportconnectors>\n <amq:transportconnector uri="tcp:\/\/localhost:7171"\/>\n <\/amq:transportconnectors>\n<\/amq:broker>\n<\/pre>\nThis is the definition for an embedded JMS broker, called
test-broker<\/code> which listens on port 7171 using the tcp protocol and which persist data using the default AMQ Message Store in the\/opt\/activemq<\/code> directory.<\/p>\n\n<amq:connectionFactory id="amqConnectionFactory" brokerURL="vm:\/\/test-broker"\/>\n<\/pre>\nThe definition of the JMS connection factory which connects to the broker using a VM transport. In this way the communication is made at the JVM level, thus avoiding network overhead.<\/p>\n
\n<amq:queue id="testQueue" physicalname="TestQueue">\n<\/pre>\nDefines the queue that we are going to use.<\/p>\n
\n<bean class="org.springframework.jms.connection.CachingConnectionFactory" id="connectionFactory">\n <constructor-arg ref="amqConnectionFactory"\/>\n <property name="sessionCacheSize" value="100"\/>\n<\/bean>\n<\/pre>\nThis is the connection factory we are really going to use in our application. It caches connections, sessions and even the
MessageProducer<\/code>. It is important to set the value of thesessionCacheSize<\/code> property since the default value is 1.<\/p>\n\n<bean class="org.springframework.jms.core.JmsTemplate" id="jmsTemplate">\n <constructor-arg ref="connectionFactory"\/>\n<\/bean>\n<\/pre>\nFor those who know the Spring support for JDBC and Hibernate, the
JmsTemplate<\/code> class should sound familiar since it has a very similar design to theJdbcTemplate<\/code> andHibernateTemplate<\/code> class.
\nIt hides most of the JMS-related low-level details (e.g. obtaining a session or handling acknowledgments). By default session are not transactional and auto-acknowledged.
\nTheconnectionFactory<\/code> is passed as a property to the constructor.
\nOne of its most important method on theJmsTemplate<\/code> issend(String destinationName, MessageCreator messageCreator)<\/code>. TheMessageCreator<\/code> is an interface defined by Spring having only thecreateMessage(Session session)<\/code> method. Its output is the JMS message that will be sent todestinationName<\/code>.<\/p>\n\n<bean class="packageName.ClassName" id="queueProducer">\n <property name="jmsTemplate" ref="jmsTemplate"><\/property>\n <property name="queueName" value="testQueue"><\/property>\n<\/bean>\n<\/pre>\nThis, finally is an object that is defined within our application, the object that produces the message queue and sends messages to it through the specified
JmsTemplate<\/code>.<\/p>\n\n<bean class="packageName.ClassName2" id="queueListener"\/>\n<\/pre>\nThe bean definition that makes up the consumer of our message queue. It needs to implement the
javax.jms.MessageListener<\/code> interface (or some Spring specific interface likeSessionAwareMessageListener<\/code>).
\nIn Spring terms it is a Message Driven Pojo, the difference with a standard Message Driven Bean is that it does not need to run in an EJB container.<\/p>\n\n<jms:listener-container concurrency="1" connection-factory="connectionFactory">\n <jms:listener destination="AggregateQueue" ref="queueListener"><\/jms:listener>\n<\/jms:listener-container>\n<\/pre>\nThis is the bean who makes the magic happen: it registers itself as a listener for all the queues and executes the callback on the listener as a message is received in an asynchronous way using a Spring
TaskExecutor<\/code>. The concurrency attribute defines how manyMessageConsumer<\/code> instances will be created for each listener. If you use a value > 1 remember to set theprefetchLimit<\/code> to 1 in order to avoid undelivered messages to the consumers.<\/p>\nHave fun \ud83d\ude42<\/p>\n","protected":false},"excerpt":{"rendered":"
Apache ActiveMQ is an open source messaging framework. The ActiveMQ web site is not really clear on how to integrate it with the Spring framework. Therefore, I decided to write this post to explain how to use ActiveMQ in combination with Spring and clarify some points. The good news is that you can run JMS […]<\/p>\n","protected":false},"author":37,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"content-type":"","footnotes":""},"categories":[10],"tags":[206,207,95],"class_list":["post-2413","post","type-post","status-publish","format-standard","hentry","category-development","tag-activemq","tag-jms","tag-spring-framework"],"acf":[],"yoast_head":"\n
Running ActiveMQ using Spring - Trifork Blog<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/trifork.nl\/blog\/running-activemq-using-spring\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Running ActiveMQ using Spring - Trifork Blog\" \/>\n<meta property=\"og:description\" content=\"Apache ActiveMQ is an open source messaging framework. The ActiveMQ web site is not really clear on how to integrate it with the Spring framework. Therefore, I decided to write this post to explain how to use ActiveMQ in combination with Spring and clarify some points. The good news is that you can run JMS […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/trifork.nl\/blog\/running-activemq-using-spring\/\" \/>\n<meta property=\"og:site_name\" content=\"Trifork Blog\" \/>\n<meta property=\"article:published_time\" content=\"2010-08-12T12:31:45+00:00\" \/>\n<meta name=\"author\" content=\"Diego Castorina\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Diego Castorina\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"5 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/trifork.nl\/blog\/running-activemq-using-spring\/\",\"url\":\"https:\/\/trifork.nl\/blog\/running-activemq-using-spring\/\",\"name\":\"Running ActiveMQ using Spring - Trifork Blog\",\"isPartOf\":{\"@id\":\"https:\/\/trifork.nl\/blog\/#website\"},\"datePublished\":\"2010-08-12T12:31:45+00:00\",\"author\":{\"@id\":\"https:\/\/trifork.nl\/blog\/#\/schema\/person\/6f4caf369ca15e0454061a3cd5652848\"},\"breadcrumb\":{\"@id\":\"https:\/\/trifork.nl\/blog\/running-activemq-using-spring\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/trifork.nl\/blog\/running-activemq-using-spring\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/trifork.nl\/blog\/running-activemq-using-spring\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/trifork.nl\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Running ActiveMQ using Spring\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/trifork.nl\/blog\/#website\",\"url\":\"https:\/\/trifork.nl\/blog\/\",\"name\":\"Trifork Blog\",\"description\":\"Keep updated on the technical solutions Trifork is working on!\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/trifork.nl\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/trifork.nl\/blog\/#\/schema\/person\/6f4caf369ca15e0454061a3cd5652848\",\"name\":\"Diego Castorina\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/trifork.nl\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/d65c89d9bcbd8b07f37035557b585077?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/d65c89d9bcbd8b07f37035557b585077?s=96&d=mm&r=g\",\"caption\":\"Diego Castorina\"},\"url\":\"https:\/\/trifork.nl\/blog\/author\/diego\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Running ActiveMQ using Spring - Trifork Blog","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/trifork.nl\/blog\/running-activemq-using-spring\/","og_locale":"en_US","og_type":"article","og_title":"Running ActiveMQ using Spring - Trifork Blog","og_description":"Apache ActiveMQ is an open source messaging framework. The ActiveMQ web site is not really clear on how to integrate it with the Spring framework. Therefore, I decided to write this post to explain how to use ActiveMQ in combination with Spring and clarify some points. The good news is that you can run JMS […]","og_url":"https:\/\/trifork.nl\/blog\/running-activemq-using-spring\/","og_site_name":"Trifork Blog","article_published_time":"2010-08-12T12:31:45+00:00","author":"Diego Castorina","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Diego Castorina","Est. reading time":"5 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/trifork.nl\/blog\/running-activemq-using-spring\/","url":"https:\/\/trifork.nl\/blog\/running-activemq-using-spring\/","name":"Running ActiveMQ using Spring - Trifork Blog","isPartOf":{"@id":"https:\/\/trifork.nl\/blog\/#website"},"datePublished":"2010-08-12T12:31:45+00:00","author":{"@id":"https:\/\/trifork.nl\/blog\/#\/schema\/person\/6f4caf369ca15e0454061a3cd5652848"},"breadcrumb":{"@id":"https:\/\/trifork.nl\/blog\/running-activemq-using-spring\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/trifork.nl\/blog\/running-activemq-using-spring\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/trifork.nl\/blog\/running-activemq-using-spring\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/trifork.nl\/blog\/"},{"@type":"ListItem","position":2,"name":"Running ActiveMQ using Spring"}]},{"@type":"WebSite","@id":"https:\/\/trifork.nl\/blog\/#website","url":"https:\/\/trifork.nl\/blog\/","name":"Trifork Blog","description":"Keep updated on the technical solutions Trifork is working on!","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/trifork.nl\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/trifork.nl\/blog\/#\/schema\/person\/6f4caf369ca15e0454061a3cd5652848","name":"Diego Castorina","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/trifork.nl\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/d65c89d9bcbd8b07f37035557b585077?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/d65c89d9bcbd8b07f37035557b585077?s=96&d=mm&r=g","caption":"Diego Castorina"},"url":"https:\/\/trifork.nl\/blog\/author\/diego\/"}]}},"_links":{"self":[{"href":"https:\/\/trifork.nl\/blog\/wp-json\/wp\/v2\/posts\/2413","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/trifork.nl\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/trifork.nl\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/trifork.nl\/blog\/wp-json\/wp\/v2\/users\/37"}],"replies":[{"embeddable":true,"href":"https:\/\/trifork.nl\/blog\/wp-json\/wp\/v2\/comments?post=2413"}],"version-history":[{"count":0,"href":"https:\/\/trifork.nl\/blog\/wp-json\/wp\/v2\/posts\/2413\/revisions"}],"wp:attachment":[{"href":"https:\/\/trifork.nl\/blog\/wp-json\/wp\/v2\/media?parent=2413"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/trifork.nl\/blog\/wp-json\/wp\/v2\/categories?post=2413"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/trifork.nl\/blog\/wp-json\/wp\/v2\/tags?post=2413"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}