SpringCloud/spring-cloud-stream
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Pulsar binder docs cleanup

Browse Source
This commit is contained in:
Soby Chacko
2023-06-20 16:23:43 -04:00
parent 6b3876694e
commit 01efa99e9e
2 changed files with 2 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/src/main/asciidoc/pulsar/pulsar-binder.adoc → docs/src/main/asciidoc/pulsar/pulsar_binder.adoc
View File

@@ -1,12 +1,9 @@
[[pulsar-binder]]
= Spring Cloud Stream Binder for Apache Pulsar
include::attributes.adoc[]
Spring for Apache Pulsar provides a binder for Spring Cloud Stream that we can use to build event-driven microservices using pub-sub paradigms.
In this section, we will go through the basic details of this binder.
TIP: For those unfamiliar with the concepts in Spring Cloud Stream, go through the primary {spring-cloud-stream-docs}[reference docs] for Spring Cloud Stream to understand the core concepts.
== Usage
We need to include the following dependency on your application to use Apache Pulsar binder for Spring Cloud Stream.
@@ -191,14 +188,13 @@ This information is provided as extended binding properties.
As you can see above in the configuration, the properties are - `spring.cloud.stream.pulsar.bindings.<binding-name>.producer|consumer.schema-type` for schema information and `spring.cloud.stream.pulsar.bindings.<binding-name>.producer|consumer.message-type` for the actual target type.
If you have both keys and values on the message, you can use `message-key-type` and `message-value-type` to specify their target types.
TIP: Any configured <<pulsar.adoc#schema-info-template-imperative,custom schema mappings>> will be consulted when the `schema-type` property is omitted.
TIP: Any configured custom schema mappings will be consulted when the `schema-type` property is omitted.
=== Message Header Conversion
Each message typically has header information that needs to be carried along as the message traverses between Pulsar and Spring Messaging via Spring Cloud Stream input and output bindings.
To support this traversal, the framework handles the necessary message header conversion.
include::pulsar-header.adoc[leveloffset=+1]
https://docs.spring.io/spring-pulsar/docs/current-SNAPSHOT/reference/html/#_pulsar_headers[Pulsar Headers]
==== Custom Header Mapper
The Pulsar binder is configured with a default header mapper that can be overridden by providing your own `PulsarHeaderMapper` bean.

16
docs/src/main/asciidoc/pulsar/spring-cloud-stream-binder-pulsar.adoc
View File

@@ -1,7 +1,3 @@
// :github-tag: master
// :github-repo: spring-cloud/spring-cloud-stream
// :github-raw: https://raw.githubusercontent.com/{github-repo}/{github-tag}
// :github-code: https://github.com/{github-repo}/tree/{github-tag}
:toc: left
:toclevels: 8
:nofooter:
@@ -17,24 +13,12 @@ Soby Chacko; Chris Bono; Alexander Preuß; Jay Bryant; Christophe Bornet
:numbered:
:icons: font
:hide-uri-scheme:
// :spring-cloud-stream-binder-pulsar-repo: snapshot
// :github-tag: master
// :spring-cloud-stream-binder-pulsar-docs-version: current
// :spring-cloud-stream-binder-pulsar-docs: https://docs.spring.io/spring-cloud-stream-binder-pulsar/docs/{spring-cloud-stream-binder-pulsar-docs-version}/reference
// :spring-cloud-stream-binder-pulsar-docs-current: https://docs.spring.io/spring-cloud-stream-binder-pulsar/docs/current-SNAPSHOT/reference/html/
// :github-repo: spring-cloud/spring-cloud-stream-binder-pulsar
// :github-raw: https://raw.github.com/{github-repo}/{github-tag}
// :github-code: https://github.com/{github-repo}/tree/{github-tag}
// :github-wiki: https://github.com/{github-repo}/wiki
// :github-master-code: https://github.com/{github-repo}/tree/master
:sc-ext: java
// ======================================================================================
*{project-version}*
= Reference Guide
include::pulsar/pulsar_binder.adoc[]