Samples showing how to connect and exchange messages with Solace Messaging for Pivotal Cloud Foundry.
Java HTML
Switch branches/tags
Nothing to show
Clone or download
alyrasmy Merge pull request #45 from alyrasmy/arasmy/fixed-links
Fixed some links that were using http
Latest commit 885d613 Jul 19, 2018
Permalink
Failed to load latest commit information.
_docs Fixed some links that where still hard coded to use http instead of h… Jul 18, 2018
gradle/wrapper Samples updates for auto configuration. Feb 3, 2018
java-app Add proper subscription DELETE request (#37) May 1, 2018
resources Arasmy/project restructure (#41) Jun 25, 2018
secure-session Add proper subscription DELETE request (#37) May 1, 2018
spring-cloud-autoconf-java Add proper subscription DELETE request (#37) May 1, 2018
spring-cloud-autoconf-jms Add proper subscription DELETE request (#37) May 1, 2018
spring-cloud-autoconf-jndi Add proper subscription DELETE request (#37) May 1, 2018
spring-cloud Add proper subscription DELETE request (#37) May 1, 2018
tcp-routes-mqtt Add proper subscription DELETE request (#37) May 1, 2018
template @ 46eb7d4 Pulled in latest version of jekyll template Jul 18, 2018
.gitignore Update Solace Cloud Foundry Spring Cloud Connector and JCSMP/JMS auto… Apr 17, 2018
.gitmodules Arasmy/project restructure (#41) Jun 25, 2018
.travis.yml Enable travis builds Dec 2, 2016
CONTRIBUTING.md Correct template references May 11, 2017
LICENSE Initial commit Aug 19, 2016
NOTICE Update notice for 2017 Feb 1, 2017
README.md Updated readme to point to Solace dev portal instead of GitHub.io Jun 25, 2018
_config.yml Arasmy/project restructure (#41) Jun 25, 2018
build.gradle Samples updates for auto configuration. Feb 3, 2018
gradlew Samples updates for auto configuration. Feb 3, 2018
gradlew.bat Samples updates for auto configuration. Feb 3, 2018
index.html Arasmy/project restructure (#41) Jun 25, 2018
settings.gradle Samples updates for auto configuration. Feb 3, 2018

README.md

Build Status

Getting Started Examples

Solace Cloud Foundry Java

The repository contains example applications that use the Solace Messaging service on Pivotal Cloud Foundry. The goal of these sample applications is to illustrate various ways of consuming the VCAP_SERVICES environment variable from a Solace Messaging Cloud Foundry service instance. You can get more details on the Solace Messaging Service for Pivotal Cloud Foundry here.

This repository contains a sample application modified in the following ways:

  • Simple Java Application
  • Using Spring Cloud Connectors
  • Connecting using Transport Level Security

While not necessary for a Java Application or a straight Spring Cloud Connector applications, the samples in this repository still make use of of Spring Boot so they can easily expose a simple REST interface to provide interactive ways to subscribe, send and receive Solace messages. Spring Boot is not required. You can make use of the Spring Cloud Connectors in any Java Application. See the walk through tutorials for more details.

All of these sample applications have full walk through tutorials that explain the code in detail. Tutorials for each sample are available here:

What follows is a brief summary for people that want to dive straight into the code.

Common Setup

The sample applications specify a dependency on a Solace Messaging service instance named solace-messaging-sample-instance. To create the required Solace messaging service instance, do the following:

cf create-service solace-messaging shared solace-messaging-sample-instance

Building

Just clone and build. For example:

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

Deploying

To deploy the individual applications to Cloud Foundry:

  1. cd to the project directory (java-app or spring-cloud)
  2. $ cf push

Java Application

application name: solace-sample-java-app

This application uses the Java library from http://www.JSON.org/ to parse the VCAP_SERVICES environment variable to determine the connection details for Solace messaging. For more details and example usage, see the walk through tutorial here:

Java Application using Spring Cloud Connector

application name: solace-sample-spring-cloud

This application makes use of the Spring Cloud Connectors project to automatically parse the VCAP_SERVICES environment variable. Applications do not have to be a Spring Boot application to make use of Spring Cloud Connectors. This example makes use of Spring Boot for convenience in enabling the simple REST API. In any Java Applications, simply specify the following dependencies in your build:

compile 'org.springframework.cloud:spring-cloud-spring-service-connector:1.2.3.RELEASE'
compile 'org.springframework.cloud:spring-cloud-cloudfoundry-connector:1.2.3.RELEASE'
compile 'com.solace.cloud.cloudfoundry:solace-spring-cloud-connector:2.1.+'

The solace-spring-cloud-connector is a Spring Cloud Connectors extension to parse the VCAP_SERVICES for the Solace Messaging service instance information. Check out the project page for more details:

The easiest way for applications to access the SolaceServiceCredentials object is by Service Id (ex: "MyService) as follows:

CloudFactory cloudFactory = new CloudFactory();
Cloud cloud = cloudFactory.getCloud();
SolaceServiceCredentials solaceServiceCredentials = (SolaceServiceCredentials) cloud.getServiceInfo("MyService");

Alternatively applications could search through the environment and discover matching services as follows:

SolaceServiceCredentials solaceServiceCredentials = null;
List<ServiceInfo> services = cloud.getServiceInfos();

// Connect to the first Solace-Messaging service that is found in the services list.
for (ServiceInfo service : services) {
	if (service instanceof SolaceServiceCredentials) {
		solaceServiceCredentials = (SolaceServiceCredentials)service;
		break;
	}
}

For more details and example usage, see the walk through tutorial here:

Secure Session

application name: solace-sample-secure-session

This application is based on the Spring Cloud Connector described above, but shows how to use Transport Level Security (TLS) between the Java application and the Solace Messaging Service Instance.

LDAP

This is not a standalone application, but instead a modification to the existing sample apps.

If application access is enabled by the cloud operator, bindings will not contain application access credentials and the credentials will instead have to be provided to the application externally.

This manifests as the service instance owner having to manually configure LDAP authorization groups for application access.

Try out the Applications

The sample applications have a simple REST interface that allows you to subscribe, send and receive Solace messages. You can try the applications out using command like the following.

Determine the URL of the sample application and export it for use in the curl commands. Adjust the app name as appropriate to match the sample you're using:

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

Subscribe to 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"

curl -X POST -H "Content-Type: application/json;charset=UTF-8" -d '{"topic": "test", "body": "TEST_MESSAGE"}' http://$APP_URL/message

The message is received asynchronously, check for the last message.

curl -X GET http://$APP_URL/message

Unsubscribe the application from topic "test"

curl -X DELETE http://$APP_URL/subscription/test

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: