Skip to content
Getting Started Samples for the Solace JMS API.
Branch: master
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
_docs Added new tutorial on how to use external JNDI to look up a Connectio… Apr 17, 2019
gradle/wrapper New gradlw for current gradle version (#22) Nov 24, 2017
src/main/java/com/solace/samples Added new tutorial on how to use external JNDI to look up a Connectio… Apr 17, 2019
template @ e80ba11 Pull in latest Jekyll template Feb 20, 2019
.gitmodules Project restructure (#33) Jun 25, 2018
.travis.yml Enable travis build Dec 2, 2016 Update JMS API version (#38) Aug 22, 2018
NOTICE Update notice for 2017 Feb 1, 2017
_config.yml Added new tutorial on how to use external JNDI to look up a Connectio… Apr 17, 2019
gradlew.bat New gradlw for current gradle version (#22) Nov 24, 2017
pom.xml Editorial clean up to align coding styles with new JMS tutorials Jul 26, 2017

Build Status

Getting Started Examples

Solace JMS API

The "Getting Started" tutorials will get you up to speed and sending messages with Solace technology as quickly as possible. There are three ways you can get started:

  • Follow these instructions to quickly spin up a cloud-based Solace messaging service for your applications.
  • Follow these instructions to start the Solace VMR in leading Clouds, Container Platforms or Hypervisors. The tutorials outline where to download and how to install the Solace VMR.
  • If your company has Solace message routers deployed, contact your middleware team to obtain the host name or IP address of a Solace message router to test against, a username and password to access it, and a VPN in which you can produce and consume messages.


This repository contains code and matching tutorial walk throughs for basic Solace messaging patterns. For a nice introduction to the Solace API and associated tutorials, check out the Getting Started Home Page.

See the individual tutorials for details:


This tutorial requires the Solace JMS API library. Download the JMS API library to your computer from here.

Build the Samples

Just clone and build. For example:

  1. clone this GitHub repository
  2. ./gradlew assemble

Running the Samples

To try individual samples, build the project from source and then run samples like the following:

./build/staged/bin/topicPublisher <msg_backbone_ip:port>

The individual tutorials linked above provide full details which can walk you through the samples, what they do, and how to correctly run them to explore Solace messaging.

Exploring the Samples

Setting up your preferred IDE

Using a modern Java IDE provides cool productivity features like auto-completion, on-the-fly compilation, assisted refactoring and debugging which can be useful when you're exploring the samples and even modifying the samples. Follow the steps below for your preferred IDE.

Using Eclipse

To generate Eclipse metadata (.classpath and .project files), do the following:

./gradlew eclipse

Once complete, you may then import the projects into Eclipse as usual:

File -> Import -> Existing projects into workspace

Browse to the 'solace-samples-jms' root directory. All projects should import free of errors.

Using IntelliJ IDEA

To generate IDEA metadata (.iml and .ipr files), do the following:

./gradlew idea


Please read 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 try these resources:

You can’t perform that action at this time.