Package com.atlassian.confluence.event

Class TimingEventPublisher

java.lang.Object

com.atlassian.confluence.event.TimingEventPublisher

All Implemented Interfaces:

com.atlassian.event.api.EventListenerRegistrar, com.atlassian.event.api.EventPublisher

@ThreadSafe
@Internal
public class TimingEventPublisher
extends Object
implements com.atlassian.event.api.EventPublisher

An EventPublisher implementation that times how long it takes to publish an event, and logs a warning if the time is above a threshold. Warnings are not started until the object receives an ApplicationStartedEvent, to avoid warnings during the startup process which are known to produce slow events.

Since:

5.5.5

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	EVENT_PUBLISH_WARN_THRESHOLD_DEFAULT	Default for the maximum time for a publish attempt to complete before logging warnings.
static final String	EVENT_PUBLISH_WARN_THRESHOLD_SYSTEM_PROPERTY	System property to configure the maximum time for a publish attempt to complete before logging warnings.

Method Summary

Modifier and Type	Method	Description
static TimingEventPublisher	create(com.atlassian.event.api.EventPublisher delegate)
void	publish(Object event)
void	register(Object listener)
void	unregister(Object listener)
void	unregisterAll()

Methods inherited from class java.lang.Object

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

Field Details

EVENT_PUBLISH_WARN_THRESHOLD_SYSTEM_PROPERTY

public static final String EVENT_PUBLISH_WARN_THRESHOLD_SYSTEM_PROPERTY

System property to configure the maximum time for a publish attempt to complete before logging warnings.

See Also:

• EVENT_PUBLISH_WARN_THRESHOLD_DEFAULT
• ConfluenceListenerHandlersConfiguration.EVENT_LISTENER_WARN_THRESHOLD_SYSTEM_PROPERTY
• Constant Field Values

EVENT_PUBLISH_WARN_THRESHOLD_DEFAULT

public static final Duration EVENT_PUBLISH_WARN_THRESHOLD_DEFAULT

Default for the maximum time for a publish attempt to complete before logging warnings. 5 seconds.

Method Details

create

public static TimingEventPublisher create(com.atlassian.event.api.EventPublisher delegate)

register

public void register(Object listener)

Specified by:

register in interface com.atlassian.event.api.EventListenerRegistrar

unregister

public void unregister(Object listener)

Specified by:

unregister in interface com.atlassian.event.api.EventListenerRegistrar

unregisterAll

public void unregisterAll()

Specified by:

unregisterAll in interface com.atlassian.event.api.EventListenerRegistrar

publish

public void publish(Object event)

Specified by:

publish in interface com.atlassian.event.api.EventPublisher