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
- Overview
- Using Auto-Configuration in your App
- Building the Project Yourself
- Contributing
- Authors
- License
- Resources
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. Currently this project is still experimental and as such you may find that many Solace JMS properties are not yet supported. If you find Solace JMS properties that this project does not yet support, simply raise an issue and we'll look into adding this support or submit a pull request with the update.
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:
- Update your build
- Configure your
application.properties.
This 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 examples see the JMS Sample App in this project.
Here is how to include the spring boot starter in your project using Gradle and Maven.
compile("com.solace.labs.spring.boot:solace-jms-spring-boot-starter:0.1.2")
<dependency>
<groupId>com.solace.labs.spring.boot</groupId>
<artifactId>solace-jms-spring-boot-starter</artifactId>
<version>0.1.2</version>
</dependency>
Configuration of the SpringJCSMPFactory is done through the application.properties file. This is where users can control the Solace Java API properties. Currently this project supports configuration of the following properties:
solace.jms.host
solace.jms.msgVpn
solace.jms.clientUsername
solace.jms.clientPassword
solace.jms.clientName
solace.jms.directTransport
Where reasonable, sensible defaults are always chosen. So a developer using a Solace VMR and wishing to use the default message-vpn must only set the solace.jms.host.
See SolaceJmsProperties for the most up to date list. Over time the list of supported properties will continue to evolve and grow. If you're missing a particular property, you can easily submit a pull request or raise an issue and we'll add it.
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/SolaceLabs/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.
The simplest way to run the sample is from the project root folder using maven. For example:
mvn spring-boot:run
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
See the list of contributors who participated in this project.
This project is licensed under the Apache License, Version 2.0. - See the LICENSE file for details.
For more information about Spring Boot Auto-Configuration and Starters try these resources:
- Spring Docs - Spring Boot Auto-Configuration
- Spring Docs - Developing Auto-Configuration
- GitHub Tutorial - Master Spring Boot Auto-Configuration
For more information about Solace technology in general please visit these resources:
- The Solace Developer Portal website at: http://dev.solace.com
- Understanding Solace technology.
- Ask the Solace community.