You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by GitBox <gi...@apache.org> on 2020/08/04 22:33:35 UTC
[GitHub] [kafka] cmccabe commented on a change in pull request #9032: KAFKA-10259: KIP-554 Broker-side SCRAM Config API
cmccabe commented on a change in pull request #9032:
URL: https://github.com/apache/kafka/pull/9032#discussion_r465367407
##########
File path: clients/src/main/java/org/apache/kafka/clients/admin/Admin.java
##########
@@ -1214,6 +1215,60 @@ default AlterClientQuotasResult alterClientQuotas(Collection<ClientQuotaAlterati
*/
AlterClientQuotasResult alterClientQuotas(Collection<ClientQuotaAlteration> entries, AlterClientQuotasOptions options);
+ /**
+ * <p>Describe all SASL/SCRAM credentials.
+ *
+ * <p>This is a convenience method for {@link #describeUserScramCredentials(List, DescribeUserScramCredentialsOptions)}
+ *
+ * @return The DescribeUserScramCredentialsResult.
+ */
+ default DescribeUserScramCredentialsResult describeUserScramCredentials() {
+ return describeUserScramCredentials(null, new DescribeUserScramCredentialsOptions());
+ }
+
+ /**
+ * <p>Describe SASL/SCRAM credentials for the given users.
+ *
+ * <p>This is a convenience method for {@link #describeUserScramCredentials(List, DescribeUserScramCredentialsOptions)}
+ *
+ * @param users the users for which credentials are to be described; all users' credentials are described if null or empty
+ * @return The DescribeUserScramCredentialsResult.
+ */
+ default DescribeUserScramCredentialsResult describeUserScramCredentials(List<String> users) {
+ return describeUserScramCredentials(users, new DescribeUserScramCredentialsOptions());
+ }
+
+ /**
+ * <p>Describe SASL/SCRAM credentials.
+ *
+ * @param users the users for which credentials are to be described; all users' credentials are described if null or empty
Review comment:
It would be good to document here that users that are specified but not present will be silently omitted from the result
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org