solace-java-spring-boot-starter

Spring Boot Auto-Configuration for the Solace Java API

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

Contents

• Overview
• Using Auto-Configuration in your App
• Resources

---

Overview

As stated this project provides a Spring Boot Auto-Configuration implementation and a Spring Boot Starter pom for the Solace Java API. The goal of this project is to make it easier to use the Solace Java API with Spring Boot auto-configuration through the @Autowired annotation.

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

One item to note as described below is that this project introduces a new factory for Solace Java API sessions: SpringJCSMPFactory. Overtime the Solace Java API may introduce a similar factory and remove the need for this custom extension. For now however, this is included in the auto-configuration jar for ease of use.

Using Auto-Configuration in your App

See the associated solace-java-sample-app for an example of how this is all put together in a simple application. You'll need to do three steps:

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

Updating your build

The releases from this project are hosted in Maven Central.

The easiest way to get started is to include the solace-java-spring-boot-starter (or solace-spring-boot-starter) in your application. For an examples see the Java 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 need to include version 3.1.0 or later to use Spring Boot release 2.x.

Using it with Gradle

// Solace Java API & auto-configuration
compile("com.solace.spring.boot:solace-java-spring-boot-starter:5.0.0")

Using it with Maven

<!-- Solace Java API & auto-configuration-->
<dependency>
	<groupId>com.solace.spring.boot</groupId>
	<artifactId>solace-java-spring-boot-starter</artifactId>
	<version>5.0.0</version>
</dependency>

Using Spring Dependency Auto-Configuration (@SpringBootApplication & @Autowired)

Now in your application code, you can simply declare the SpringJCSMPFactory and annotate it so that it is autowired:

@Autowired
private SpringJCSMPFactory solaceFactory;

Once you have the SpringJCSMPFactory, it behaves just like the JCSMPFactory and can be used to create sessions. For example:

final JCSMPSession session = solaceFactory.createSession();

The SpringJCSMPFactory is a wrapper of the singleton JCSMPFactory which contains an associated JCSMPProperties. This facilitates auto-wiring by Spring but otherwise maintains the familiar JCSMPFactory interface known to users of the Solace Java API.

Alternatively, you could autowire JCSMPProperties to create your own customized SpringJCSMPFactory:

/* The properties of a JCSMP connection */
@Autowired
private JCSMPProperties jcsmpProperties;

Configure the Application to use your Solace PubSub+ Service Credentials

The configuration of the SpringJCSMPFactory can be done through the application.properties file. This is where users can control the Solace Java API properties. Currently this project supports direct configuration of the following properties:

solace.java.host
solace.java.msgVpn
solace.java.clientUsername
solace.java.clientPassword
solace.java.clientName
solace.java.connectRetries
solace.java.reconnectRetries
solace.java.connectRetriesPerHost
solace.java.reconnectRetryWaitInMillis

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.java.host.

See SolaceJavaProperties for the most up to date list.

Any additional Solace Java API properties can be set through configuring solace.java.apiProperties.<Property> where <Property> is the name of the property as defined in the Solace Java API documentation for com.solacesystems.jcsmp.JCSMPProperties, for example:

solace.java.apiProperties.reapply_subscriptions=false
solace.java.apiProperties.ssl_trust_store=/path/to/truststore
solace.java.apiProperties.client_channel_properties.keepAliveIntervalInMillis=3000

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

Resources

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
• Understanding Solace technology.
• Ask the Solace community.