Spring Cloud Auto-Config JMS

Overview

This tutorial is part of a series of tutorials which aims to introduce users to Solace Messaging in Pivotal Cloud Foundry. Solace Messaging in Pivotal Cloud Foundry is delivered as a Tile on the Pivotal Network. You can see the Solace Messaging for Pivotal Cloud Foundry Documentation for full details.

This tutorial is similar to the Spring Cloud Auto-Config Java tutorial. Like the Spring Cloud Auto-Config Java tutorial, it will introduce you to Solace Messaging for Pivotal Cloud Foundry. In contrast to the Spring Cloud Auto-Config Java, this application uses the Solace JMS API and solace-jms-spring-boot which in turn is using the Java CFEnv library and Spring Auto Configuration can auto inject a standard JMS ConnectionFactory directly into your application.

Goals

The goal of this tutorial is to demonstrate auto injecting a JMS ConnectionFactory based on the application's Cloud Foundry Service Bindings and connect to the Solace Messaging service instance. This tutorial will show you:

1. How to Autowire a JMS ConnectionFactory into your application
2. How to Autowire the SolaceServiceCredentials provided by the Cloud Foundry environment using Java CFEnv.
3. How to Autowire SpringSolJmsConnectionFactoryCloudFactory which you can use to access other Cloud Available Solace Messaging Instances and create other Solace implementations of the JMS ConnectionFactory.
4. How to establish a connection to the Solace Messaging service.
5. How to publish, subscribe and receive messages.

Assumptions

This tutorial assumes the following:

• You are familiar with Solace core concepts.
• You are familiar with Spring RESTful Web Services.
• You are familiar with Cloud Foundry.
• You have access to a running Pivotal Cloud Foundry environment.
• Solace Messaging for PCF has been installed in your Pivotal Cloud Foundry environment.

Obtaining the Solace API

This tutorial depends on you having the Solace Messaging API for JMS. Here are a few easy ways to get the JMS API. The instructions in the Building section assume you're using Gradle and pulling the jars from maven central. If your environment differs then adjust the build instructions appropriately.

Get the API: Using Gradle

compile("com.solacesystems:sol-jms:${solaceJMSVersion}")

Get the API: Using Maven

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

Get the API: Using the Solace Developer Portal

The JMS API library can be downloaded here. The JMS API is distributed as a zip file containing the required jars, API documentation, and examples.

Code Walk Through

This section will explain what the code in the samples does.

Structure

The sample application contains the following source files :

This tutorial will only cover the source code in SolaceController.java, and ProducerConfiguration.java and the necessary project dependencies as the other files do not contain logic related to establishing a connection to the Solace Messaging Service.

Obtaining the Solace Credentials in the Application

The Pivotal Cloud Foundry environment exposes any bound Service Instances in a JSON document stored in the VCAP_SERVICES environment variable. Here is an example of a VCAP_SERVICES with all the fields of interest to us:

{
  "VCAP_SERVICES": {
    "solace-pubsub": [ {
        "name": "solace-pubsub-sample-instance",
        "label": "solace-pubsub",
        "plan": "enterprise-shared",
        "tags": [
            (...)
            ],
        "credentials": {
          "clientUsername": "v005.cu000001",
          "clientPassword": "bb90fcb0-6c83-4a10-bafa-3ec225bbfc08",
          "msgVpnName": "v005",
            (...)
          "smfHosts": [ "tcp://192.168.132.14:7000" ],
            (...)
        }
      }
    }
  ]
}

You can see the full structure of the Solace Messaging VCAP_SERVICES in the Solace Messaging for PCF documentation.

This sample uses the solace-jms-spring-boot which can auto detect and auto wire the available Solace Messaging Services from the Cloud Foundry environment into your application.

Spring provided @Autowire is used to access all auto configuration available beans which include an auto selected Factory.

// A JMS ConnectionFactory for the auto selected Solace Messaging service,
// This is the only required bean to run this application.
// Note that both SolaceController and ProducerConfiguration use this for
// their respective purposes but the same connection factory is provided.
@Autowired
private ConnectionFactory connectionFactory;

