com.atlassian.jira.event
Interface JiraListener

All Superinterfaces:

EventListener

All Known Subinterfaces:

IssueEventListener, UserEventListener

All Known Implementing Classes:

AbstractIssueEventListener

public interface JiraListener
extends EventListener

The basic interface that all Listeners must implement.

All Listeners must also have an empty constructor to that the ListenerFactory can create it.

See Also:

IssueEventListener, UserEventListener

Method Summary

String[]	getAcceptedParams() Get a list of the parameters for this listener.
String	getDescription() A textual description of the listener.
void	init(Map params) Initialise the listener.
boolean	isInternal() Indicates whether administrators can delete this listener from within the web interface.
boolean	isUnique() Whether this listener class should be unique.

Method Detail

init

void init(Map params)

Initialise the listener.

For custom listeners, the list of parameters is always empty.

Parameters:

params - initialisation parameters

getAcceptedParams

String[] getAcceptedParams()

Get a list of the parameters for this listener.

Returns:

list of the parameters for this listener.

isInternal

boolean isInternal()

Indicates whether administrators can delete this listener from within the web interface.

Basically only Atlassian listeners should return true from this.

Returns:

true if this is an Internal Listener.

isUnique

boolean isUnique()

Whether this listener class should be unique. Some listeners are fine to have multiples, and some are not.

Having multiple mail listeners could be fine - if you wanted multiple mails sent out.

With other listeners, such as the cache listeners, it makes no sense to have multiple listeners of the one class.

Returns:

Whether this listener class should be unique.

getDescription

String getDescription()

A textual description of the listener. You can include HTML if required, but do not use tables, or DHTML, as the description may be displayed inside tables / frames.

A good description will describe what this listener does, and then explains the parameters required for configuring the listener.

If no description is appropriate, return null.

Returns:

A HTML description of the listener