What This Is
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
- Symphony FIX Support
- A Symphony Maven Build Notifier
- A TeamCity Build Notifier
- Symphony Shared Stream
- Chat Workflow
- Tutorials for getting started
- Demo bots and apps
Read further to see what each of these includes.
Overview and Dependencies
Many of the components in this project rely on each other, as demonstrated in this dependency diagram. This also gives and overviw of the purpose of each component.
Symphony Java Client Bindings
This provides a JAX-RS standard, Type-Safe means of interacting with Symphony pods via REST apis.
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
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
- Common Name
- Email Address
Symphony API Spring Boot Starter
Provides Spring-Based configuration and auto-wiring for Symphony APIs. This is perfect if you are building a Symphony Bot using Spring Boot.
Symphony App Spring Boot Starter
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.
Symphony JSON Support
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.
Maven Build Reporter
Provides a maven extension that allows you to report build results into a Symphony chat room.
TeamCity Build Notifier
Allows you to report your TeamCity builds into Symphony chat rooms, using a bot.
Symphony Shared Stream
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 module provides a one-stop-shop for constructing work-flows in Java. It is intended that beyond configuration (see below), the developer will not have to understand any Symphony APIs to build initial proof-of-concept work-flows and have them run in Symphony.
This project is licensed under the Apache 2.0 License.
Releasing This Project (For Maintainers)
In order to do a release:
- Update this file to include details of the release.
- On Releaser's machine:
mvn test integration-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,!demos/claim-bot,!demos/poll-bot,!demos/todo-bot' 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
- Close the Staging Repository
- Release it.
- Perform release on github with same number