Record Class BruteForceLimitReached

java.lang.Object
java.lang.Record
com.svenruppert.jsentinel.audit.BruteForceLimitReached
Record Components:
timestamp - UTC creation time, never null
username - username under lockout, never null
clientAddress - remote client address, or null
failedAttempts - number of recent failures that triggered the lockout
lockoutDuration - remaining lockout time, never null
All Implemented Interfaces:
AuditEvent
public record BruteForceLimitReached(Instant timestamp, String username, String clientAddress, int failedAttempts, Duration lockoutDuration) extends Record implements AuditEvent
The login attempt policy locked a username/client because it crossed a failure threshold. Subsequent attempts will be rejected until the lockout elapses.

  • Constructor Details

    • BruteForceLimitReached

      public BruteForceLimitReached(Instant timestamp, String username, String clientAddress, int failedAttempts, Duration lockoutDuration)
      Creates an instance of a BruteForceLimitReached record class.
      Parameters:
      timestamp - the value for the timestamp record component
      username - the value for the username record component
      clientAddress - the value for the clientAddress record component
      failedAttempts - the value for the failedAttempts record component
      lockoutDuration - the value for the lockoutDuration 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.

    • timestamp

      public Instant timestamp()
      Returns the value of the timestamp record component.
      Specified by:
      timestamp in interface AuditEvent
      Returns:
      the value of the timestamp record component

    • username

      public String username()
      Returns the value of the username record component.
      Returns:
      the value of the username record component

    • clientAddress

      public String clientAddress()
      Returns the value of the clientAddress record component.
      Returns:
      the value of the clientAddress record component

    • failedAttempts

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

    • lockoutDuration

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