Package org.apache.juneau.rest.server.guard

Record Class RateLimitGuard.Storage.AcquireResult

java.lang.Object
java.lang.Record
org.apache.juneau.rest.server.guard.RateLimitGuard.Storage.AcquireResult
Record Components:
allowed - true if the request was admitted.
remaining - Tokens left in the bucket after the attempt.
secondsUntilReset - Seconds until the bucket is full again.
Enclosing interface:
RateLimitGuard.Storage
public static record RateLimitGuard.Storage.AcquireResult(boolean allowed, int remaining, long secondsUntilReset) extends Record
Outcome of a tryAcquire attempt.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AcquireResult(boolean allowed, int remaining, long secondsUntilReset)
    Creates an instance of a AcquireResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    allowed()
    Returns the value of the allowed record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    remaining()
    Returns the value of the remaining record component.
    long
    secondsUntilReset()
    Returns the value of the secondsUntilReset record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • AcquireResult

      public AcquireResult(boolean allowed, int remaining, long secondsUntilReset)
      Creates an instance of a AcquireResult record class.
      Parameters:
      allowed - the value for the allowed record component
      remaining - the value for the remaining record component
      secondsUntilReset - the value for the secondsUntilReset record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • allowed

      public boolean allowed()
      Returns the value of the allowed record component.
      Returns:
      the value of the allowed record component

    • remaining

      public int remaining()
      Returns the value of the remaining record component.
      Returns:
      the value of the remaining record component

    • secondsUntilReset

      public long secondsUntilReset()
      Returns the value of the secondsUntilReset record component.
      Returns:
      the value of the secondsUntilReset record component