Symphony Java Client Identity

A collection of Java projects for building Symphony bots and apps

License	Apache License, Version 2.0
Categories	IDE Development Tools Java Languages CLI User Interface
GroupId	org.finos.symphony.toolkit
ArtifactId	symphony-java-client-identity
Last Version	4.59.9
Release Date	Oct 26, 2020
Type	jar
Description	Symphony Java Client Identity A collection of Java projects for building Symphony bots and apps
Project Organization	Finos

Download symphony-java-client-identity

Filename	Size
symphony-java-client-identity-4.59.9.pom
symphony-java-client-identity-4.59.9.jar	21 KB
symphony-java-client-identity-4.59.9-sources.jar	12 KB
symphony-java-client-identity-4.59.9-javadoc.jar	476 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.finos.symphony.toolkit/symphony-java-client-identity/ -->
<dependency>
    <groupId>org.finos.symphony.toolkit</groupId>
    <artifactId>symphony-java-client-identity</artifactId>
    <version>4.59.9</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.finos.symphony.toolkit/symphony-java-client-identity/
implementation 'org.finos.symphony.toolkit:symphony-java-client-identity:4.59.9'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.finos.symphony.toolkit/symphony-java-client-identity/
implementation ("org.finos.symphony.toolkit:symphony-java-client-identity:4.59.9")

Apache Buildr

'org.finos.symphony.toolkit:symphony-java-client-identity:jar:4.59.9'

Apache Ivy

<dependency org="org.finos.symphony.toolkit" name="symphony-java-client-identity" rev="4.59.9">
  <artifact name="symphony-java-client-identity" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.finos.symphony.toolkit', module='symphony-java-client-identity', version='4.59.9')
)

Scala SBT

libraryDependencies += "org.finos.symphony.toolkit" % "symphony-java-client-identity" % "4.59.9"

Leiningen

[org.finos.symphony.toolkit/symphony-java-client-identity "4.59.9"]

Dependencies

compile (2)

Group / Artifact	Type	Version
com.fasterxml.jackson.core : jackson-annotations	jar	2.10.0
com.fasterxml.jackson.core : jackson-databind	jar	2.10.0

test (1)

Group / Artifact	Type	Version
junit : junit	jar	4.13.1

Project Modules

There are no modules declared in this project.

What This Is

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
• Symphony FIX Support
• A Symphony Maven Build Notifier
• A TeamCity Build Notifier
• Symphony Shared Stream
• Chat Workflow
• KoreAI Connector
• 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.

• Symphony REST Endpoint Documentation
• Symphony REST Endpoint Swagger Definitions

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.

View The README

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
• 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.

View The README

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.

• View the README
• Read the Bot-Building Tutorial
• View Demo Bot Code

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.

• View the README
• Read the App-Building Tutorial
• View Demo App Code

Entity JSON - 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.

• View the README
• Read the Tutorial

QuickFIX Support

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.

• View the README

Maven Build Reporter

Provides a maven extension that allows you to report build results into a Symphony chat room.

• View the README

TeamCity Build Notifier

Allows you to report your TeamCity builds into Symphony chat rooms, using a bot.

• View the README

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.

• View the README

Chat Workflow

This module provides a one-stop-shop for constructing work-flows in Java. It is intended that beyond configuration the developer will not have to understand any Symphony APIs to build work-flows and have them run in Symphony.

• View the README
• View the Tutorial
• Demo Poll Bot
• Demo To-Do List Bot
• Demo Claim Bot

Kore-AI Bridge

This is a Spring Boot App that acts as a middleman between a Symphony bot and a KoreAI bot, allowing you to expose your KoreAI bot as a bot on Symphony. Kore.AI is a low code/no code environment for building chat bots.

• View the README

License

This project is licensed under the Apache 2.0 License.

Releasing This Project (For Maintainers)

In order to do a release:

1. Changes.md

• Update this file to include details of the release.

2. On Releaser's machine:

mvn test integration-test -P symphony-ci
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

3. On oss.sonatype.org

• Close the Staging Repository
• Release it.

4. Perform release on github with same number

The Fintech Open Source Foundation (www.finos.org)

FINOS’ mission is to promote open innovation in financial services. See our full list of repos from our nearly 100 projects & 11 programs at finos.github.io

Versions

Version
4.59.9 Oct 26, 2020