Record Class AbusePatternSignal

java.lang.Object

java.lang.Record

com.svenruppert.jsentinel.credential.abuse.AbusePatternSignal

Record Components:

pattern - which pattern fired

at - when the signal was raised

windowSize - sliding-window length the count was measured across

distinctTargets - size of the distinct-target set (e.g. distinct usernames for SPRAYING, distinct clients for STUFFING)

attempts - total attempts in the window (≥ distinctTargets)

public record AbusePatternSignal(AbusePattern pattern, Instant at, Duration windowSize, int distinctTargets, int attempts)
extends Record

Privacy-minimised signal emitted by an AbusePatternMonitor detector when a pattern crosses its threshold.

The signal carries aggregates only — counts of distinct usernames / clients, never the usernames or addresses themselves (CWE-359). Audit sinks may add their own metadata if the operator decides that's acceptable for their deployment, but the signal itself stays minimal.

Constructor Summary

Constructors

Constructor	Description
AbusePatternSignal(AbusePattern pattern, Instant at, Duration windowSize, int distinctTargets, int attempts)	Creates an instance of a AbusePatternSignal record class.

Method Summary

Modifier and Type	Method	Description
Instant	at()	Returns the value of the at record component.
int	attempts()	Returns the value of the attempts record component.
int	distinctTargets()	Returns the value of the distinctTargets 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.
AbusePattern	pattern()	Returns the value of the pattern record component.
final String	toString()	Returns a string representation of this record class.
Duration	windowSize()	Returns the value of the windowSize record component.

Methods inherited from class Object

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

Constructor Details

AbusePatternSignal

public AbusePatternSignal(AbusePattern pattern,
 Instant at,
 Duration windowSize,
 int distinctTargets,
 int attempts)

Creates an instance of a AbusePatternSignal record class.

Parameters:

pattern - the value for the pattern record component

at - the value for the at record component

windowSize - the value for the windowSize record component

distinctTargets - the value for the distinctTargets record component

attempts - the value for the attempts 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.

pattern

public AbusePattern pattern()

Returns the value of the pattern record component.

Returns:

the value of the pattern record component

at

public Instant at()

Returns the value of the at record component.

Returns:

the value of the at record component

windowSize

public Duration windowSize()

Returns the value of the windowSize record component.

Returns:

the value of the windowSize record component

distinctTargets

public int distinctTargets()

Returns the value of the distinctTargets record component.

Returns:

the value of the distinctTargets record component

attempts

public int attempts()

Returns the value of the attempts record component.

Returns:

the value of the attempts record component