Skip to content
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

Fix java doc for MultipleListenerValidator #12389

Merged
merged 2 commits into from
Oct 18, 2021

Conversation

tomscut
Copy link
Contributor

@tomscut tomscut commented Oct 15, 2021

Motivation

Fix the java doc mentioned in #12353

Modifications

Fix java doc for MultipleListenerValidator#validateAndAnalysisAdvertisedListener.

Does this pull request potentially affect one of the following parts:

If yes was chosen, please highlight the changes

  • Dependencies (does it add or upgrade a dependency): (yes / no)
  • The public API: (no)
  • The schema: (no)
  • The default values of configurations: (no)
  • The wire protocol: (no)
  • The rest endpoints: (no)
  • The admin cli options: (no)
  • Anything that affects deployment: (no)

Documentation

Check the box below and label this PR (if you have committer privilege).

Need to update docs?

  • doc-required
  • no-need-doc
  • doc

Copy link
Contributor

@EronWright EronWright left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for not updating the javadoc earlier.

Comment on lines 42 to 45
* 1. the listener name in `advertisedListeners` must not duplicate.
* 2. user can not assign same 'host:port' to different listener.
* 3. if `internalListenerName` is absent, the first `listener` in the `advertisedListeners` will be the `internalListenerName`.
* 4. if pulsar do not specify `brokerServicePortTls`, should only contain one entry of `pulsar://` per listener name.
Copy link
Contributor

@EronWright EronWright Oct 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that (4) is obsolete.

May I suggest:

  1. advertisedListeners consists of a comma-separated list of endpoints.
  2. Each endpoint consists of a listener name and an associated address (listener:scheme://host:port).
  3. A listener name may be repeated to define both a non-TLS and a TLS endpoint.
  4. Duplicate definitions are disallowed.
  5. If internalListenerName is absent, set it to the first listener defined in advertisedListeners.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for not updating the content of the document. Thanks @EronWright for your suggestion. I fixed it. PTAL. Thanks.

Copy link
Contributor

@eolivelli eolivelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@EronWright would you like to review?

@tomscut
Copy link
Contributor Author

tomscut commented Oct 17, 2021

Thanks @eolivelli @EronWright for your review.

@codelipenghui codelipenghui added this to the 2.9.0 milestone Oct 18, 2021
@codelipenghui codelipenghui merged commit 9d10b8b into apache:master Oct 18, 2021
@codelipenghui codelipenghui modified the milestones: 2.9.0, 2.10.0 Oct 18, 2021
@tomscut
Copy link
Contributor Author

tomscut commented Oct 18, 2021

Thanks @codelipenghui for your review and merge.

zeo1995 pushed a commit to zeo1995/pulsar that referenced this pull request Oct 20, 2021
* up/master:
  [pulsar-java-client] Auto-recovery after exception like out of direct memory (apache#12170)
  Allow to config pulsar client allocator out of memory policy (apache#12200)
  [Transaction] Fix bugs, Exception thrower by TB::appendBufferToTxn must be ManagedLedgerException.  (apache#12376)
  Bumped version to 2.10.0-SNAPSHOT (apache#12285)
  [docs][Website] add docs of broker entry metadata (apache#12404)
  [C++] Use weak ref to ClientConnection for timeout task (apache#12409)
  fix windows test path probleam (apache#12398)
  [website][upgrade]feat: home page (apache#12383)
  [docs] [ISSUE 11526] Update the description of `topic` (apache#12375)
  [Docs] Add document label check robot (apache#12371)
  [Admin] Get schema validation enforce add applied. (apache#12349)
  [Doc] add scope explanations (apache#12380)
  Fix java doc for MultipleListenerValidator (apache#12389)
zeo1995 pushed a commit to zeo1995/pulsar that referenced this pull request Oct 20, 2021
….2-chapter-4

* website/branch-2.7.2-chapter-3:
  Update the nesting of forms in the document
  [pulsar-java-client] Auto-recovery after exception like out of direct memory (apache#12170)
  Allow to config pulsar client allocator out of memory policy (apache#12200)
  [Transaction] Fix bugs, Exception thrower by TB::appendBufferToTxn must be ManagedLedgerException.  (apache#12376)
  Bumped version to 2.10.0-SNAPSHOT (apache#12285)
  [docs][Website] add docs of broker entry metadata (apache#12404)
  [C++] Use weak ref to ClientConnection for timeout task (apache#12409)
  fix windows test path probleam (apache#12398)
  [website][upgrade]feat: home page (apache#12383)
  [docs] [ISSUE 11526] Update the description of `topic` (apache#12375)
  [Docs] Add document label check robot (apache#12371)
  [Admin] Get schema validation enforce add applied. (apache#12349)
  [Doc] add scope explanations (apache#12380)
  Fix java doc for MultipleListenerValidator (apache#12389)
@codelipenghui codelipenghui added the cherry-picked/branch-2.9 Archived: 2.9 is end of life label Dec 20, 2021
codelipenghui pushed a commit that referenced this pull request Dec 20, 2021
### Motivation

*Fix the java doc mentioned in [#12353](https://github.com/apache/pulsar/pull/12353/files#r729887373)*

### Modifications

*Fix java doc for MultipleListenerValidator#validateAndAnalysisAdvertisedListener.*

(cherry picked from commit 9d10b8b)
@gaoran10 gaoran10 added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Jan 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherry-picked/branch-2.9 Archived: 2.9 is end of life doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. release/2.9.2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants