feat: add async entrypoint

Author: bevzzz

src/it/java/io/weaviate/integration/RbacITest.java

@@ -80,7 +80,7 @@ public void test_roles_Lifecycle() throws IOException {
     client.roles.create(nsRole, permissions);
 
     var role = client.roles.get(nsRole);
-    Assertions.assertThat(role)
+    Assertions.assertThat(role).get()
         .as("created role")
         .returns(nsRole, Role::name)
         .extracting(Role::permissions, InstanceOfAssertFactories.list(Permission.class))

src/main/java/io/weaviate/client6/v1/api/WeaviateClientAsync.java

@@ -7,6 +7,9 @@
 import io.weaviate.client6.v1.api.alias.WeaviateAliasClientAsync;
 import io.weaviate.client6.v1.api.collections.WeaviateCollectionsClient;
 import io.weaviate.client6.v1.api.collections.WeaviateCollectionsClientAsync;
+import io.weaviate.client6.v1.api.rbac.groups.WeaviateGroupsClientAsync;
+import io.weaviate.client6.v1.api.rbac.roles.WeaviateRolesClientAsync;
+import io.weaviate.client6.v1.api.rbac.users.WeaviateUsersClientAsync;
 import io.weaviate.client6.v1.internal.ObjectBuilder;
 import io.weaviate.client6.v1.internal.TokenProvider;
 import io.weaviate.client6.v1.internal.grpc.DefaultGrpcTransport;
@@ -30,6 +33,21 @@ public class WeaviateClientAsync implements AutoCloseable {
   /** Client for {@code /aliases} endpoints for managing collection aliases. */
   public final WeaviateAliasClientAsync alias;
 
+  /**
+   * Client for {@code /authz/roles} endpoints for managing RBAC roles.
+   */
+  public final WeaviateRolesClientAsync roles;
+
+  /**
+   * Client for {@code /authz/groups} endpoints for managing RBAC groups.
+   */
+  public final WeaviateGroupsClientAsync groups;
+
+  /**
+   * Client for {@code /users} endpoints for managing DB / OIDC users.
+   */
+  public final WeaviateUsersClientAsync users;
+
   /**
    * This constructor is blocking if {@link Authentication} configured,
    * as the client will need to do the initial token exchange.
@@ -84,6 +102,9 @@ public WeaviateClientAsync(Config config) {
     this.restTransport = _restTransport;
     this.grpcTransport = new DefaultGrpcTransport(grpcOpt);
     this.alias = new WeaviateAliasClientAsync(restTransport);
+    this.roles = new WeaviateRolesClientAsync(restTransport);
+    this.groups = new WeaviateGroupsClientAsync(restTransport);
+    this.users = new WeaviateUsersClientAsync(restTransport);
     this.collections = new WeaviateCollectionsClientAsync(restTransport, grpcTransport);
   }
 

src/main/java/io/weaviate/client6/v1/api/rbac/groups/WeaviateGroupsClientAsync.java

@@ -0,0 +1,68 @@
+package io.weaviate.client6.v1.api.rbac.groups;
+
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.List;
+import java.util.concurrent.CompletableFuture;
+import java.util.function.Function;
+
+import io.weaviate.client6.v1.api.rbac.Role;
+import io.weaviate.client6.v1.internal.ObjectBuilder;
+import io.weaviate.client6.v1.internal.rest.RestTransport;
+
+public class WeaviateGroupsClientAsync {
+  private final RestTransport restTransport;
+
+  public WeaviateGroupsClientAsync(RestTransport restTransport) {
+    this.restTransport = restTransport;
+  }
+
+  /**
+   * Get the roles assigned an OIDC group.
+   *
+   * @param groupId OIDC group ID.
+   */
+  public CompletableFuture<List<Role>> assignedRoles(String groupId) {
+    return this.restTransport.performRequestAsync(GetAssignedRolesRequest.of(groupId),
+        GetAssignedRolesRequest._ENDPOINT);
+  }
+
+  /**
+   * Get the roles assigned an OIDC group.
+   *
+   * @param groupId OIDC group ID.
+   * @param fn      Lambda expression for optional parameters.
+   */
+  public CompletableFuture<List<Role>> assignedRoles(String groupId,
+      Function<GetAssignedRolesRequest.Builder, ObjectBuilder<GetAssignedRolesRequest>> fn) {
+    return this.restTransport.performRequestAsync(GetAssignedRolesRequest.of(groupId, fn),
+        GetAssignedRolesRequest._ENDPOINT);
+  }
+
+  /** Get the names of known OIDC groups. */
+  public CompletableFuture<List<String>> knownGroupNames() {
+    return this.restTransport.performRequestAsync(null, GetKnownGroupNamesRequest._ENDPOINT);
+  }
+
+  /**
+   * Assign roles to OIDC group.
+   *
+   * @param groupId   OIDC group ID.
+   * @param roleNames Role names.
+   */
+  public CompletableFuture<Void> assignRoles(String groupId, String... roleNames) {
+    return this.restTransport.performRequestAsync(new AssignRolesRequest(groupId, Arrays.asList(roleNames)),
+        AssignRolesRequest._ENDPOINT);
+  }
+
+  /**
+   * Revoke roles from OIDC group.
+   *
+   * @param groupId   OIDC group ID.
+   * @param roleNames Role names.
+   */
+  public CompletableFuture<Void> revokeRoles(String groupId, String... roleNames) {
+    return this.restTransport.performRequestAsync(new RevokeRolesRequest(groupId, Arrays.asList(roleNames)),
+        RevokeRolesRequest._ENDPOINT);
+  }
+}

src/main/java/io/weaviate/client6/v1/api/rbac/roles/GetRoleRequest.java

@@ -1,15 +1,16 @@
 package io.weaviate.client6.v1.api.rbac.roles;
 
 import java.util.Collections;
+import java.util.Optional;
 
 import io.weaviate.client6.v1.api.rbac.Role;
 import io.weaviate.client6.v1.internal.json.JSON;
 import io.weaviate.client6.v1.internal.rest.Endpoint;
-import io.weaviate.client6.v1.internal.rest.SimpleEndpoint;
+import io.weaviate.client6.v1.internal.rest.OptionalEndpoint;
 import io.weaviate.client6.v1.internal.rest.UrlEncoder;
 
 public record GetRoleRequest(String roleName) {
-  public static final Endpoint<GetRoleRequest, Role> _ENDPOINT = SimpleEndpoint.noBody(
+  public static final Endpoint<GetRoleRequest, Optional<Role>> _ENDPOINT = OptionalEndpoint.noBodyOptional(
       __ -> "GET",
       request -> "/authz/roles/" + UrlEncoder.encodeValue(request.roleName),
       __ -> Collections.emptyMap(),

src/main/java/io/weaviate/client6/v1/api/rbac/roles/WeaviateRolesClient.java

@@ -3,6 +3,7 @@
 import java.io.IOException;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Optional;
 
 import io.weaviate.client6.v1.api.WeaviateApiException;
 import io.weaviate.client6.v1.api.rbac.Permission;
@@ -56,7 +57,7 @@ public boolean exists(String roleName) throws IOException {
    *                              due to a malformed request, a networking error
    *                              or the server being unavailable.
    */
-  public Role get(String roleName) throws IOException {
+  public Optional<Role> get(String roleName) throws IOException {
     return this.restTransport.performRequest(new GetRoleRequest(roleName), GetRoleRequest._ENDPOINT);
   }
 

src/main/java/io/weaviate/client6/v1/api/rbac/roles/WeaviateRolesClientAsync.java

@@ -0,0 +1,129 @@
+package io.weaviate.client6.v1.api.rbac.roles;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
+
+import io.weaviate.client6.v1.api.rbac.Permission;
+import io.weaviate.client6.v1.api.rbac.Role;
+import io.weaviate.client6.v1.internal.rest.RestTransport;
+
+public class WeaviateRolesClientAsync {
+  private final RestTransport restTransport;
+
+  public WeaviateRolesClientAsync(RestTransport restTransport) {
+    this.restTransport = restTransport;
+  }
+
+  /**
+   * Create a new role.
+   *
+   * @param roleName    Role name.
+   * @param permissions Permissions granted to the role.
+   */
+  public CompletableFuture<Void> create(String roleName, Permission... permissions) {
+    var role = new Role(roleName, permissions);
+    return this.restTransport.performRequestAsync(new CreateRoleRequest(role), CreateRoleRequest._ENDPOINT);
+  }
+
+  /**
+   * Check if a role with a given name exists.
+   *
+   * @param roleName Role name.
+   */
+  public CompletableFuture<Boolean> exists(String roleName) {
+    return this.restTransport.performRequestAsync(new RoleExistsRequest(roleName), RoleExistsRequest._ENDPOINT);
+  }
+
+  /**
+   * Fetch role definition.
+   *
+   * @param roleName Role name.
+   */
+  public CompletableFuture<Optional<Role>> get(String roleName) {
+    return this.restTransport.performRequestAsync(new GetRoleRequest(roleName), GetRoleRequest._ENDPOINT);
+  }
+
+  /** List all existing roles. */
+  public CompletableFuture<List<Role>> list() {
+    return this.restTransport.performRequestAsync(null, ListRolesRequest._ENDPOINT);
+  }
+
+  /**
+   * Delete a role.
+   *
+   * @param roleName Role name.
+   */
+  public CompletableFuture<Void> delete(String roleName) {
+    return this.restTransport.performRequestAsync(new DeleteRoleRequest(roleName), DeleteRoleRequest._ENDPOINT);
+  }
+
+  /**
+   * Add permissions to a role.
+   *
+   * @param roleName    Role name.
+   * @param permissions Permissions to add to the role.
+   */
+  public CompletableFuture<Void> addPermissions(String roleName, Permission... permissions) {
+    return this.restTransport.performRequestAsync(new AddPermissionsRequest(roleName, Arrays.asList(permissions)),
+        AddPermissionsRequest._ENDPOINT);
+  }
+
+  /**
+   * Remove permissions from a role.
+   *
+   * @param roleName    Role name.
+   * @param permissions Permissions to remove from the role.
+   */
+  public CompletableFuture<Void> removePermissions(String roleName, Permission... permissions) {
+    return this.restTransport.performRequestAsync(new RemovePermissionsRequest(roleName, Arrays.asList(permissions)),
+        RemovePermissionsRequest._ENDPOINT);
+  }
+
+  /**
+   * Check if a role has a set of permissions.
+   *
+   * @param roleName   Role name.
+   * @param permission Permission to check.
+   */
+  public CompletableFuture<Boolean> hasPermission(String roleName, Permission permission) {
+    return this.restTransport.performRequestAsync(new HasPermissionRequest(roleName, permission),
+        HasPermissionRequest._ENDPOINT);
+  }
+
+  /**
+   * Get IDs of all users this role is assigned to.
+   *
+   * @param roleName Role name.
+   */
+  public CompletableFuture<List<String>> assignedUserIds(String roleName) {
+    return this.restTransport.performRequestAsync(new GetAssignedUsersRequest(roleName),
+        GetAssignedUsersRequest._ENDPOINT);
+  }
+
+  /**
+   * Get IDs of all users this role is assigned to along with their user type.
+   *
+   * <p>
+   * Note that, unlike {@link #assignedUserIds}, this method MAY return multiple
+   * entries for the same user ID if OIDCS authentication is enabled: once with
+   * "db_*" and another time with "oidc" user type.
+   *
+   * @param roleName Role name.
+   */
+  public CompletableFuture<List<UserAssignment>> userAssignments(String roleName) {
+    return this.restTransport.performRequestAsync(new GetUserAssignementsRequest(roleName),
+        GetUserAssignementsRequest._ENDPOINT);
+  }
+
+  /**
+   * Get IDs of all groups this role is assigned to along with their group type.
+   *
+   * @param roleName Role name.
+   */
+  public CompletableFuture<List<GroupAssignment>> groupAssignments(String roleName) {
+    return this.restTransport.performRequestAsync(new GetGroupAssignementsRequest(roleName),
+        GetGroupAssignementsRequest._ENDPOINT);
+  }
+}

src/main/java/io/weaviate/client6/v1/api/rbac/users/DbUsersClientAsync.java

@@ -0,0 +1,101 @@
+package io.weaviate.client6.v1.api.rbac.users;
+
+import java.io.IOException;
+import java.util.List;
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
+import java.util.function.Function;
+
+import io.weaviate.client6.v1.internal.ObjectBuilder;
+import io.weaviate.client6.v1.internal.rest.RestTransport;
+
+public class DbUsersClientAsync extends NamespacedUsersClientAsync {
+
+  public DbUsersClientAsync(RestTransport restTransport) {
+    super(restTransport, UserType.DB_USER);
+  }
+
+  /**
+   * Create a new "db" user.
+   *
+   * @param userId User ID.
+   */
+  public CompletableFuture<Void> create(String userId) throws IOException {
+    return this.restTransport.performRequestAsync(new CreateDbUserRequest(userId), CreateDbUserRequest._ENDPOINT);
+  }
+
+  /**
+   * Delete a "db" user.
+   *
+   * @param userId User ID.
+   */
+  public CompletableFuture<Void> delete(String userId) throws IOException {
+    return this.restTransport.performRequestAsync(new DeleteDbUserRequest(userId), DeleteDbUserRequest._ENDPOINT);
+  }
+
+  /**
+   * Activate a "db" user.
+   *
+   * @param userId User ID.
+   */
+  public CompletableFuture<Void> activate(String userId) throws IOException {
+    return this.restTransport.performRequestAsync(new ActivateDbUserRequest(userId), ActivateDbUserRequest._ENDPOINT);
+  }
+
+  /**
+   * Deactivate a "db" user.
+   *
+   * @param userId User ID.
+   */
+  public CompletableFuture<Void> deactivate(String userId) throws IOException {
+    return this.restTransport.performRequestAsync(new DeactivateDbUserRequest(userId),
+        DeactivateDbUserRequest._ENDPOINT);
+  }
+
+  /**
+   * Rotate API key of the "db" user.
+   *
+   * @param userId User ID.
+   */
+  public CompletableFuture<String> rotateKey(String userId) throws IOException {
+    return this.restTransport.performRequestAsync(new RotateDbUserKeyRequest(userId), RotateDbUserKeyRequest._ENDPOINT);
+  }
+
+  /**
+   * Fetch "db" user info.
+   *
+   * @param userId User ID.
+   */
+  public CompletableFuture<Optional<DbUser>> byName(String userId) throws IOException {
+    return this.restTransport.performRequestAsync(GetDbUserRequest.of(userId), GetDbUserRequest._ENDPOINT);
+  }
+
+  /**
+   * Fetch "db" user info.
+   *
+   * @param userId User ID.
+   * @param fn     Lambda expression for optional parameters.
+   */
+  public CompletableFuture<Optional<DbUser>> byName(String userId,
+      Function<GetDbUserRequest.Builder, ObjectBuilder<GetDbUserRequest>> fn)
+      throws IOException {
+    return this.restTransport.performRequestAsync(GetDbUserRequest.of(userId, fn), GetDbUserRequest._ENDPOINT);
+  }
+
+  /** List all "db" users. */
+  public CompletableFuture<List<DbUser>> list()
+      throws IOException {
+    return this.restTransport.performRequestAsync(ListDbUsersRequest.of(), ListDbUsersRequest._ENDPOINT);
+  }
+
+  /**
+   * List all "db" users.
+   *
+   * @param fn Lambda expression for optional parameters.
+   */
+  public CompletableFuture<List<DbUser>> list(
+      Function<ListDbUsersRequest.Builder, ObjectBuilder<ListDbUsersRequest>> fn)
+      throws IOException {
+    return this.restTransport.performRequestAsync(ListDbUsersRequest.of(fn), ListDbUsersRequest._ENDPOINT);
+  }
+}