Package com.atlassian.diagnostics.internal

Interface AlertPublisher

All Known Implementing Classes:

LockFreeAlertPublisher

public interface AlertPublisher

Method Summary

Modifier and Type	Method	Description
void	publish(Alert alert)	Publishes an alert to registered listeners
String	subscribe(AlertListener listener)	Subscribes the provided listener to all alerts
boolean	unsubscribe(String subscriptionId)	Unsubscribes the AlertListener that had previously subscribed.

Method Details

publish

void publish(@Nonnull
 Alert alert)

Publishes an alert to registered listeners

Parameters:

alert - the alert to publish

subscribe

@Nonnull
String subscribe(@Nonnull
 AlertListener listener)

Subscribes the provided listener to all alerts

Parameters:

listener - the listener

Returns:

the subscription ID to be used in unsubscribe(java.lang.String)

unsubscribe

boolean unsubscribe(@Nonnull
 String subscriptionId)

Unsubscribes the AlertListener that had previously subscribed.

Parameters:

subscriptionId - the subscription ID returned by subscribe(com.atlassian.diagnostics.AlertListener)

Returns:

true if the listener was unsubscribed, false if no subscription was found for subscriptionId