com.atlassian.jira.event
Interface JiraListener

All Superinterfaces:

EventListener

All Known Subinterfaces:

IssueEventListener, UserEventListener

All Known Implementing Classes:

AbstractIssueEventListener, BackgroundIndexListener, DebugListener, DebugMailListener, DebugParamListener, IssueAssignHistoryListener, IssueIndexListener, MailListener, MockIssueEventListener, MockListener, MockMailListener

public interface JiraListener
extends EventListener

A JIRA-specific EventListener.

Implementations must have a no-arg constructor so that JIRA can create them.

See Also:

IssueEventListener, UserEventListener

Method Summary

String[]	getAcceptedParams() Returns the parameters used by this listener.
String	getDescription() Returns a textual description of the listener.
void	init(Map<String,String> params) Initialises the listener with the given parameters.
boolean	isInternal() Indicates whether this listener is internal, meaning it cannot be removed by an administrator.
boolean	isUnique() Indicates whether JIRA should only create one instance of this listener.

Method Detail

init

void init(Map<String,String> params)

Initialises the listener with the given parameters.

Parameters:

params - the initialisation parameters given in the Listener Properties

getAcceptedParams

String[] getAcceptedParams()

Returns the parameters used by this listener.

Returns:

a non-null array (can be empty)

isInternal

boolean isInternal()

Indicates whether this listener is internal, meaning it cannot be removed by an administrator.

Returns:

true if this is an Atlassian listener, otherwise false

isUnique

boolean isUnique()

Indicates whether JIRA should only create one instance of this listener. For example, having multiple mail listeners would be fine if you wanted multiple mails sent out. For other listeners, such as cache listeners, it makes no sense to have multiple instances.

Returns:

whether this listener should be a singleton

getDescription

String getDescription()

Returns 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 or frames.

A good description will describe what this listener does and explain the parameters required for configuring it.

Returns:

a description of the listener, or null if no description is appropriate