apache#4873 support list group add javaDoc

LiuQhahah · Sep 26, 2024 · 2e24f4b · 2e24f4b
1 parent ed9cc9d
commit 2e24f4b
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/clients/client-java/src/main/java/org/apache/gravitino/client/GravitinoClient.java b/clients/client-java/src/main/java/org/apache/gravitino/client/GravitinoClient.java
@@ -228,10 +228,20 @@ public Group getGroup(String group) throws NoSuchGroupException, NoSuchMetalakeE
   }
 
 
+  /**
+   * List the groups.
+   * @return The Group list
+   * @throws NoSuchMetalakeException If the Metalake with the given name does not exist.
+   */
   public Group[] listGroups(){
     return getMetalake().listGroups();
   }
 
+  /**
+   * List the group names.
+   * @return The group names list.
+   * @throws NoSuchMetalakeException If the Metalake with the given name does not exist.
+   */
   public String[] listGroupNames(){
     return getMetalake().listGroupNames();
   }

diff --git a/clients/client-java/src/main/java/org/apache/gravitino/client/GravitinoMetalake.java b/clients/client-java/src/main/java/org/apache/gravitino/client/GravitinoMetalake.java
@@ -629,6 +629,7 @@ public Group getGroup(String group) throws NoSuchGroupException, NoSuchMetalakeE
    * Lists the groups
    *
    * @return The Group list
+   * @throws NoSuchMetalakeException If the Metalake with the given name does not exist.
    */
   public Group[] listGroups() {
     Map<String,String> params = new HashMap<>();
@@ -648,6 +649,7 @@ public Group[] listGroups() {
    * Lists the group names
    *
    * @return The Group Name List
+   * @throws NoSuchMetalakeException If the Metalake with the given name does not exist.
    */
   public String[] listGroupNames(){
     NameListResponse resp = restClient.get(

diff --git a/core/src/main/java/org/apache/gravitino/authorization/AccessControlDispatcher.java b/core/src/main/java/org/apache/gravitino/authorization/AccessControlDispatcher.java
@@ -130,10 +130,19 @@ Group getGroup(String metalake, String group)
   /**
    * List groups
    *
+   * @param metalake The Metalake of the Group.
    * @return The list of groups
+   * @throws NoSuchMetalakeException If the Metalake with the given name does not exist.
    */
   Group[] listGroup(String metalake);
 
+  /**
+   * List group names
+   *
+   * @param metalake The Metalake of the Group.
+   * @return The list of group names
+   * @throws NoSuchMetalakeException If the Metalake with the given name does not exist.
+   */
   String[] listGroupNames(String metalake);
 
   /**