Package codes.grow.packages.vault
Class LeaseManager
java.lang.Object
codes.grow.packages.vault.LeaseManager
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 Summary
Modifier and TypeMethodDescriptionintReturns the number of managed leases.Lease details:PUT sys/leases/lookup.lookupAsync(String leaseId) Asynchronouslookup(String).manage(Lease<?> lease, RenewalOptions options) Keeps a lease alive: renews at 2/3 of its TTL until the maximum TTL is reached, then callsonExpireonce when it expires.Renews a lease with its default increment.Renews a lease:PUT sys/leases/renew.renewAsync(String leaseId, Duration increment) Asynchronousrenew(String, Duration).voidRevokes a lease now:PUT sys/leases/revoke.revokeAsync(String leaseId) Asynchronousrevoke(String).voidrevokePrefix(String prefix) Revokes every lease under a prefix:PUT sys/leases/revoke-prefix/<prefix>(needs sudo).revokePrefixAsync(String prefix) AsynchronousrevokePrefix(String).voidstopAll()Stops every managed lease and waits for revocations.Stops every managed lease (revoking those withrevokeOnStop).
-
Method Details
-
renew
Renews a lease with its default increment.- Parameters:
leaseId- lease id- Returns:
- the renewal
-
renew
Renews a lease:PUT sys/leases/renew. A TTL beyond the maximum is capped (seewarnings); unknown or revoked leases raiseValidationException.- Parameters:
leaseId- lease idincrement- requested TTL, may be null- Returns:
- the renewal
-
renewAsync
Asynchronousrenew(String, Duration).- Parameters:
leaseId- lease idincrement- requested TTL, may be null- Returns:
- a future with the renewal
-
revoke
Revokes a lease now:PUT sys/leases/revoke.- Parameters:
leaseId- lease id
-
revokeAsync
Asynchronousrevoke(String).- Parameters:
leaseId- lease id- Returns:
- a future completed when revoked
-
revokePrefix
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
AsynchronousrevokePrefix(String).- Parameters:
prefix- prefix- Returns:
- a future completed when revoked
-
lookup
Lease details:PUT sys/leases/lookup. Unknown leases raiseValidationException.- Parameters:
leaseId- lease id- Returns:
- the details
-
lookupAsync
Asynchronouslookup(String).- Parameters:
leaseId- lease id- Returns:
- a future with the details
-
manage
Keeps a lease alive: renews at 2/3 of its TTL until the maximum TTL is reached, then callsonExpireonce when it expires. Stopped by the handle,stopAll()orclient.close().- Parameters:
lease- the leaseoptions- 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
Stops every managed lease (revoking those withrevokeOnStop). Idempotent.- Returns:
- a future completed when every lease is stopped
-
stopAll
public void stopAll()Stops every managed lease and waits for revocations. Idempotent.
-