Skip to content

SolaceSamples/solace-samples-jms

Repository files navigation

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.

Contents

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:

Prerequisites

This tutorial requires the Solace JMS API library. There are multiple options for getting the Solace JMS API.

Option 1: Download the JMS API library

Download from here. The JMS API is distributed as a zip file containing the required jars, API documentation, and examples.

Option 2: Using it with Gradle

implementation("com.solacesystems:sol-jms:10.10.0") or implementation group: 'com.solacesystems', name: 'sol-jms', version: '10.10.0'

Option 3: Using it with Maven

<dependency>
   <groupId>com.solacesystems</groupId>
   <artifactId>sol-jms</artifactId>
   <version>10.10.0</version>
</dependency>

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

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and 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.

Resources

For more information try these resources: