Summary: Methods | [Expand All]
@PublicApi public interface

ListenerManager

implements JiraManager
com.atlassian.jira.event.ListenerManager
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Responsible for maintaining a event listeners. These are generally configured in the database, and implementing Listener classes must implement the JiraListener interface.

Summary

Public Methods
JiraListener createListener(String name, Class<? extends JiraListener> clazz)
Creates a new JiraListener.
void deleteListener(Class<? extends JiraListener> clazz)
Deletes any listeners of the given class.
Map<String, JiraListener> getListeners()
Returns a map of listeners.
void onRefreshListeners()
Invoked when another node in the cluster has refreshed its listeners.
void refresh()
Reloads the map of listeners from the db.

Public Methods

public JiraListener createListener (String name, Class<? extends JiraListener> clazz)

Creates a new JiraListener.

Parameters
name The name of the Listener
clazz The class of the Listener.
Returns
  • the newly created JiraListener

public void deleteListener (Class<? extends JiraListener> clazz)

Deletes any listeners of the given class.

Parameters
clazz The class of the Listener.

public Map<String, JiraListener> getListeners ()

Returns a map of listeners. The map contains mappings from the listener name to listener class.

Returns
  • A map with name -> class mappings.

public void onRefreshListeners ()

Invoked when another node in the cluster has refreshed its listeners.

public void refresh ()

Reloads the map of listeners from the db.