// The auto selected Solace Messaging service for the matching ConnectionFactory,
// the relevant information provided by this bean have already been injected
// into the ConnectionFactory.
// This bean is for information only, it can be used to discover more about
// the solace service in use.
@Autowired
SolaceServiceCredentials solaceServiceCredentials;

// A Factory of Factories
// Has the ability to create ConnectionFactory(s) for any available
// SolaceServiceCredentials.
// Can be used in case there are multiple Solace Messaging Services to
// select from.
@Autowired
SpringSolJmsConnectionFactoryCloudFactory springJCSMPFactoryCloudFactory;

The init() method retrieves and shows the autowired Solace Messaging Service Instance details as follows:

logger.info(String.format("SpringSolJmsConnectionFactoryCloudFactory discovered %s solace-pubsub service(s)",
        springJCSMPFactoryCloudFactory.getSolaceServiceCredentials().size()));

// Log what Solace Messaging Services were discovered
for (SolaceServiceCredentials discoveredSolaceMessagingService : springJCSMPFactoryCloudFactory
        .getSolaceServiceCredentials()) {
    logger.info(String.format(
            "Discovered Solace Messaging service '%s': HighAvailability? ( %s ), Message VPN ( %s )",
            discoveredSolaceMessagingService.getId(), discoveredSolaceMessagingService.isHA(),
            discoveredSolaceMessagingService.getMsgVpnName()));
}

Use of Spring JMS in the sample

This Spring Cloud Auto-Config JMS sample app is making use of Spring JMS for messaging. To learn more about Spring JMS, refer to the Spring JMS Integration documentation.

Creating the Message Producer and Consumer

The ConnectionFactory connectionFactory has been already autowired, which is the Solace implementation of the standard JMS ConnectionFactory interface, instantiated to access the Solace Messaging service.

The following code is used for a simple message producer:

In ProducerConfiguration.java:

@Configuration
public class ProducerConfiguration {

	@Autowired
	private ConnectionFactory connectionFactory;

	// Example configuration of JmsTemplate
	@Bean
	public JmsTemplate jmsTemplate() {
		CachingConnectionFactory ccf = new CachingConnectionFactory(connectionFactory);
		JmsTemplate jmst = new JmsTemplate(ccf);
		jmst.setPubSubDomain(true);	// This sample is publishing to topics
		return jmst;
	}
}

In SolaceController.java we autowire above JmsTemplate and use it:

@Autowired
private JmsTemplate jmsTemplate;

...

this.jmsTemplate.convertAndSend(message.getTopic(), message.getBody());

For the Consumer side, the following code in SolaceController.java will create a simple message consumer that will log any incoming messages and errors:

@Autowired
private ConnectionFactory connectionFactory;

public class SimpleMessageListener implements MessageListener {
    @Override
    public void onMessage(Message message) {

        numMessagesReceived.incrementAndGet();

        if (message instanceof TextMessage) {
            lastReceivedMessage = (TextMessage) message;
            try {
                logger.info("Received message : " + lastReceivedMessage.getText());
            } catch (JMSException e) {
                logger.error("Error getting text of the received TextMessage: " + e);
            }
        } else {
            logger.error("Received message that was not a TextMessage: " + message);
        }
    }
}

// Create a listener explicitly, runtime
public DefaultMessageListenerContainer createListener(String destination) {
    // do something here to create a message listener container
    DefaultMessageListenerContainer lc = new DefaultMessageListenerContainer();
    lc.setConnectionFactory(connectionFactory);
    lc.setDestinationName(destination);
    lc.setMessageListener(new SimpleMessageListener());
    lc.setPubSubDomain(true);
    lc.initialize();
    return lc;
}

...

DefaultMessageListenerContainer listenercontainer = createListener(subscriptionTopic);
listenercontainer.start();

Publishing, Subscribing and Receiving Messages

The consumer created in the previous step will only receive messages matching topics that the Solace session subscribed to. It is thus necessary to create subscriptions in order to receive messages. You can add a topic subscription by sending a POST to the /subscription REST endpoint. The payload of the POST is a simple JSON structure containing the topic subscription. For example: {"subscription": "test"}. Here is the method signature:

