Class LeaseManager

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

public final class LeaseManager extends Object
Lease operations and automatic renewal: client.leases().

 Lease<DatabaseCredentials> creds = client.database().getCredentials("app");
 ManagedLease handle = client.leases().manage(creds,
     RenewalOptions.builder().onExpire(() -> reconnect()).build());
 
  • Method Details

    • renew

      public LeaseRenewal renew(String leaseId)
      Renews a lease with its default increment.
      Parameters:
      leaseId - lease id
      Returns:
      the renewal
    • renew

      public LeaseRenewal renew(String leaseId, Duration increment)
      Renews a lease: PUT sys/leases/renew. A TTL beyond the maximum is capped (see warnings); unknown or revoked leases raise ValidationException.
      Parameters:
      leaseId - lease id
      increment - requested TTL, may be null
      Returns:
      the renewal
    • renewAsync

      public CompletableFuture<LeaseRenewal> renewAsync(String leaseId, Duration increment)
      Parameters:
      leaseId - lease id
      increment - requested TTL, may be null
      Returns:
      a future with the renewal
    • revoke

      public void revoke(String leaseId)
      Revokes a lease now: PUT sys/leases/revoke.
      Parameters:
      leaseId - lease id
    • revokeAsync

      public CompletableFuture<Void> revokeAsync(String leaseId)
      Asynchronous revoke(String).
      Parameters:
      leaseId - lease id
      Returns:
      a future completed when revoked
    • revokePrefix

      public void revokePrefix(String prefix)
      Revokes every lease under a prefix: PUT sys/leases/revoke-prefix/<prefix> (needs sudo).
      Parameters:
      prefix - lease id prefix, e.g. database/creds/app
    • revokePrefixAsync

      public CompletableFuture<Void> revokePrefixAsync(String prefix)
      Asynchronous revokePrefix(String).
      Parameters:
      prefix - prefix
      Returns:
      a future completed when revoked
    • lookup

      public LeaseInfo lookup(String leaseId)
      Lease details: PUT sys/leases/lookup. Unknown leases raise ValidationException.
      Parameters:
      leaseId - lease id
      Returns:
      the details
    • lookupAsync

      public CompletableFuture<LeaseInfo> lookupAsync(String leaseId)
      Asynchronous lookup(String).
      Parameters:
      leaseId - lease id
      Returns:
      a future with the details
    • manage

      public ManagedLease manage(Lease<?> lease, RenewalOptions options)
      Keeps a lease alive: renews at 2/3 of its TTL until the maximum TTL is reached, then calls onExpire once when it expires. Stopped by the handle, stopAll() or client.close().
      Parameters:
      lease - the lease
      options - renewal options
      Returns:
      the handle
      Throws:
      ValidationException - when the lease has no id
    • activeLeases

      public int activeLeases()
      Returns the number of managed leases.
      Returns:
      the count
    • stopAllAsync

      public CompletableFuture<Void> stopAllAsync()
      Stops every managed lease (revoking those with revokeOnStop). Idempotent.
      Returns:
      a future completed when every lease is stopped
    • stopAll

      public void stopAll()
      Stops every managed lease and waits for revocations. Idempotent.