Skip to content

Editing pass #199

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

Merged
merged 1 commit into from
Nov 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
[[appendix.application-properties]]
= Application Properties

Various properties can be specified inside your `application.properties` file, inside your `application.yml` file, or as command line switches.
You can specify various properties inside your `application.properties` file, inside your `application.yml` file, or as command line switches.
This appendix provides a list of Spring Pulsar properties and references to the underlying classes that consume them.

TIP: Spring Boot provides various conversion mechanism with advanced value formatting, make sure to review <<features#features.external-config.typesafe-configuration-properties.conversion, the properties conversion section>>.
TIP: Spring Boot provides various conversion mechanisms with advanced value formatting. See <<features#features.external-config.typesafe-configuration-properties.conversion, the properties conversion section>> for more detail.

NOTE: Property contributions can come from additional jar files on your classpath, so you should not consider this an exhaustive list.
NOTE: Property contributions can come from additional jar files on your classpath, so this list is not exhaustive.
Also, you can define your own properties.

include::application-properties/pulsar-client.adoc[]
Expand Down
9 changes: 5 additions & 4 deletions spring-pulsar-docs/src/main/asciidoc/authentication.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
To connect to a Pulsar cluster requiring authentication, you need to set the `authPluginClassName` and any parameters required by the authentication plugin. The parameters can be set as a single JSON encoded string or as map of parameter names to parameter values.
To connect to a Pulsar cluster that requires authentication, you need to set the `authPluginClassName` and any parameters required by the authentication plugin. You can set the parameters as a single JSON-encoded string or as map of parameter names to parameter values. The following listings show both approaches:

[source,yaml,indent=0,role="primary"]
.[.small]#Map#
Expand All @@ -12,6 +12,7 @@ spring:
private-key: file:///Users/some-key.json
audience: urn:sn:acme:dev:my-instance
----

.[.small]#JSON encoded string#
[source,yaml,indent=0,role="secondary"]
----
Expand All @@ -22,9 +23,9 @@ spring:
auth-params: "{\"privateKey\":\"file:///Users/some-key.json\",\"issuerUrl\":\"https://auth.server.cloud/", \"audience\":\"urn:sn:acme:dev:my-instance"}"
----

TIP: Using a map is the recommended approach as it is less error-prone and easier to read
TIP: Using a map is the recommended approach as it is less error-prone and easier to read.

The following shows how to configure each of the supported authentication mechanisms.
The following listings show how to configure each of the supported authentication mechanisms.

[[Athenz]]
.[.underline]#Click ##here## for **Athenz**#
Expand Down Expand Up @@ -131,4 +132,4 @@ spring:
====


NOTE: [.small]#More information on each of the schemes and their required properties can be found in the official link:https://pulsar.apache.org/docs/security-overview#authentication-providers[Pulsar security] documentation.#
NOTE: You can find more information on each of the schemes and their required properties in the official link:https://pulsar.apache.org/docs/security-overview#authentication-providers[Pulsar security] documentation.
4 changes: 2 additions & 2 deletions spring-pulsar-docs/src/main/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
:numbered:
:icons: font
:hide-uri-scheme:
Soby Chacko; Chris Bono; Alexander Preuß
Soby Chacko; Chris Bono; Alexander Preuß; Jay Bryant

//ifdef::backend-html5[]
//*{project-version}*
Expand All @@ -28,7 +28,7 @@ include::preface.adoc[]
[[quick-intro]]
== Introduction

This first part of the reference documentation is a high-level quick-tour of Spring for Apache Pulsar.
This first part of the reference documentation is a high-level quick tour of Spring for Apache Pulsar.

include::quick-tour.adoc[]

Expand Down
4 changes: 2 additions & 2 deletions spring-pulsar-docs/src/main/asciidoc/preface.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This project provides a basic Spring-friendly API for developing https://pulsar.apache.org/[Apache Pulsar] applications.

On a very high-level, Spring for Apache Pulsar provides a `PulsarTemplate` for publishing to a Pulsar topic and a `PulsarListener` annotation for consuming from it.
In addition, it also provides various convenient APIs for Spring developers to ramp up their development journey into Apache Pulsar.
On a very high level, Spring for Apache Pulsar provides a `PulsarTemplate` for publishing to a Pulsar topic and a `PulsarListener` annotation for consuming from a Pulsar topic.
In addition, it also provides various convenience APIs for Spring developers to ramp up their development journey into Apache Pulsar.
Loading