Skip to content

Commit 3c76bc1

Browse files
committed
Automatic docs and changelog generation
1 parent 745fab6 commit 3c76bc1

File tree

2 files changed

+123
-5
lines changed

2 files changed

+123
-5
lines changed

CHANGELOG.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Changelog
2+
3+
## [1.0.0-beta1](https://github.com/reactive-commons/reactive-commons-java/tree/1.0.0-beta1) (2020-10-28)
4+
5+
## [0.6.2-Release](https://github.com/reactive-commons/reactive-commons-java/tree/0.6.2-Release) (2020-09-24)
6+
7+
## [0.6.2](https://github.com/reactive-commons/reactive-commons-java/tree/0.6.2) (2020-09-24)
8+
9+
**Implemented enhancements:**
10+
11+
- update to Gradle to 5.1.1 [\#16](https://github.com/reactive-commons/reactive-commons-java/issues/16)
12+
- Add application name to amqp connection [\#13](https://github.com/reactive-commons/reactive-commons-java/issues/13)
13+
14+
## [0.6.2-beta](https://github.com/reactive-commons/reactive-commons-java/tree/0.6.2-beta) (2020-08-25)
15+
16+
## [v0.6.1-beta](https://github.com/reactive-commons/reactive-commons-java/tree/v0.6.1-beta) (2020-08-23)
17+
18+
## [v0.6.0-beta](https://github.com/reactive-commons/reactive-commons-java/tree/v0.6.0-beta) (2020-08-19)
19+
20+
**Implemented enhancements:**
21+
22+
- Update to ReactorRabbit 1.1.0 [\#17](https://github.com/reactive-commons/reactive-commons-java/issues/17)
23+
24+
## [0.5.2-beta](https://github.com/reactive-commons/reactive-commons-java/tree/0.5.2-beta) (2020-07-20)
25+
26+
## [0.5.0](https://github.com/reactive-commons/reactive-commons-java/tree/0.5.0) (2020-06-08)
27+
28+
## [0.4.7](https://github.com/reactive-commons/reactive-commons-java/tree/0.4.7) (2020-05-21)
29+
30+
## [v0.4.6](https://github.com/reactive-commons/reactive-commons-java/tree/v0.4.6) (2020-04-23)
31+
32+
## [v0.4.5](https://github.com/reactive-commons/reactive-commons-java/tree/v0.4.5) (2020-04-23)
33+
34+
## [v0.4.3](https://github.com/reactive-commons/reactive-commons-java/tree/v0.4.3) (2020-04-21)
35+
36+
## [v0.4.2](https://github.com/reactive-commons/reactive-commons-java/tree/v0.4.2) (2020-04-13)
37+
38+
## [v4.0.1](https://github.com/reactive-commons/reactive-commons-java/tree/v4.0.1) (2020-04-11)
39+
40+
## [v4.0.4](https://github.com/reactive-commons/reactive-commons-java/tree/v4.0.4) (2020-04-10)
41+
42+
## [v0.3.2-b](https://github.com/reactive-commons/reactive-commons-java/tree/v0.3.2-b) (2020-03-31)
43+
44+
## [v0.3.2-beta](https://github.com/reactive-commons/reactive-commons-java/tree/v0.3.2-beta) (2020-03-30)
45+
46+
## [v0.3.2-beta1](https://github.com/reactive-commons/reactive-commons-java/tree/v0.3.2-beta1) (2020-03-30)
47+
48+
## [0.0.5-beta2](https://github.com/reactive-commons/reactive-commons-java/tree/0.0.5-beta2) (2019-01-02)
49+
50+
**Implemented enhancements:**
51+
52+
- Unwrap String in request-reply when reply is a String [\#11](https://github.com/reactive-commons/reactive-commons-java/issues/11)
53+
- Tolerant reader in all message receivers [\#10](https://github.com/reactive-commons/reactive-commons-java/issues/10)
54+
- Integrate acceptance test with travis. [\#7](https://github.com/reactive-commons/reactive-commons-java/issues/7)
55+
- Query handler returning an empty publisher causes timeout on the receiver [\#1](https://github.com/reactive-commons/reactive-commons-java/issues/1)
56+
57+
58+
59+
\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

docs/index.html

Lines changed: 64 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<h1>Reactive Commons Reference Guide</h1>
1616
<div class="details">
1717
<span id="author" class="author">Daniel Bustamante Ospina</span><br>
18-
<span id="revdate">0.6.2</span>
18+
<span id="revnumber">version 1.0.0-beta1</span>
1919
</div>
2020
<div id="toc" class="toc2">
2121
<div id="toctitle">Table of Contents</div>
@@ -196,7 +196,7 @@ <h4 id="_sample_spring_boot_application">2.1.2. Sample Spring Boot Application</
196196
<div class="listingblock">
197197
<div class="content">
198198
<pre class="prettyprint highlight"><code data-lang="groovy"> dependencies {
199-
compile "org.reactivecommons:async-commons-starter:0.6.2"
199+
compile "org.reactivecommons:async-commons-starter:0.6.2-ignored-value"
200200
}</code></pre>
201201
</div>
202202
</div>
@@ -547,6 +547,7 @@ <h4 id="_directasyncgateway_commands">3.3.2. DirectAsyncGateway - Commands</h4>
547547
<pre class="prettyprint highlight"><code data-lang="java">public interface DirectAsyncGateway {
548548
&lt;T&gt; Mono&lt;Void&gt; sendCommand(Command&lt;T&gt; command, String targetName);
549549
&lt;T, R&gt; Mono&lt;R&gt; requestReply(AsyncQuery&lt;T&gt; query, String targetName, Class&lt;R&gt; type);
550+
&lt;T&gt; Mono&lt;Void&gt; reply(T response, From from);
550551
}</code></pre>
551552
</div>
552553
</div>
@@ -650,6 +651,10 @@ <h5 id="_handlerregistry_listenevent">HandlerRegistry - listenEvent</h5>
650651
<div class="listingblock">
651652
<div class="content">
652653
<pre class="prettyprint highlight"><code data-lang="java">public interface EventHandler&lt;T&gt; extends GenericHandler&lt;Void, DomainEvent&lt;T&gt;&gt; {
654+
}
655+
656+
public interface GenericHandler&lt;T, M&gt; {
657+
Mono&lt;T&gt; handle(M message);
653658
}</code></pre>
654659
</div>
655660
</div>
@@ -701,6 +706,10 @@ <h5 id="_handlerregistry_handlecommand">HandlerRegistry - handleCommand</h5>
701706
<div class="listingblock">
702707
<div class="content">
703708
<pre class="prettyprint highlight"><code data-lang="java">public interface CommandHandler&lt;T&gt; extends GenericHandler&lt;Void, Command&lt;T&gt;&gt; {
709+
}
710+
711+
public interface GenericHandler&lt;T, M&gt; {
712+
Mono&lt;T&gt; handle(M message);
704713
}</code></pre>
705714
</div>
706715
</div>
@@ -732,11 +741,13 @@ <h5 id="_handlerregistry_handlecommand">HandlerRegistry - handleCommand</h5>
732741
<div class="sect4">
733742
<h5 id="_handlerregistry_servequery">HandlerRegistry - serveQuery</h5>
734743
<div class="paragraph">
735-
<p>serveQuery method lets you register a handler for a specific query. It has the next signature:</p>
744+
<p>serveQuery method lets you register a handler for a specific query. It has the next signatures:</p>
736745
</div>
737746
<div class="listingblock">
738747
<div class="content">
739-
<pre class="prettyprint highlight"><code data-lang="java">HandlerRegistry serveQuery(String resource, QueryHandler&lt;T, R&gt; handler, Class&lt;R&gt; queryClass)</code></pre>
748+
<pre class="prettyprint highlight"><code data-lang="java">HandlerRegistry serveQuery(String resource, QueryHandler&lt;T, R&gt; handler, Class&lt;R&gt; queryClass)
749+
750+
HandlerRegistry serveQuery(String resource, QueryHandlerDelegate&lt;Void, R&gt; handler, Class&lt;R&gt; queryClass)</code></pre>
740751
</div>
741752
</div>
742753
<div class="paragraph">
@@ -745,6 +756,20 @@ <h5 id="_handlerregistry_servequery">HandlerRegistry - serveQuery</h5>
745756
<div class="listingblock">
746757
<div class="content">
747758
<pre class="prettyprint highlight"><code data-lang="java">public interface QueryHandler&lt;T, C&gt; extends GenericHandler&lt;T, C&gt; {
759+
}
760+
761+
public interface GenericHandler&lt;T, M&gt; {
762+
Mono&lt;T&gt; handle(M message);
763+
}</code></pre>
764+
</div>
765+
</div>
766+
<div class="paragraph">
767+
<p>The QueryHandlerDelegate interface signature is:</p>
768+
</div>
769+
<div class="listingblock">
770+
<div class="content">
771+
<pre class="prettyprint highlight"><code data-lang="java">public interface QueryHandlerDelegate&lt;T, M&gt; {
772+
Mono&lt;T&gt; handle(From from, M message);
748773
}</code></pre>
749774
</div>
750775
</div>
@@ -772,6 +797,39 @@ <h5 id="_handlerregistry_servequery">HandlerRegistry - serveQuery</h5>
772797
}</code></pre>
773798
</div>
774799
</div>
800+
<div class="admonitionblock note">
801+
<table>
802+
<tr>
803+
<td class="icon">
804+
<i class="fa icon-note" title="Note"></i>
805+
</td>
806+
<td class="content">
807+
The return type of the QueryHandlerDelegate should be Void
808+
</td>
809+
</tr>
810+
</table>
811+
</div>
812+
<div class="paragraph">
813+
<p>This second interface allows the request / reply pattern not to have to be resolved in the same flow. For example,
814+
when the execution of a task is requested, and it can be processed by a group of workers, who leave the result in a database. There is another group of workers who are in charge of listening to the changes in the database and responding to that request. In this scenario, the process who receives the request is not the same process who responds to it. That is the usage scenario for QueryHandlerDelegate:</p>
815+
</div>
816+
<div class="listingblock">
817+
<div class="content">
818+
<pre class="prettyprint highlight"><code data-lang="java"> @Bean
819+
public HandlerRegistry queryMessages() {
820+
return HandlerRegistry.register()
821+
.serveQuery("report.create", (from, query) -&gt; someTask.startReportProcess(from, query), SomeQuery.class);
822+
}</code></pre>
823+
</div>
824+
</div>
825+
<div class="paragraph">
826+
<p>When the report creation task is completed, the process responsible of responding should call the reply method of DirectAsyncGateway passing the from object like this:</p>
827+
</div>
828+
<div class="listingblock">
829+
<div class="content">
830+
<pre class="prettyprint highlight"><code data-lang="java"> gateway.reply(response, from)</code></pre>
831+
</div>
832+
</div>
775833
<div class="admonitionblock tip">
776834
<table>
777835
<tr>
@@ -811,7 +869,8 @@ <h5 id="_handlerregistry_servequery">HandlerRegistry - serveQuery</h5>
811869
</div>
812870
<div id="footer">
813871
<div id="footer-text">
814-
Last updated 2020-09-23 23:17:36 -0500
872+
Version 1.0.0-beta1<br>
873+
Last updated 2020-10-28 19:53:29 UTC
815874
</div>
816875
</div>
817876
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.min.css">

0 commit comments

Comments
 (0)