com.auth0.jwk.Bucket Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jwks-rsa Show documentation

JSON Web Key Set parser library

There is a newer version: 0.22.1

package com.auth0.jwk;

/**
 * Token Bucket interface.
 */
interface Bucket {

    /**
     * Calculates the wait time before one token will be available in the Bucket.
     *
     * @return the wait time in milliseconds in which one token will be available in the Bucket.
     */
    long willLeakIn();

    /**
     * Calculates the wait time before the given amount of tokens will be available in the Bucket.
     *
     * @param count the amount of tokens to check how much time to wait for.
     * @return the wait time in milliseconds in which the given amount of tokens will be available in the Bucket.
     */
    long willLeakIn(long count);

    /**
     * Tries to consume one token from the Bucket.
     *
     * @return true if it could consume the token or false if the Bucket doesn't have tokens available now.
     */
    boolean consume();

    /**
     * Tries to consume the given amount of tokens from the Bucket.
     *
     * @param count the amount of tokens to try to consume.
     * @return true if it could consume the given amount of tokens or false if the Bucket doesn't have that amount of tokens available now.
     */
    boolean consume(long count);
}