You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Spring Pulsar is released under the Apache 2.0 license. If you would like to contribute something, or want to hack on the code this document should help you get started.
5
+
Spring for Apache Pulsar is released under the Apache 2.0 license. If you would like to contribute something, or want to hack on the code this document should help you get started.
6
6
7
7
8
8
@@ -23,7 +23,7 @@ Ideally, that would include a small sample project that reproduces the problem.
23
23
24
24
25
25
== Reporting Security Vulnerabilities
26
-
If you think you have found a security vulnerability in Spring Pulsar please *DO NOT* disclose it publicly until we've had a chance to fix it.
26
+
If you think you have found a security vulnerability in Spring for Apache Pulsar please *DO NOT* disclose it publicly until we've had a chance to fix it.
27
27
Please don't report security vulnerabilities using GitHub issues, instead head over to https://spring.io/security-policy and learn how to disclose them responsibly.
The {docs}/html/[reference documentation] includes a {docs}/html/#quick-tourhtml[quick tour] section.
13
13
14
14
== Getting Help
15
-
Are you having trouble with Spring Pulsar? We want to help!
15
+
Are you having trouble with Spring for Apache Pulsar? We want to help!
16
16
17
17
* Check the {docs}/html/[reference documentation]
18
-
* Learn the Spring basics -- Spring Pulsar builds on many other Spring projects; check the https://spring.io[spring.io] website for a wealth of reference documentation.
18
+
* Learn the Spring basics -- Spring for Apache Pulsar builds on many other Spring projects; check the https://spring.io[spring.io] website for a wealth of reference documentation.
19
19
If you are new to Spring, try one of the https://spring.io/guides[guides].
20
20
// TODO (NYI): * If you are upgrading, read the {github}/wiki[release notes] for upgrade instructions and "new and noteworthy" features.
21
21
* Ask a question -- we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-pulsar[`spring-pulsar`].
22
-
* Report bugs with Spring Pulsar at {github}/issues[github.com/spring-projects/spring-pulsar/issues].
22
+
* Report bugs with Spring for Apache Pulsar at {github}/issues[github.com/spring-projects/spring-pulsar/issues].
23
23
24
24
25
25
26
26
== Reporting Issues
27
-
Spring Pulsar uses GitHub's integrated issue tracking system to record bugs and feature requests.
27
+
Spring for Apache Pulsar uses GitHub's integrated issue tracking system to record bugs and feature requests.
28
28
If you want to raise an issue, please follow the recommendations below:
29
29
30
30
* Before you log a bug, please search the {github}/issues[issue tracker] to see if someone has already reported the problem.
31
31
* If the issue doesn't already exist, {github}/issues/new[create a new issue].
32
32
* Please provide as much information as possible with the issue report.
33
-
We like to know the Spring Pulsar version, operating system, and JVM version you're using.
33
+
We like to know the Spring for Apache Pulsar version, operating system, and JVM version you're using.
34
34
* If you need to paste code or include a stack trace, use Markdown +++```+++ escapes before and after your text.
35
35
* If possible, try to create a test case or project that replicates the problem and attach it to the issue.
36
36
37
37
38
38
39
39
== Building from Source
40
-
You don't need to build from source to use Spring Pulsar (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring Pulsar can be built and published to your local Maven cache using the https://docs.gradle.org/current/userguide/gradle_wrapper.html[Gradle wrapper].
40
+
You don't need to build from source to use Spring for Apache Pulsar (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring for Apache Pulsar can be built and published to your local Maven cache using the https://docs.gradle.org/current/userguide/gradle_wrapper.html[Gradle wrapper].
41
41
You also need JDK 17.
42
42
43
43
[source,shell]
@@ -74,7 +74,7 @@ If you want skip tests, use the `-x test` and/or `-x integrationTest` options:
74
74
----
75
75
76
76
== Modules
77
-
There are several modules in Spring Pulsar. Here is a quick overview:
77
+
There are several modules in Spring for Apache Pulsar. Here is a quick overview:
78
78
79
79
=== spring-pulsar
80
80
The main library that provides the API to access Apache Pulsar.
Provides the API to access Apache Pulsar using a Reactive client.
96
96
97
97
=== spring-pulsar-sample-apps
98
-
Provides sample applications to illustrate Spring Pulsar functionality as well as provide ability for quick manual verification during development.
98
+
Provides sample applications to illustrate Spring for Apache Pulsar functionality as well as provide ability for quick manual verification during development.
99
99
100
100
101
101
== License
102
-
Spring Pulsar is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].
102
+
Spring for Apache Pulsar is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].
Copy file name to clipboardExpand all lines: spring-pulsar-docs/src/main/asciidoc/observability.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -91,6 +91,6 @@ The `tracing.endpoint` above expects Zipkin is running locally as described http
91
91
92
92
At this point, your application should record traces when you send and receive Pulsar messages. You should be able to view them in the Zipkin UI (at http://localhost:9411, when running locally).
93
93
94
-
TIP: You can also see the preceding configuration on the link:{github}/blob/main/spring-pulsar-sample-apps/README.adoc[Spring Pulsar Sample Apps].
94
+
TIP: You can also see the preceding configuration on the link:{github}/blob/main/spring-pulsar-sample-apps/README.adoc[Spring for Apache Pulsar Sample Apps].
95
95
96
96
The steps are very similar to configuring any of the other supported Tracing environments.
In the preceding example, we consume the data as a `List<String>`.
586
586
When extracting the various headers, we do so as a `List<>` as well.
587
-
Spring Pulsar ensures that the headers list corresponds to the data list.
587
+
Spring for Apache Pulsar ensures that the headers list corresponds to the data list.
588
588
589
589
You can also extract headers in the same manner when you use the batch listener and receive payloads as `List<org.apache.pulsar.client.api.Message<?>`, `org.apache.pulsar.client.api.Messages<?>`, or `org.springframework.messaging.Messsge<?>`.
Copy file name to clipboardExpand all lines: spring-pulsar-docs/src/main/asciidoc/schema-info/schema-info-listener.adoc
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
== Specifying Schema Information
2
2
3
-
As indicated earlier, for Java primitives, the Spring Pulsar framework can infer the proper Schema to use on the `{listener-class}`.
4
-
For non-primitive types, if the Schema is not explicitly specified on the annotation, the Spring Pulsar framework will try to build a `Schema.JSON` from the type.
3
+
As indicated earlier, for Java primitives, the Spring for Apache Pulsar framework can infer the proper Schema to use on the `{listener-class}`.
4
+
For non-primitive types, if the Schema is not explicitly specified on the annotation, the Spring for Apache Pulsar framework will try to build a `Schema.JSON` from the type.
5
5
6
6
IMPORTANT: Complex Schema types that are currently supported are JSON, AVRO, PROTOBUF, and KEY_VALUE w/ INLINE encoding.
Copy file name to clipboardExpand all lines: spring-pulsar-docs/src/main/asciidoc/schema-info/schema-info-template.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
== Specifying Schema Information
2
2
If you use Java primitive types, the framework auto-detects the schema for you, and you need not specify any schema types for publishing the data.
3
-
For non-primitive types, if the Schema is not explicitly specified when invoking send operations on the `{template-class}`, the Spring Pulsar framework will try to build a `Schema.JSON` from the type.
3
+
For non-primitive types, if the Schema is not explicitly specified when invoking send operations on the `{template-class}`, the Spring for Apache Pulsar framework will try to build a `Schema.JSON` from the type.
4
4
5
5
IMPORTANT: Complex Schema types that are currently supported are JSON, AVRO, PROTOBUF, and KEY_VALUE w/ INLINE encoding.
0 commit comments