de.ipcon.tools

Class RecentEventsCounter

java.lang.Object

de.ipcon.tools.RecentEventsCounter

Direct Known Subclasses:

NotificationHandler.NHRecentEventsCounter

public class RecentEventsCounter
extends java.lang.Object

This class allows to count the number of events during a given recent timespan and check if too many events happened. Can be used for example for rate limiting when handling mails to be sent out or similar.

Constructor Summary

Constructors

Constructor and Description
RecentEventsCounter(int maxEvents, java.time.Duration duringDuration)

Method Summary

Modifier and Type	Method and Description
void	countEvent()
void	countEvent(java.util.Date now, java.lang.String eventInfo)
void	countEvent(java.lang.String eventInfo)
int	countOfEventsWithinDuration()
java.time.Duration	getDuringDuration()
int	getMaxAllowedEvents()
boolean	theseEventsWouldExceedLimit(int count) Convenience method to check if the given number of events would cause the max. limit to be exceeded.
boolean	thisEventExceedsLimit()
boolean	thisEventExceedsLimit(java.util.Date now)
boolean	thisEventExceedsLimit(java.util.Date now, java.lang.String eventInfo)
boolean	thisEventWouldExceedLimit() Convenience method to check if one more event ("this event") would cause the max. limit to be exceeded.
void	updateSettings(int maxEvents, java.time.Duration duringDuration)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecentEventsCounter

public RecentEventsCounter(int maxEvents,
                           java.time.Duration duringDuration)

Method Detail

updateSettings

public void updateSettings(int maxEvents,
                           java.time.Duration duringDuration)

thisEventWouldExceedLimit

public boolean thisEventWouldExceedLimit()

Convenience method to check if one more event ("this event") would cause the max. limit to be exceeded.

Returns:

true if one more event would exceed the limit, false if not

theseEventsWouldExceedLimit

public boolean theseEventsWouldExceedLimit(int count)

Convenience method to check if the given number of events would cause the max. limit to be exceeded.

Returns:

true if count more events would exceed the limit, false if not

thisEventExceedsLimit

public boolean thisEventExceedsLimit()

thisEventExceedsLimit

public boolean thisEventExceedsLimit(java.util.Date now)

thisEventExceedsLimit

public boolean thisEventExceedsLimit(java.util.Date now,
                                     java.lang.String eventInfo)

countEvent

public void countEvent()

countEvent

public void countEvent(java.lang.String eventInfo)

countEvent

public void countEvent(java.util.Date now,
                       java.lang.String eventInfo)

countOfEventsWithinDuration

public int countOfEventsWithinDuration()

getMaxAllowedEvents

public int getMaxAllowedEvents()

getDuringDuration

public java.time.Duration getDuringDuration()