• Home
• de.cidaas
• cidaas-interceptor-spring-security
• 1.0.0
• source code
• Bucket.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

de.cidaas.jwk.Bucket Maven / Gradle / Ivy

package de.cidaas.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);
}