Skip to content
A Spring Boot autoconfiguration and starter for Solace JMS.
Java
Branch: master
Clone or download

README.md

Build Status

Spring Boot Auto-Configuration for the Solace JMS

This project provides Spring Boot Auto-Configuration and an associated Spring Boot Started for the Solace JMS API. The goal of this project is to make it easy to use Solace JMS within a Spring application so you can take advantage of all the benefits of Spring Boot auto-configuration.

For a high level introduction and explanation, you can also refer to the following blog post: https://solace.com/blog/devops/solace-jms-meet-spring-boot-starters

Contents


Overview

As stated this project provides a Spring Boot Auto-Configuration implementation and a Spring Boot Starter pom for the Solace JMS API. The goal of this project is to make it easier to use Solace JMS within Spring.

The artifacts are published to Maven Central so it should be familiar and intuitive to use this project in your applications.

Using Auto-Configuration in your App

Spring Boot Auto-Configuration for the Solace JMS supports both programmatic creation or JNDI lookup of JMS objects. To learn more about JNDI refer to the Obtaining JMS objects using JNDI tutorial.

Programmatic creation of JMS objects

See the associated solace-jms-sample-app for an example of how this is all put together in a simple application. To use Solace JMS you need to do these steps:

  1. Update your build.
  2. Autowire the ConnectionFactory:
  3. Configure the application to use a Solace PubSub+ service.

JNDI lookup of JMS objects

See the associated solace-jms-sample-app-jndi for an example. To use JNDI with Solace JMS you need to do these steps:

  1. Update your build.
  2. Autowire the JndiTemplate for further use e.g.: in a JndiObjectFactoryBean.
  3. Configure the application to use a Solace PubSub+ service.

1. Updating your build

The releases from this project are hosted in Maven Central

The easiest way to get started is to include the solace-jms-spring-boot-starter in your application. For an example see the JMS Sample App in this project.

Here is how to include the latest spring boot starter in your project using Gradle and Maven. You can also add a specific version from Maven Central. Note that you'll neeed to include version 3.1.0 or later to use Spring Boot release 2.x.

Using it with Gradle

compile("com.solace.spring.boot:solace-jms-spring-boot-starter:3.1.0")

Using it with Maven

<dependency>
	<groupId>com.solace.spring.boot</groupId>
	<artifactId>solace-jms-spring-boot-starter</artifactId>
	<version>3.1.0</version>
</dependency>

2. Autowiring Connection Objects

To access the Solace message routing service, autowire the following connection objects in your code for JMS or JNDI:

    @Autowired
    private ConnectionFactory connectionFactory;    // for JMS
    @Autowired
    private JndiTemplate jndiTemplate;              // for JNDI

Note that if there are multiple services available, e.g. in a cloud deployment or if the application is configured by exposure of a Solace PubSub+ service manifest, one of the services will be picked automatically. You can control service selection by autowiring com.solacesystems.jms.SpringSolJmsConnectionFactoryCloudFactory or com.solacesystems.jms.SpringSolJmsJndiTemplateCloudFactory, which enable getting the list of all services and use the Factory pattern to create a connection object.

3. Configure the Application to use your Solace PubSub+ Service Credentials

Deploying your Application to a Cloud Platform

By using Spring Cloud Connectors, this library can automatically configure a ConnectionFactory and/or a JndiTemplate using the detected Solace PubSub+ services when deployed on a Cloud Platform such as Cloud Foundry.

Currently, the Solace Cloud Foundry Cloud Connector is the only connector that is supported by default in this library, but could easily be augmented by adding your own Solace Spring Cloud Connectors as dependencies to the auto-configuration's POM.

For example:

<dependency>
	<groupId>com.solace.cloud.cloudfoundry</groupId>
	<artifactId>solace-spring-cloud-connector</artifactId>
	<version>4.0.0</version>
</dependency>

Exposing a Solace PubSub+ Service Manifest in the Application's Environment

Configuration of the ConnectionFactory and/or the JndiTemplate can be done through exposing a Solace PubSub+ service manifest to the application's JVM properties or OS environment.

For example, you can set a SOLCAP_SERVICES variable in either your JVM properties or OS's environment to directly contain a VCAP_SERVICES-formatted manifest file. In which case, the autoconfigure will pick up any Solace PubSub+ services in it and use them to accordingly configure your JmsTemplate.

The properties provided by this externally-provided manifest can also be augmented using the values from the application's properties file.

For details on valid manifest formats and other ways of exposing Solace service manifests to your application, see the Manifest Load Order and Expected Formats section in the Solace Services Info project.

Updating your Application Properties

Alternatively, configuration of the JmsTemplate can also be entirely done through the application.properties file located in the src/main/resources folder. This is where users can control the Solace JMS API properties. Currently this project supports direct configuration of the following properties:

solace.jms.host
solace.jms.msgVpn
solace.jms.clientUsername
solace.jms.clientPassword
# Following properties do not apply when using JNDI, see below.
solace.jms.clientName
solace.jms.directTransport

Where reasonable, sensible defaults are always chosen. So a developer using a Solace PubSub+ message broker and wishing to use the default message-vpn may only set the solace.jms.host. When using JNDI, the configured connection factory properties on the Solace message broker are taken as a starting point, including the clientName and directTransport configurations.

See SolaceJmsProperties for the most up to date list of directly configurable properties.

Any additional supported Solace JMS API properties can be set through configuring solace.jms.apiProperties.<Property> where <Property> is the "Value" of the property in the "com.solacesystems.jms.SupportedProperty" table as defined in the Solace JMS API documentation, for example:

solace.jms.apiProperties.Solace_JMS_SSL_TrustStore=ABC

Note that the direct configuration of solace.jms. properties takes precedence over the solace.jms.apiProperties..

Building the Project Yourself

This project depends on maven for building. To build the jar locally, check out the project and build from source by doing the following:

git clone https://github.com/SolaceProducts/solace-jms-spring-boot.git
cd solace-jms-spring-boot
mvn package

This will build the auto-configuration jar and associated sample.

Note: As currently setup, the build requires Java 1.8. If you want to use another older version of Java adjust the build accordingly.

Running the Sample

The simplest way to run the sample is from the project root folder using maven. For example:

cd solace-jms-sample-app
mvn spring-boot:run

or

cd solace-jms-sample-app-jndi
mvn spring-boot:run

Note: the JMS sample will automatically provision the queue used for testing on the message broker. The JNDI sample requires manual configuration of the required settings. Refer to the comments in the application.properties file in the src/main/resources folder.

Troubleshooting tips

The sample is logging to the console by default. This can be adjusted in the log4j2.xml log file provided in the src/main/resources folder.

Solace API logging can be enabled and configured in the application.properties file located in the same folder, by adding:

# Solace logging example:
logging.level.com.solacesystems=INFO

Contributing

Please read CONTRIBUTING.md for details on the process for submitting pull requests to us.

Authors

See the list of contributors who participated in this project.

License

This project is licensed under the Apache License, Version 2.0. - See the LICENSE file for details.

Code of Conduct

Contributor Covenant Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Resources

For more information about Spring Boot Auto-Configuration and Starters try these resources:

For more information about Solace technology in general please visit these resources:

You can’t perform that action at this time.