com.atlassian.crowd.analytics.listener

Class AbstractOncePerPeriodPublisher<T extends CrowdAnalyticsEvent>

java.lang.Object

com.atlassian.crowd.analytics.listener.AbstractEventListener

com.atlassian.crowd.analytics.listener.AbstractOncePerPeriodPublisher<T>

Direct Known Subclasses:

ExternalLinkClickedEventListener, LicensingEventListener, SsoTabViewEventListener, UserAuthenticationEventListener

public abstract class AbstractOncePerPeriodPublisher<T extends CrowdAnalyticsEvent>
extends AbstractEventListener

Helper class that publishes output event at most once per defined period of time, when the threshold of incoming events is reached.

Field Summary

Fields

Modifier and Type	Field and Description
protected Clock	clock
protected Map<T,AtomicLong>	counters
protected AtomicLong	lastCountersResetTimestamp
protected long	reportIntervalMillis
protected long	threshold

Fields inherited from class com.atlassian.crowd.analytics.listener.AbstractEventListener

eventPublisher

Constructor Summary

Constructors

Constructor and Description
AbstractOncePerPeriodPublisher(com.atlassian.event.api.EventPublisher eventPublisher, Clock clock, Iterable<T> allKeys)
AbstractOncePerPeriodPublisher(com.atlassian.event.api.EventPublisher eventPublisher, Clock clock, Iterable<T> allKeys, long threshold, long reportIntervalMillis)

Method Summary

Modifier and Type	Method and Description
protected void	maybePublish(T event)
protected void	maybePublish(T event, Supplier<Boolean> shouldPublish)
protected void	resetCounters()
protected void	resetCountersIfNeeded()

Methods inherited from class com.atlassian.crowd.analytics.listener.AbstractEventListener

register, unregister

Methods inherited from class java.lang.Object

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

Field Detail

threshold

protected final long threshold

reportIntervalMillis

protected final long reportIntervalMillis

counters

protected final Map<T extends CrowdAnalyticsEvent,AtomicLong> counters

lastCountersResetTimestamp

protected final AtomicLong lastCountersResetTimestamp

clock

protected final Clock clock

Constructor Detail

AbstractOncePerPeriodPublisher

public AbstractOncePerPeriodPublisher(com.atlassian.event.api.EventPublisher eventPublisher,
                                      Clock clock,
                                      Iterable<T> allKeys,
                                      long threshold,
                                      long reportIntervalMillis)

AbstractOncePerPeriodPublisher

public AbstractOncePerPeriodPublisher(com.atlassian.event.api.EventPublisher eventPublisher,
                                      Clock clock,
                                      Iterable<T> allKeys)

Method Detail

maybePublish

protected void maybePublish(T event)

maybePublish

protected void maybePublish(T event,
                            Supplier<Boolean> shouldPublish)

resetCounters

protected void resetCounters()

resetCountersIfNeeded

protected void resetCountersIfNeeded()