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 five different basic Solace messaging patterns. For a nice introduction to the Solace API and associated tutorials, check out the tutorials home page.
See the individual tutorials for details:
- Publish/Subscribe: Learn how to set up pub/sub messaging on a Solace VMR.
- Persistence: Learn how to set up persistence for guaranteed delivery.
- Request/Reply: Learn how to set up request/reply messaging.
- Confirmed Delivery: Learn how to confirm that your messages are received by a Solace message router.
- Topic to Queue Mapping: Learn how to map existing topics to Solace queues.
This tutorial requires the Solace Java API library. Download the Java API library to your computer from here.
Just clone and build. For example:
- clone this GitHub repository
git clone https://github.com/SolaceSamples/solace-samples-java-jcsmp
cd solace-samples-java-jcsmp
- Build samples
./gradlew assemble
To try individual samples, build the project from source and then run samples like the following:
cd build/staged
bin/DirectSubscriber <host:port> <message-vpn> <client-username> [password]
bin/DirectPublisher <host:port> <message-vpn> <client-username> [password]
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.
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.
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-java-jcsmp' root directory. All projects should import free of errors.
To generate IDEA metadata (.iml and .ipr files), do the following:
./gradlew idea
The Solace JCSMP API uses Apache Commons Logging (JCL) (formerly Jarkarta Commons Logging), and is therefore compatible to use with logging frameworks like log4j2. Specifically, these samples use the Commons Logging Bridge to bridge logging data from JCL to log4j2.
You can see the required log4j2 dependencies inside the build.gradle file, and the configuration file in src/dist/config/. Log4j2 easily allows you to configure various outputs such
as console, file, and many others (e.g. JMS!) for all of the JCSMP API logs.
It is best practice to ensure whatever logging implementation you use, that it is configurable at runtime without having to recompile and redeploy.
In the included log configuration file src/dist/config/log4j2.xml there are various logging levels that can be configured using JVM system variables. For example,
use -Djcsmp_api_log_level=debug to set the API logging to debug. If using the Gradle run scripts, use the convinience environment variable JAVA_OPTS. E.g.:
export JAVA_OPTS=-Djcsmp_api_log_level=debug
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 try these resources:
- Tutorials
- The Solace Developer Portal website at: http://dev.solace.com
- Get a better understanding of Solace technology.
- Check out the Solace blog for other interesting discussions around Solace technology
- Ask the Solace community.