Business Problem

The Symphony BDK (Bot Developer Kit) for Java helps you to create production-grade Chat Bots and Extension Applications on top of the Symphony REST APIs.

Proposed Solution

The Symphony BDK for Java proposes a brand new developer experience built around:

API layer generated from the OpenAPI specifications
Fluent high level services for authentication, real time events handling, error management and retries
Native OBO (On-Behalf-Of) support
Templating API for complex messages
Spring Boot integration

The project has been built following best quality practices:

Pull Requests checks
Enforced minimal code coverage (90%)
Architecture testing
Dependencies security monitoring via Snyk
Fully automated release process

Current State

This BDK2.0 is a complete rewrite of:

The GA version of the library has recently been deployed to Maven Central. It is released under MIT licence.

Existing Materials

Current official repository: https://github.com/SymphonyPlatformSolutions/symphony-api-client-java
Official documentation: https://docs.developers.symphony.com/building-bots-on-symphony/tutorials/bdk-2.0-tutorials/building-a-chatbot-using-the-bdk-2.0
Trainings: https://learn.symphony.com/bundles/java-bot-developer

Development Team

Olivier Poupeney, Symphony, Engineering Owner, olivier.poupeney@symphony.com, GitHub: opoupeney (maintainer)
Darlys Maldonado, Symphony, Engineering Owner, darlys.maldonado@symphony.com, GitHub: symphonydarlys (maintainer)
Youri Bonnaffé, Symphony, Lead, youri.bonnaffe@symphony.com, GitHub: symphony-youri (maintainer)
Elias Croze, Symphony, Lead, elias.croze@symphony.com, GitHub: symphony-elias (maintainer)
Thibault Pensec, Symphony, Lead, thibault.pensec@symphony.com, GitHub: symphony-thibault (maintainer)
Adnane Tellou, Symphony, Co-Lead, adnane.tellou@symphony.com, GitHub: symphony-adnane (maintainer)

Contribution process (v. 1.0, last updated on October 2, 2020)

Below is the list of tasks that FINOS Team and the contribution author go through in order to complete the FINOS contribution process. Please do not edit these contents at contribution time!

FINOS Contrib POC

[x] Identify and Assign FINOS Contrib POC - @maoo and @mindthegab

Identify project meta (Lead: FINOS Contrib POC, Support: FINOS Marketing)

[x] Project Name - Symphony BDK for Java
- [x] Assess current trademark status
- [x] Define new project name (if applicable)
- [x] Design new project logo (if applicable)
- [x] Trademark new project name and logo (if applicable)
[x] Category and sub-category (for FINOS Landscape) - Applications / Symphony Ecosystem
[x] Existing code or new Github repository - https://github.com/SymphonyPlatformSolutions/symphony-api-client-java
[x] Existing code releases (and which artifact repositories are used) - https://search.maven.org/artifact/com.symphony.platformsolutions/symphony-bdk-bom
[x] Team composition: lead maintainer and other maintainers - see above, lead is Olivier
[x] Meetings (existing/yes/no)
[x] Meeting minutes, agenda, attendance tracking (existing/yes/no) - not for now
[x] Continuous Integration (existing/yes/no) - CircleCI
[x] Documentation website (existing/yes/no) - https://symphonyplatformsolutions.github.io/symphony-api-client-java/
[x] Define project slug - symphony-bdk-java

Maintainers, contributors and CLAs (Lead: FINOS Contrib POC, Support: FINOS infra)

[x] For each maintainer identified in the previous step, collect: the following info:
- Fullname
- GitHub username
- Corporate email address
[x] Identify other existing contributors (assuming there's a contribution history (eg Git history)
[x] Check if maintainers and other contributors are all covered by FINOS CLA
[x] Engage with FINOS Legal team to figure out what’s needed to cover all maintainers and contributors with FINOS CLA
[x] Reach out to contributors and employers to coordinate CLA signatures

Project Communication Channel(s)

[x] Ask maintainers which communications channels they'd like to use: GitHub Issues and Symphony chat
[x] Create the identified communication channels during infra set up
[x] Link communication channels linked front and center in the project README.md

Code validation (only if code is contributed) (Lead: FINOS Infra)

[x] The codebase doesn’t have HIGH or CRITICAL CVEs across direct and transitive libraries
[x] The codebase doesn’t have any unfriendly licenses across direct and transitive libraries - no unfriendly licenses found, checked license export
[x] (optional - if a build system is provided) The build process runs successfully
[x] finos-admin is Admin of the GitHub repository to transfer
[x] The codebase doesn’t include any patent or copyright that conflicts with FINOS Governance and bylaws (to be validated with FINOS Legal team)
[x] Apply project blueprint contents - see ODP docs
- [x] Ensure that the proper project governance is in the CONTRIBUTING.md file
[x] All incubating criteria are checked and documented below

Approval (Lead: FINOS Infra)

[x] Assign issue to Executive Director (@mindthegab) to trigger voting
[x] (optional) at the discretion of the Executive Director: bring projects to the Board for additional socialization and approval
[x] FINOS accepts the contribution (and the contribution process can move forward)

Code transfer (Lead: FINOS Infra)

[x] Check GitHub repository transfer requirements:
- [x] finos-admin has Admin to all repositories to transfer
- [x] finos-admin ia allowed to transfer repositories out of the org
- [x] if the repository is owned by a user (and not an org), the user must be able to transfer the repository to finos-admin
[x] Transfer all code assets as GitHub repositories under github.com/finos
[x] Invite GitHub usernames to GitHub FINOS Org
[x] Create <project-name>-maintainers GitHub team and invite users
[x] Configure finos-admins and finos-staff team permissions

Infra setup (Lead: FINOS Infra)

[x] Update release coordinates and code namespace to include finos (best effort)
[x] Update project badge
[x] Update project README to describe: getting started, how consume, how to contribute, how to communicate with devs
[x] Enable security vulnerabilities scanning - https://security.dev.platform.linuxfoundation.org/#/project/5c122052-6cff-45b2-9fbe-ad268710d83b/manage-project
[x] Enable meeting attendance tracking (optional)

Metadata update (Lead: FINOS Infra)

[x] Add project to metadata
[x] Add identities, orgs and affiliations to metadata
[x] Add logo to FINOS landscape
[x] Add project maintainers emails to finos-project-maintainers@finos.org list
[x] Add project maintainers GitHub usernames to the project-maintainers Team

Announcement (Lead: FINOS Contrib POC)

[x] Draft announcement, template available at https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/83034172/Contribute (@symphony-thibault)
[x] Draft email to symphony@finos.org - to revamp Symphony Dev Community (@symphony-thibault)
[x] Validate announcement with FINOS marketing team
[x] Send announcement to announce@finos.org (question: maybe we could send it FROM symphony@finos.org ?)
[x] Close this issue
[x] Send "Call to Action" to symphony@finos.org

Onboarding and training

[x] FINOS Project Governance
[x] FINOS Project Lifecycle
[x] ODP Training

finos / community

Project Contribution and Onboarding - Symphony BDK for Java #94