The Symphony BDK for Java is a multi-module library that uses Gradle as build system. This page will help to clearly understand how the library has been designed. This can be also useful for new contributors aiming to provide additional features or implementations or existing APIs.
The following diagram aims to give an overview of the different layers and modules provided by the BDK library.
symphony-bdk-core is the main module that allows developers to write bots from a pure Java main application. It contains all necessary BDK features such as:
symphony-bdk-core module relies on the openapi-generator-maven-plugin to generate API clients and models from official Symphony’s Swagger specifications. API’s clients are located under package
com.symphony.bdk.gen.api and models under
symphony-bdk-http-api module defines a generic interface for performing HTTP calls. Along with this interface, it also provides a utility
com.symphony.bdk.http.api.HttpClient class helping developers to perform calls to external systems.
It is important to notice that interface
com.symphony.bdk.http.api.ApiClientis used by generated code. Changing contract would break the build. See Code Generation.
At the moment, two different implementations have been created for the
com.symphony.bdk.http.jersey2.ApiClientJersey2contained in module
symphony-bdk-http-jersey2(default implementation for Core)
com.symphony.bdk.http.webclient.ApiClientWebClientcontained in module
symphony-bdk-http-webclient(default implementation for Spring Boot)
symphony-bdk-template-api module defines a set of interfaces that allows developers to load and fill text files with data. This API is especially useful for complex MessageML templating.
At the moment, two different module implementations have been created:
The Symphony BDK comes also with two starter modules to ease integration with the Spring Boot framework: