Class Database

java.lang.Object
codes.grow.packages.vault.Database

public final class Database extends Object
Database secrets engine on one mount: client.database() (mount database).

 Lease<DatabaseCredentials> lease = client.database().getCredentials("readonly");
 String user = lease.data().username();
 
  • Method Details

    • mount

      public String mount()
      Returns the mount.
      Returns:
      the mount path
    • getCredentials

      public Lease<DatabaseCredentials> getCredentials(String role)
      Generates credentials for a role: GET <mount>/creds/<role>. Unknown roles raise ValidationException. Never retried blindly (each call creates a user).
      Parameters:
      role - role name
      Returns:
      the lease with the credentials
    • getCredentialsAsync

      public CompletableFuture<Lease<DatabaseCredentials>> getCredentialsAsync(String role)
      Parameters:
      role - role name
      Returns:
      a future with the lease
    • configureConnection

      public void configureConnection(String name, ConnectionConfig config)
      Creates or replaces a connection: POST <mount>/config/<name> (verified by default; bad credentials raise ValidationException).
      Parameters:
      name - connection name
      config - settings
    • configureConnectionAsync

      public CompletableFuture<Void> configureConnectionAsync(String name, ConnectionConfig c)
      Parameters:
      name - connection name
      c - settings
      Returns:
      a future completed when done
    • readConnection

      public ConnectionInfo readConnection(String name)
      Reads a connection (without its password); NotFoundException when missing.
      Parameters:
      name - connection name
      Returns:
      the connection
    • readConnectionAsync

      public CompletableFuture<ConnectionInfo> readConnectionAsync(String name)
      Parameters:
      name - connection name
      Returns:
      a future with the connection
    • deleteConnection

      public void deleteConnection(String name)
      Deletes a connection.
      Parameters:
      name - connection name
    • deleteConnectionAsync

      public CompletableFuture<Void> deleteConnectionAsync(String name)
      Parameters:
      name - connection name
      Returns:
      a future completed when done
    • createRole

      public void createRole(String name, RoleConfig config)
      Creates or replaces a dynamic role: POST <mount>/roles/<name>.
      Parameters:
      name - role name
      config - settings
    • createRoleAsync

      public CompletableFuture<Void> createRoleAsync(String name, RoleConfig c)
      Parameters:
      name - role name
      c - settings
      Returns:
      a future completed when done
    • readRole

      public RoleInfo readRole(String name)
      Reads a role; NotFoundException when missing.
      Parameters:
      name - role name
      Returns:
      the role
    • readRoleAsync

      public CompletableFuture<RoleInfo> readRoleAsync(String name)
      Asynchronous readRole(String).
      Parameters:
      name - role name
      Returns:
      a future with the role
    • deleteRole

      public void deleteRole(String name)
      Deletes a role.
      Parameters:
      name - role name
    • deleteRoleAsync

      public CompletableFuture<Void> deleteRoleAsync(String name)
      Asynchronous deleteRole(String).
      Parameters:
      name - role name
      Returns:
      a future completed when done
    • toString

      public String toString()
      Overrides:
      toString in class Object