Record Class LoginAttemptDecision.LockedOut

java.lang.Object
java.lang.Record
com.svenruppert.jsentinel.bruteforce.LoginAttemptDecision.LockedOut
Record Components:
remaining - remaining time before the lockout lifts; non-null, non-negative
failedAttempts - total failures observed for the locked key — informational, never echoed to clients
All Implemented Interfaces:
LoginAttemptDecision
Enclosing interface:
LoginAttemptDecision
public static record LoginAttemptDecision.LockedOut(Duration remaining, int failedAttempts) extends Record implements LoginAttemptDecision
The caller is locked out. The handler must skip the actual credential check and respond with a generic "too many failed attempts" error.

  • Constructor Details

    • LockedOut

      public LockedOut(Duration remaining, int failedAttempts)
      Creates an instance of a LockedOut record class.
      Parameters:
      remaining - the value for the remaining record component
      failedAttempts - the value for the failedAttempts 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • remaining

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

    • failedAttempts

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