com.atlassian.jira.event.listeners
Class DebugListener

java.lang.Object
  |
  +--com.atlassian.jira.event.listeners.DebugListener

All Implemented Interfaces:

java.util.EventListener, IssueEventListener, JiraListener, UserEventListener

Direct Known Subclasses:

DebugParamListener

public class DebugListener

extends java.lang.Object

implements IssueEventListener, UserEventListener

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.

Constructor Summary

DebugListener()

Method Summary

java.lang.String[]	getAcceptedParams() Get a list of the parameters for this listener.
java.lang.String	getDescription() A textual description of the listener.
void	init(java.util.Map params) Initialise the listener.
boolean	isInternal() Indicates whether administrators can delete this listener from within the web interface.
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	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.
boolean	isUnique() Whether this listener class should be unique.
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)
void	userSignup(UserEvent event) Fired when a user signs up manually

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DebugListener

public DebugListener()

Method Detail

init

public void init(java.util.Map params)

Description copied from interface: JiraListener

Initialise the listener.

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

Specified by:

init in interface JiraListener

getAcceptedParams

public java.lang.String[] getAcceptedParams()

Description copied from interface: JiraListener

Get a list of the parameters for this listener.

Specified by:

getAcceptedParams in interface JiraListener

issueAssigned

public void issueAssigned(IssueEvent event)

Description copied from interface: IssueEventListener

Fired when an issue is assigned or unassigned.

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

Specified by:

issueAssigned in interface IssueEventListener

issueClosed

public void issueClosed(IssueEvent event)

Description copied from interface: IssueEventListener

Fired when an issue is closed.

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

Specified by:

issueClosed in interface IssueEventListener

issueCreated

public void issueCreated(IssueEvent event)

Description copied from interface: IssueEventListener

Fired when an issue is created.

Specified by:

issueCreated in interface IssueEventListener

issueResolved

public void issueResolved(IssueEvent event)

Description copied from interface: IssueEventListener

Fired when an issue is resolved.

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

Specified by:

issueResolved in interface IssueEventListener

issueReopened

public void issueReopened(IssueEvent event)

Description copied from interface: IssueEventListener

Fired when an issue is reopened.

Specified by:

issueReopened in interface IssueEventListener

issueUpdated

public void issueUpdated(IssueEvent event)

Description copied from interface: IssueEventListener

Fired when an issue is updated.

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

Specified by:

issueUpdated in interface IssueEventListener

issueCommented

public void issueCommented(IssueEvent event)

Description copied from interface: IssueEventListener

Fired when a user comments on an issue.

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

Specified by:

issueCommented in interface IssueEventListener

issueDeleted

public void issueDeleted(IssueEvent event)

Description copied from interface: IssueEventListener

Fired when an issue is deleted.

Specified by:

issueDeleted in interface IssueEventListener

issueWorkLogged

public void issueWorkLogged(IssueEvent event)

Description copied from interface: IssueEventListener

Fired when work is logged against an issue.

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

Specified by:

issueWorkLogged in interface IssueEventListener

userSignup

public void userSignup(UserEvent event)

Description copied from interface: UserEventListener

Fired when a user signs up manually

Specified by:

userSignup in interface UserEventListener

userCreated

public void userCreated(UserEvent event)

Description copied from interface: UserEventListener

Fired when a user is created automatically

Specified by:

userCreated in interface UserEventListener

userForgotPassword

public void userForgotPassword(UserEvent event)

Description copied from interface: UserEventListener

Fired when a user indicates they have forgotten their password

Specified by:

userForgotPassword in interface UserEventListener

userForgotUsername

public void userForgotUsername(UserEvent event)

Specified by:

userForgotUsername in interface UserEventListener

isInternal

public boolean isInternal()

Description copied from interface: JiraListener

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

Basically only Atlassian listeners should return true from this.

Specified by:

isInternal in interface JiraListener

isUnique

public boolean isUnique()

Description copied from interface: JiraListener

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.

Specified by:

isUnique in interface JiraListener

Returns:

Whether this listener class should be unique.

getDescription

public java.lang.String getDescription()

Description copied from interface: JiraListener

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.

Specified by:

getDescription in interface JiraListener

Returns:

A HTML description of the listener