@RequestMapping(value = "/subscription", method = RequestMethod.POST)
public ResponseEntity<String> addSubscription(@RequestBody SimpleSubscription subscription) {
    // ...
}

You can send a message by sending a POST to the /message REST endpoint. The payload of the POST is a simple JSON structure containing the topic for publishing and the message contents. For example: {"topic": "test", "body": "Test Message"}. Here is the method signature:

@RequestMapping(value = "/message", method = RequestMethod.POST)
public ResponseEntity<String> sendMessage(@RequestBody SimpleMessage message) {
   // ...
}

Receiving messages is done at the backend via the SimpleMessageListener listener described above. This sample stores the last message received. To access ths received message you can send a GET request to /message endpoint. The same JSON structure of a message will be returned in the payload of the GET.

@RequestMapping(value = "/message", method = RequestMethod.GET)
public ResponseEntity<SimpleMessage> getLastMessageReceived() {
    // ...
}

The subscription JSON document used by the /subscription endpoint is modeled by the SimpleSubscription class, whereas the /message endpoint JSON document is modeled by the SimpleMessage class.

For more details on sending and receiving messages, you can checkout the JCSMP Publish/Subscribe tutorial.

Building

The full source code for this example is available in GitHub. To build, just clone and use gradle. Here is an example:

git clone https://github.com/SolaceSamples/solace-samples-cloudfoundry-java
cd solace-samples-cloudfoundry-java
./gradlew build

git clone //github.com/SolaceSamples/solace-samples-cloudfoundry-java cd https:solace.comsamplessolace-samples-cloudfoundry-java ./gradlew build

Cloud Foundry Setup

The sample application specifies a dependency on a service instance named solace-pubsub-sample-instance in its manifiest (See spring-cloud-autoconf/manifest.yml). This must be an instance of the Solace Messaging Service which can be created with this command:

cf create-service solace-pubsub enterprise-shared solace-pubsub-sample-instance

Deploying

To deploy this tutorial's application you first need to go inside it's project directory and then push the application:

cd spring-cloud-autoconf-jms
cf push

This will push the application and will give the application the name specified by the manifest: solace-sample-spring-cloud-autoconf-jms.

Providing other Properties to the application.

The configuration properties affecting the creation of Sessions is stored in SolaceJmsProperties, the Auto Configuration takes care of injecting Cloud Provided Solace Messaging Credentials into the SolaceJmsProperties which is used by the Solace ConnectionFactory implementation instance.

Additional properties can be set in SolaceJmsProperties, for naming details refer to the Application Properties section of solace-jms-spring-boot.

This example will set set SolaceJMSDynamicDurables to 'true' which can be used to dynamically create JMS objects on the Solace message router. To learn more about the DynamicDurables Solace JMS API property refer to the Persistence with Queues JMS tutorial.

cd spring-cloud-autoconf
cf set-env solace-sample-spring-cloud-autoconf solace.jms.apiProperties.Solace_JMS_DynamicDurables true
cf restage solace-sample-spring-cloud-autoconf

Trying Out The Application

As described above, the sample application has a simple REST interface that allows you to:

• Subscribe to a topic
• Send a message to a topic
• Receive a message
• Unsubscribe from a topic

In order to interact with the application you need to determine the application's URL. These shell commands can be used to quickly find out the URL:

export APP_NAME=solace-sample-spring-cloud-autoconf
export APP_URL=`cf apps | grep $APP_NAME | grep started | awk '{ print $6}'`
echo "The application URL is: ${APP_URL}"

To demonstrate the application we will make the application send a message to itself. Then we will read the message back to confirm the successful delivery of the message :

# Subscribes the application to the topic "test"
curl -X POST -H "Content-Type: application/json;charset=UTF-8" -d '{"subscription": "test"}' http://$APP_URL/subscription

# Send message with topic "test" and this content: "TEST_MESSAGE"
curl -X POST -H "Content-Type: application/json;charset=UTF-8" -d '{"topic": "test", "body": "Test Message"}' http://$APP_URL/message

# The message should have been asynchronously received by the application.  Check that the message was indeed received:
curl -X GET http://$APP_URL/message

# Unsubscribe the application from the topic "test"
curl -X DELETE http://$APP_URL/subscription/test