This project is a set of libraries aimed at facilitating creating Bots and Apps for the Symphony Chat Platform using Java and Spring Boot.
This project contains the following:
- Symphony Java Client Bindings
- Symphony Java Client Identity
- Symphony API Spring-Boot Starter
- Symphony App Spring-Boot Starter
- Symphony JSON Support
- Demo App
- Demo Bot
- Tutorials for getting started
- Symphony FIX Support
- A Symphony Maven Build Notifier
- Symphony Shared Stream
Read further to see what each of these includes.
The first four projects have dependencies on one another, expressed through this diagram. If you are using the higher elements in the diagram, you'll automatically depend on the lower ones. However, if you're building bots in Spring Boot (say), then you'll not need the top-most dependency.
This provides a JAX-RS standard, Type-Safe means of interacting with Symphony pods via REST apis.
symphony-java-client-bindings is a set of swagger-generated domain objects and interfaces that provide a Java API for interacting with Symphony's REST endpoints.
This is used in preference to Symphony's own API as the configuration can be left to spring boot, and you can use Spring's starters for JAX-RS to build your application.
symphony-java-client-identity provides a single abstraction of SymphonyIdentity, which encapsulates the data needed to authenticate with a symphony server. That is:
- Private Key
- Certificates
- Common Name
- Email Address
This is a highly convenient abstraction which works with Spring Boot's use of Jackson and YAML to describe Bot and App identities in Java.
Provides Spring-Based configuration and auto-wiring for Symphony APIs. This is perfect if you are building a Symphony Bot using Spring Boot.
If you are building a Symphony App, there are multiple concerns around app security, networking, describing your application and handling user authentication.
This provides you with an out-of-the-box way to get started and build an app with all of these concerns taken care of.
This is a utility that helps you serialize/deserialize JSON in a format suitable for the JSON data payload of a Symphony Message, using Jackson.
This is a utility that helps you serialize/deserialize QuickFIX messages into JSON Format, as described here.
Although this is not reliant on Symphony code, it is adjacent tech and so might be useful for sending FIX payloads within Symphony.
Provides a maven extension that allows you to report build results into a Symphony chat room.
The purpose of this module is to provide a drop-in stream consumer for Symphony that allows a cluster of bot replicas to coordinate work. That is, prevent the problem of two or more bots simultaneously consuming and processing the same Symphony message.
This project is licensed under the Apache 2.0 License.
In order to do a release:
- On Releaser's machine:
mvn test
mvn versions:set -DnewVersion=<our breaking change no>.<symphony-api-version>.<our-release-no> -DartifactId=* -DgroupId=*
mvn -DskipTests -pl '!demos/demo-bot,!demos/demo-app' clean test source:jar javadoc:javadoc deploy -P symphony-release
mvn versions:set -DnewVersion=<our breaking change no>.<symphony-api-version>.<our-release-no+1>-SNAPSHOT -DartifactId=* -DgroupId=*
# then push to git
- In Bintray:
Jcenter release is performed automatically. To release to maven central: https://bintray.com/package/central/deutschebank/SymphonyPractice/symphony-java-client-parent#central Enter details and click sync.
- NB:: This seems to be somewhat unreliable. If it fails, un-check "Close and release repository when done." and instead do the close + release process via the interface at oss.sonatype.org.