From 70537b924e81359feaacac192f8bd82ee415c84a Mon Sep 17 00:00:00 2001 From: Oleg Zhurakousky Date: Tue, 25 May 2021 14:53:08 +0200 Subject: [PATCH] GH-2164 Update documentation Remove obsolete docs and add deprecations and update what's new section Resolves #2164 --- README.adoc | 7 ++++-- docs/src/main/asciidoc/preface.adoc | 7 ++++-- .../main/asciidoc/spring-cloud-stream.adoc | 22 ------------------- 3 files changed, 10 insertions(+), 26 deletions(-) diff --git a/README.adoc b/README.adoc index 508fb3e82..1d4453d54 100644 --- a/README.adoc +++ b/README.adoc @@ -175,13 +175,14 @@ You can also build and package your application into a boot jar (by using `./mvn Now you have a working (albeit very basic) Spring Cloud Stream application. -== What's New in 3.0? +== What's New in 3.x? [[spring-cloud-stream-preface-new-features]] === New Features and Enhancements -- *Routing Function* - see <> for more details. +- *Routing Function* - see <> for more details. +- *StreamBridge* - for dynamic destinations. See <> for more details. - *Multiple bindings with functions* (multiple message handlers) - see <> for more details. - *Functions with multiple inputs/outputs* (single function that can subscribe or target multiple destinations) - see <> for more details. - *Native support for reactive programming* - since v3.0.0 we no longer distribute spring-cloud-stream-reactive modules and instead @@ -192,6 +193,8 @@ compatibility you can still bring `spring-cloud-stream-reactive` from previous v [[spring-cloud-stream-preface-notable-deprecations]] === Notable Deprecations +- Annotation-based programming model. Basically the @EnableBInding, @StreamListener and all related annotations are now deprecated in +favor of the functional programming model. See <> for more details. - _Reactive module_ (`spring-cloud-stream-reactive`) is discontinued and no longer distributed in favor of native support via spring-cloud-function. For backward compatibility you can still bring `spring-cloud-stream-reactive` from previous versions. diff --git a/docs/src/main/asciidoc/preface.adoc b/docs/src/main/asciidoc/preface.adoc index 70a931368..e14de847d 100644 --- a/docs/src/main/asciidoc/preface.adoc +++ b/docs/src/main/asciidoc/preface.adoc @@ -154,13 +154,14 @@ You can also build and package your application into a boot jar (by using `./mvn Now you have a working (albeit very basic) Spring Cloud Stream application. -== What's New in 3.0? +== What's New in 3.x? [[spring-cloud-stream-preface-new-features]] === New Features and Enhancements -- *Routing Function* - see <> for more details. +- *Routing Function* - see <> for more details. +- *StreamBridge* - for dynamic destinations. See <> for more details. - *Multiple bindings with functions* (multiple message handlers) - see <> for more details. - *Functions with multiple inputs/outputs* (single function that can subscribe or target multiple destinations) - see <> for more details. - *Native support for reactive programming* - since v3.0.0 we no longer distribute spring-cloud-stream-reactive modules and instead @@ -171,6 +172,8 @@ compatibility you can still bring `spring-cloud-stream-reactive` from previous v [[spring-cloud-stream-preface-notable-deprecations]] === Notable Deprecations +- Annotation-based programming model. Basically the @EnableBInding, @StreamListener and all related annotations are now deprecated in +favor of the functional programming model. See <> for more details. - _Reactive module_ (`spring-cloud-stream-reactive`) is discontinued and no longer distributed in favor of native support via spring-cloud-function. For backward compatibility you can still bring `spring-cloud-stream-reactive` from previous versions. diff --git a/docs/src/main/asciidoc/spring-cloud-stream.adoc b/docs/src/main/asciidoc/spring-cloud-stream.adoc index b99e7455b..ec3fc82b8 100644 --- a/docs/src/main/asciidoc/spring-cloud-stream.adoc +++ b/docs/src/main/asciidoc/spring-cloud-stream.adoc @@ -335,28 +335,6 @@ where you are clearly correlating the input of `uppercase` function to `sample-t For more on properties and other configuration options please see <> section. - -*Pollable Destination Binding* - -While the previously described bindings support event-based message consumption, sometimes you need more control, such as rate of consumption. - -Starting with version 2.0, you can now bind a pollable consumer: - -The following example shows how to bind a pollable consumer: - -[source, java] ----- -public interface PolledBarista { - - @Input - PollableMessageSource orders(); - . . . -} ----- - -In this case, an implementation of `PollableMessageSource` is bound to the `orders` “channel”. See <> for more details. - - [[spring-cloud-stream-overview-producing-consuming-messages]] === Producing and Consuming Messages