Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

APP-3083 Core SpringBoot Starter documentation #251

Merged
merged 6 commits into from
Sep 30, 2020

Conversation

thibauult
Copy link
Member

Ticket

APP-3083

Description

BDK Core Spring Boot Starter reference documentation.

Checklist

  • Referenced a ticket in the PR title and in the corresponding section
  • Updated the documentation in docs folder

@thibauult thibauult requested a review from a team September 29, 2020 13:37
Copy link
Contributor

@symphony-youri symphony-youri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could like to the example module in the BDK as it is a complete project with all the required files

How can we use obo with Spring, is there a way to retrieve the SymphonyBdk object?


## Installation

The following listing shows the `pom.xml` file that is created when you choose Maven:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

created by who? the generator?


@EventListener
public void onMessageSent(RealTimeEvent<V4MessageSent> event) {
this.messageService.send(event.getSource().getMessage().getStream(),"<messageML>Hello!</messageML>");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a space is missing between the parameters (formatting psycho....)

out of the scope here but:
event.getSource().getMessage().getStream() is a bit ugly

this.messageService.reply(event, "Hello!"); would be nice :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this.messageService.reply(event, "Hello!"); would be nice :)

The problem here is that RealTimeEvent<T> is only part of the Spring module. But we could however however assume that RealTimeEvent has a streamId property, that is common for a Real Time Events.

Let me have a look!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But that would be impossible, as V4ConnectionRequested and V4ConnectionAccepted events are not related to a stream.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, the ConnectionRequest and ConnectionAccept event, they don't have streamId property.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or maybe this.messageService.reply(event.getSource(), "Hello!"); then?

@@ -0,0 +1,257 @@
# BDK Core SpringBoot Starter
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spring Boot (with the space)

private ActivityRegistry activityRegistry;
}
```
> Please note that field injection is not recommended, you should consider using
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then perhaps we should not show an example using field injection :) (but it is shorter...)
So maybe we could just list the available services?


Here's the list of Real Time Events you can subscribe:
```java
@Component
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as a BDK user is there a way to discover all the events I can use (they don't all inherit the same class)?

@thibauult thibauult merged commit 99e9828 into finos:master Sep 30, 2020
@thibauult thibauult deleted the APP-3083_SpringBoot-documentation branch September 30, 2020 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants