APP-2813/APP-2812 - BDK2.0 modules setup #166
Conversation
pom.xml
Outdated
| @@ -13,11 +13,25 @@ | |||
|
|
|||
| <modules> | |||
| <module>symphony-bdk-legacy</module> | |||
There was a problem hiding this comment.
Should we create another profile for legacy? it might be confusing if legacy is included in 2.0
There was a problem hiding this comment.
Profile 2.0 is by default not activated since we don't want to start releasing related modules, but we still want to release legacy modules in any case. So yes, for me legacy modules are also part of the 2.0 (like JUnit5/Vintage : https://junit.org/junit5/docs/current/user-guide/#migrating-from-junit4)
There was a problem hiding this comment.
Well, finally I introduced a legacy profile as well 😅 However it is activated by default which is not the case for the 2.0 one
thibauult
changed the title
thibauult
changed the title
| return true; | ||
| } | ||
|
|
||
| return arg.trim().isEmpty(); |
There was a problem hiding this comment.
Could be simplified in :
return arg == null || arg.trim().isEmpty()
But that's a detail
| * @param separator The separator | ||
| * @return the resulting string | ||
| */ | ||
| public static String join(String[] array, String separator) { |
There was a problem hiding this comment.
Why not using String.join(separator, array) ?
| * @return a {@link PrivateKey} instance | ||
| * @throws GeneralSecurityException On invalid Private Key | ||
| */ | ||
| public static PrivateKey parseRSAPrivateKey(final String pemPrivateKey) throws GeneralSecurityException { |
There was a problem hiding this comment.
It could improve readability to extract two methods here, one for PKCS#8 format, one for // PKCS#1 format
|
|
||
| The BDK is divided in 3 different layers: | ||
| - `core` that contains the minimal set of classes to configure, authenticate and use | ||
| the main APIs |
There was a problem hiding this comment.
how will we decide if something is main or advanced?
docs/internal/bdk-architecture.md
Outdated
| - `framework` that provides connectors (or starters) for the main Java frameworks | ||
| such as [SpringBoot](https://spring.io/projects/spring-boot), | ||
| [MicroProfile](https://projects.eclipse.org/projects/technology.microprofile), | ||
| [Micronaut](https://micronaut.io/), [Quarkus](https://quarkus.io/) or [Vertx](https://vertx.io/) |
There was a problem hiding this comment.
with JDK project Loom, Vertx is dead! :P
| * Interface used to perform HTTP requests performed by the generated Swagger code. | ||
| */ | ||
| @API(status = API.Status.STABLE) | ||
| public interface ApiClient { |
There was a problem hiding this comment.
did we consider other http clients? (like feign for instance?)
There was a problem hiding this comment.
Yes, the one that we will implement soon is the WebClient for Spring integration
There was a problem hiding this comment.
That one because it is a reactive one has a terrible API (IMHO) but I hope we will hide the complexity of with our own API
| final AuthenticateRequest request = new AuthenticateRequest(); | ||
| request.setToken(generateJwt()); | ||
|
|
||
| final String sessionToken = loginAuthApi.pubkeyAuthenticatePost(request).getToken(); |
There was a problem hiding this comment.
at the Java API level do we need the HTTP method to appear (post)?
There was a problem hiding this comment.
Nope, this class is just a temporary hello world, we will hide those low-level clients in cleaner services
|
|
||
| <dependency> | ||
| <groupId>ch.qos.logback</groupId> | ||
| <artifactId>logback-classic</artifactId> |
There was a problem hiding this comment.
In the Spring Boot starter log4j is used, do you know if there is standard one to prefer for Symphony projects?
There was a problem hiding this comment.
For tests and hello worlds samples I keep using logback, as this dependency is not directly provided by the SDK library (only slf4j is)
|
|
||
| private static final String POD_BASE_URL = "https://devx1.symphony.com"; | ||
|
|
||
| public static void main(String[] args) throws Exception { |
There was a problem hiding this comment.
in the SDK do we provide an Java API close to the REST API or do we provide a Java API that hides a lot of the complexity?
with the second version for instance I would expect to be able to initialize the SDK with auth info and then to perform queries without passing any auth tokens, all of that being taken care internally
There was a problem hiding this comment.
Yes of course the SDK will provide services that wrap this complexity. We just did not started building them yet :)
There was a problem hiding this comment.
I created this sample class mainly to confirm that the code generation was working well
No description provided.