From 3e4bbf05cd9aa433b77a00385b49a362651b0be5 Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Thu, 18 Jun 2015 20:51:48 -0700 Subject: [PATCH] Document Apache Artemis support See gh-3154 --- .../appendix-application-properties.adoc | 14 ++++- .../main/asciidoc/spring-boot-features.adoc | 63 +++++++++++-------- .../src/main/asciidoc/using-spring-boot.adoc | 3 + 3 files changed, 53 insertions(+), 27 deletions(-) diff --git a/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc b/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc index aaebefbed2d..0fae679d168 100644 --- a/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc +++ b/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc @@ -484,7 +484,19 @@ content into your application; rather pick only the properties that you need. spring.activemq.in-memory=true # broker kind to create if no broker-url is specified spring.activemq.pooled=false - # HornetQ ({sc-spring-boot-autoconfigure}/jms/hornetq/HornetQProperties.{sc-ext}[HornetQProperties]) + # ARTEMIS ({sc-spring-boot-autoconfigure}/jms/artemis/ArtemisProperties.{sc-ext}[ArtemisProperties]) + spring.artemis.mode= # connection mode (native, embedded) + spring.artemis.host=localhost # hornetQ host (native mode) + spring.artemis.port=5445 # hornetQ port (native mode) + spring.artemis.embedded.enabled=true # if the embedded server is enabled (needs hornetq-jms-server.jar) + spring.artemis.embedded.server-id= # auto-generated id of the embedded server (integer) + spring.artemis.embedded.persistent=false # message persistence + spring.artemis.embedded.data-directory= # location of data content (when persistence is enabled) + spring.artemis.embedded.queues= # comma-separated queues to create on startup + spring.artemis.embedded.topics= # comma-separated topics to create on startup + spring.artemis.embedded.cluster-password= # customer password (randomly generated by default) + + # HORNETQ ({sc-spring-boot-autoconfigure}/jms/hornetq/HornetQProperties.{sc-ext}[HornetQProperties]) spring.hornetq.mode= # connection mode (native, embedded) spring.hornetq.host=localhost # hornetQ host (native mode) spring.hornetq.port=5445 # hornetQ port (native mode) diff --git a/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc b/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc index 7abe2979ce8..5461bdbd138 100644 --- a/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc +++ b/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc @@ -2515,6 +2515,43 @@ to send and receive messages. +[[boot-features-activemq]] +==== ActiveMQ support +Spring Boot can also configure a `ConnectionFactory` when it detects that ActiveMQ is +available on the classpath. If the broker is present, an embedded broker is started and +configured automatically (as long as no broker URL is specified through configuration). + +ActiveMQ configuration is controlled by external configuration properties in +`+spring.activemq.*+`. For example, you might declare the following section in +`application.properties`: + +[source,properties,indent=0] +---- + spring.activemq.broker-url=tcp://192.168.1.210:9876 + spring.activemq.user=admin + spring.activemq.password=secret +---- + +See +{sc-spring-boot-autoconfigure}/jms/activemq/ActiveMQProperties.{sc-ext}[`ActiveMQProperties`] +for more of the supported options. + +By default, ActiveMQ creates a destination if it does not exist yet, so destinations are +resolved against their provided names. + + + +[[boot-features-artemis]] +==== Artemis support +Apache Artemis was formed in 2015 when HornetQ was donated to the Apache Foundation. All +the features listed in the <> section below can be applied to +Artemis. Simply replace `+++spring.hornetq.*+++` properties with `+++spring.artemis.*+++` +and use `spring-boot-starter-artemis` instead of `spring-boot-starter-hornetq`. + +NOTE: You should not try and use Artemis and HornetQ and the same time. + + + [[boot-features-hornetq]] ==== HornetQ support Spring Boot can auto-configure a `ConnectionFactory` when it detects that HornetQ is @@ -2559,32 +2596,6 @@ through configuration. -[[boot-features-activemq]] -==== ActiveMQ support -Spring Boot can also configure a `ConnectionFactory` when it detects that ActiveMQ is -available on the classpath. If the broker is present, an embedded broker is started and -configured automatically (as long as no broker URL is specified through configuration). - -ActiveMQ configuration is controlled by external configuration properties in -`+spring.activemq.*+`. For example, you might declare the following section in -`application.properties`: - -[source,properties,indent=0] ----- - spring.activemq.broker-url=tcp://192.168.1.210:9876 - spring.activemq.user=admin - spring.activemq.password=secret ----- - -See -{sc-spring-boot-autoconfigure}/jms/activemq/ActiveMQProperties.{sc-ext}[`ActiveMQProperties`] -for more of the supported options. - -By default, ActiveMQ creates a destination if it does not exist yet, so destinations are -resolved against their provided names. - - - [[boot-features-jms-jndi]] ==== Using a JNDI ConnectionFactory If you are running your application in an Application Server Spring Boot will attempt to diff --git a/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc b/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc index 5dcc8ba3ee4..362bae95f12 100644 --- a/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc +++ b/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc @@ -264,6 +264,9 @@ The following application starters are provided by Spring Boot under the |`spring-boot-starter-aop` |Support for aspect-oriented programming including `spring-aop` and AspectJ. +|`spring-boot-starter-artemis` +|Support for "`Java Message Service API`" via Apache Artemis. + |`spring-boot-starter-batch` |Support for "`Spring Batch`" including HSQLDB database.