Skip to content

improvement doc of --auth-params in pulsar-client cli #3605

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.

Sign up for GitHub

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 3 commits into from
Feb 22, 2019
Merged

improvement doc of --auth-params in pulsar-client cli #3605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
14448e8
improvement doc
jiazhai Feb 15, 2019
bcc9e51
change discription for jcommander
jiazhai Feb 16, 2019
05f8884
rm file diff.patch
jiazhai Feb 22, 2019
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
6 changes: 5 additions & 1 deletion pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/PulsarAdminTool.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,11 @@ public class PulsarAdminTool {
@Parameter(names = { "--auth-plugin" }, description = "Authentication plugin class name.")
String authPluginClassName = null;

@Parameter(names = { "--auth-params" }, description = "Authentication parameters, e.g., \"key1:val1,key2:val2\".")
@Parameter(
names = { "--auth-params" },
description = "Authentication parameters, whose format is determined by the implementation " +
"of method `configure` in authentication plugin class, for example \"key1:val1,key2:val2\" " +
"or \"{\"key1\":\"val1\",\"key2\":\"val2\"}.")
String authParams = null;

@Parameter(names = { "--tls-allow-insecure" }, description = "Allow TLS insecure connection")
Expand Down
6 changes: 5 additions & 1 deletion pulsar-client-tools/src/main/java/org/apache/pulsar/client/cli/PulsarClientTool.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@ public class PulsarClientTool {
@Parameter(names = { "--auth-plugin" }, description = "Authentication plugin class name.")
String authPluginClassName = null;

@Parameter(names = { "--auth-params" }, description = "Authentication parameters, e.g., \"key1:val1,key2:val2\".")
@Parameter(
names = { "--auth-params" },
description = "Authentication parameters, whose format is determined by the implementation " +
"of method `configure` in authentication plugin class, for example \"key1:val1,key2:val2\" " +
"or \"{\"key1\":\"val1\",\"key2\":\"val2\"}.")
String authParams = null;

@Parameter(names = { "-h", "--help", }, help = true, description = "Show this help.")
Expand Down
7 changes: 5 additions & 2 deletions pulsar-testclient/src/main/java/org/apache/pulsar/proxy/socket/client/PerformanceClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,11 @@ static class Arguments {
@Parameter(names = { "--auth_plugin" }, description = "Authentication plugin class name")
public String authPluginClassName;

@Parameter(names = {
"--auth_params" }, description = "Authentication parameters, e.g., \"key1:val1,key2:val2\"")
@Parameter(
names = { "--auth-params" },
description = "Authentication parameters, whose format is determined by the implementation " +
"of method `configure` in authentication plugin class, for example \"key1:val1,key2:val2\" " +
"or \"{\"key1\":\"val1\",\"key2\":\"val2\"}.")
public String authParams;

@Parameter(names = { "-m",
Expand Down
7 changes: 5 additions & 2 deletions pulsar-testclient/src/main/java/org/apache/pulsar/testclient/PerformanceConsumer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,11 @@ static class Arguments {
@Parameter(names = { "--auth_plugin" }, description = "Authentication plugin class name")
public String authPluginClassName;

@Parameter(names = {
"--auth_params" }, description = "Authentication parameters, e.g., \"key1:val1,key2:val2\"")
@Parameter(
names = { "--auth-params" },
description = "Authentication parameters, whose format is determined by the implementation " +
"of method `configure` in authentication plugin class, for example \"key1:val1,key2:val2\" " +
"or \"{\"key1\":\"val1\",\"key2\":\"val2\"}.")
public String authParams;

@Parameter(names = {
Expand Down
7 changes: 5 additions & 2 deletions pulsar-testclient/src/main/java/org/apache/pulsar/testclient/PerformanceProducer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,11 @@ static class Arguments {
@Parameter(names = { "--auth_plugin" }, description = "Authentication plugin class name")
public String authPluginClassName;

@Parameter(names = {
"--auth_params" }, description = "Authentication parameters, e.g., \"key1:val1,key2:val2\"")
@Parameter(
names = { "--auth-params" },
description = "Authentication parameters, whose format is determined by the implementation " +
"of method `configure` in authentication plugin class, for example \"key1:val1,key2:val2\" " +
"or \"{\"key1\":\"val1\",\"key2\":\"val2\"}.")
public String authParams;

@Parameter(names = { "-o", "--max-outstanding" }, description = "Max number of outstanding messages")
Expand Down
7 changes: 5 additions & 2 deletions pulsar-testclient/src/main/java/org/apache/pulsar/testclient/PerformanceReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,11 @@ static class Arguments {
@Parameter(names = { "--auth-plugin" }, description = "Authentication plugin class name")
public String authPluginClassName;

@Parameter(names = {
"--auth-params" }, description = "Authentication parameters, e.g., \"key1:val1,key2:val2\"")
@Parameter(
names = { "--auth-params" },
description = "Authentication parameters, whose format is determined by the implementation " +
"of method `configure` in authentication plugin class, for example \"key1:val1,key2:val2\" " +
"or \"{\"key1\":\"val1\",\"key2\":\"val2\"}.")
public String authParams;

@Parameter(names = {
Expand Down
2 changes: 1 addition & 1 deletion site2/docs/reference-cli-tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ Commands
Options
|Flag|Description|Default|
|---|---|---|
|`--auth-params`|Authentication parameters, for example key1:val1,key2:val2||
|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{\"key1\":\"val1\",\"key2\":\"val2\"}"||
Copy link
Contributor

Choose a reason for hiding this comment

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

We should also fix the same description in the JCommander help string that is shown when using the tool

|`--auth-plugin`|Authentication plugin class name||
|`--url`|Broker URL to which to connect|pulsar://localhost:6650/|

Expand Down
2 changes: 1 addition & 1 deletion site2/website/versioned_docs/version-2.1.0-incubating/reference-cli-tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ Commands
Options
|Flag|Description|Default|
|---|---|---|
|`--auth-params`|Authentication parameters, for example key1:val1,key2:val2||
|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{\"key1\":\"val1\",\"key2\":\"val2\"}" ||
|`--auth-plugin`|Authentication plugin class name||
|`--url`|Broker URL to which to connect|pulsar://localhost:6650/|

Expand Down