public class

DebugListener

extends AbstractIssueEventListener
implements UserEventListener
java.lang.Object
   ↳ com.atlassian.jira.event.issue.AbstractIssueEventListener
     ↳ com.atlassian.jira.event.listeners.DebugListener
Known Direct Subclasses

Class Overview

A listener for debugging - prints everything it 'hears' to System.err

Useful for debuggin when certain events are fired, and the content of those events.

Summary

Public Constructors
DebugListener()
Public Methods
void customEvent(IssueEvent event)
Implement this method to deal with any custom events within the system
String[] getAcceptedParams()
Returns the parameters used by this listener.
String getDescription()
Returns a textual description of the listener.
void init(Map params)
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.
void issueAssigned(IssueEvent event)
Fired when an issue is assigned or unassigned.
void issueClosed(IssueEvent event)
Fired when an issue is closed.
void issueCommented(IssueEvent event)
Fired when a user comments on an issue.
void issueCreated(IssueEvent event)
Fired when an issue is created.
void issueDeleted(IssueEvent event)
Fired when an issue is deleted.
void issueGenericEvent(IssueEvent event)
Fired for all other events, eg.
void issueMoved(IssueEvent event)
Fired when an issue is moved.
void issueReopened(IssueEvent event)
Fired when an issue is reopened.
void issueResolved(IssueEvent event)
Fired when an issue is resolved.
void issueUpdated(IssueEvent event)
Fired when an issue is updated.
void issueWorkLogged(IssueEvent event)
Fired when work is logged against an issue.
void userCannotChangePassword(UserEvent event)
Fired when a user tries to change their password, and the password cannot be updated
void userCreated(UserEvent event)
Fired when a user is created automatically
void userForgotPassword(UserEvent event)
Fired when a user indicates they have forgotten their password
void userForgotUsername(UserEvent event)
Fired when a user indicates they have forgotten their username
void userSignup(UserEvent event)
Fired when a user signs up manually
[Expand]
Inherited Methods
From class com.atlassian.jira.event.issue.AbstractIssueEventListener
From class java.lang.Object
From interface com.atlassian.jira.event.JiraListener
From interface com.atlassian.jira.event.issue.IssueEventListener
From interface com.atlassian.jira.event.user.UserEventListener

Public Constructors

public DebugListener ()

Public Methods

public void customEvent (IssueEvent event)

Implement this method to deal with any custom events within the system

Parameters
event IssueEvent

public String[] getAcceptedParams ()

Returns the parameters used by this listener.

Returns
  • a non-null array (can be empty)

public 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

public void init (Map params)

public 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

public 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

public void issueAssigned (IssueEvent event)

Fired when an issue is assigned or unassigned.

Check the issue assignee to work out which is the case.

public void issueClosed (IssueEvent event)

Fired when an issue is closed.

The closure comment (if there is one) will be attached to the event as an action.

public void issueCommented (IssueEvent event)

Fired when a user comments on an issue.

The comment will be attached to the event as an action.

public void issueCreated (IssueEvent event)

Fired when an issue is created.

public void issueDeleted (IssueEvent event)

Fired when an issue is deleted.

public void issueGenericEvent (IssueEvent event)

Fired for all other events, eg. those fired from new workflow transitions.

public void issueMoved (IssueEvent event)

Fired when an issue is moved.

public void issueReopened (IssueEvent event)

Fired when an issue is reopened.

public void issueResolved (IssueEvent event)

Fired when an issue is resolved.

The resolution comment (if there is one) will be attached to the event as an action.

public void issueUpdated (IssueEvent event)

Fired when an issue is updated.

The update changelog will be attached to the event as an action.

public void issueWorkLogged (IssueEvent event)

Fired when work is logged against an issue.

The work log will be attached to the event as an action.

public void userCannotChangePassword (UserEvent event)

Fired when a user tries to change their password, and the password cannot be updated

Parameters
event the event in play

public void userCreated (UserEvent event)

Fired when a user is created automatically

Parameters
event the event in play

public void userForgotPassword (UserEvent event)

Fired when a user indicates they have forgotten their password

Parameters
event the event in play

public void userForgotUsername (UserEvent event)

Fired when a user indicates they have forgotten their username

Parameters
event the event in play

public void userSignup (UserEvent event)

Fired when a user signs up manually

Parameters
event the event in play