README.md

Solace Spring Boot

Overview

An umbrella project containing all Solace projects for Spring Boot.

For Solace projects on Spring Cloud, please visit the Solace Spring Cloud project.

Table of Contents

• Repository Contents
• Building Locally
• Release Process
• Contributing
• Authors
• License
• Support
• Resources

---

Repository Contents

Note:

The master branch dependencies have been updated to the Spring Boot 3.x which requires JDK 17 or higher.

The master-2.x branch will act as master branch for solace-spring-boot compatible with Spring Boot 2.x.

Solace Spring Boot Bill of Materials (BOM)

The Solace Spring Boot BOM is a POM file which defines the versions of Solace Spring Boot projects that are compatible to a particular version of Spring Boot.

Please consult the Spring Boot Compatibility Table to determine which version of the BOM is compatible with your project.

Solace Spring Boot Projects

These are the projects contained within this repository:

• Solace Java Spring Boot Starter
• Solace JMS Spring Boot Starter
• Solace Spring Boot Starter

Solace Spring Boot Sample Applications

The sample applications for all Solace Spring Boot projects can be found under solace-spring-boot-samples.

Building Locally

To build the artifacts locally, simply clone this repository and run mvn package at the root of the project. This will build everything.

git clone https://github.com/SolaceProducts/solace-spring-boot.git
cd solace-spring-boot
mvn package # or mvn install to install them locally

Maven Project Structure

solace-spring-boot-build (root)
    <-> solace-spring-boot-bom
    <-> solace-spring-boot-parent
        <-> solace-spring-boot-java-starter
        <-> solace-spring-boot-jms-starter
        <-> solace-spring-boot-starter
        <-> solace-java-spring-boot-autoconfigure
        <-> solace-jms-spring-boot-autoconfigure
    --> solace-java-sample-app
    --> solace-jms-sample-app
    --> solace-jms-sample-app-jndi

Where:
    <-- indicates the parent of the project
    --> indicates a sub-module of the project

All sub-projects are included as modules of solace-spring-boot-build. Running mvn package or mvn install at the root of the project will package/install all sub-projects.

Build Projects

These projects are used to build the solace-spring-boot repository. They should not be used in your actual application.

• solace-spring-boot-build
  This POM defines build-related plugins and profiles that are inherited by the BOM as well as for each of the sub-projects.
  Please do not put non-Solace-Spring-Boot dependencies here - they belong in solace-spring-boot-parent. The exception to this is naturally the version of Spring Boot that this build targets. If it shouldn't be inherited by the BOM, it doesn't go here.
• solace-spring-boot-parent
  This POM defines common properties and dependencies for the Solace Spring Boot projects.

Release Process

1. Update Versions (Optional)

   mvn -DupdateVersion=minor # updateVersion options: major, minor, or patch

2. Update Internal Version Properties (only if 1 was done)

   mvn -DupdateProperties # Do not use this together with updateVersion. It will not work.

3. Validate Diff and Commit (only if 1 and 2 were done)
4. Release

   mvn -B release:prepare

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

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.

Support

https://solace.com/support

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 for Spring Cloud please visit these resources:

• Solace Spring Cloud

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

• The Solace Developer Portal
• Understanding Solace technology
• Ask the Solace community

.......................HELLO FROM THE OTTER SIDE...........
............................www.solace.com.................
...........................................................
...........................@@@@@@@@@@@@@@@@@@@.............
........................@@                    @@...........
.....................@      #              #     @.........
....................@       #              #      @........
.....................@          @@@@@@@@@        @.........
......................@        @@@@@@@@@@@      @..........
.....................@           @@@@@@@         @.........
.....................@              @            @.........
.....................@    \_______/   \________/ @.........
......................@         |       |        @.........
.......................@        |       |       @..........
.......................@         \_____/       @...........
....@@@@@...............@                      @...........
..@@     @...............@                     @...........
..@       @@.............@                     @...........
..@        @@............@                     @...........
..@@        @............@                     @...........
....@       @............@                      @..........
.....@@     @...........@                        @.........
.......@     @.........@                          @........
........@     @........@                           @.......
........@       @@@@@@                              @......
.........@                                            @....
.........@                                             @...
..........@@                                           @...
............@                                          @...
.............@                              @          @...
...............@                             @         @...
.................@                            @        @...
..................@                            @       @...
...................@                           @       @...
...................@                           @       @...
...................@                          @        @...
...................@                         @        @....
..................@                         @         @....
..................@                        @         @.....
..................@                       @          @.....
..................@                       @         @@.....
..................@                        @       @ @.....
..................@                          @@@@@   @.....
..................@                                  @.....
..................@                                  @.....