com.atlassian.jira.event.issue
Class AbstractIssueEventListener

java.lang.Object
  extended by com.atlassian.jira.event.issue.AbstractIssueEventListener
All Implemented Interfaces:
IssueEventListener, JiraListener, java.util.EventListener
Direct Known Subclasses:
DebugListener, IssueCacheListener, IssueIndexListener, MailListener

public abstract class AbstractIssueEventListener
extends java.lang.Object
implements IssueEventListener

Subclasses of IssueEventListener can now override relevant functions in the interface as opposed to having to provide a dummy implementation for all methods.


Constructor Summary
AbstractIssueEventListener()
           
 
Method Summary
 void customEvent(IssueEvent event)
          Implement this method to deal with any custom events within the system
 java.lang.String[] getAcceptedParams()
          Get a list of the parameters for this listener.
 java.lang.String getDescription()
          A textual description of the listener.
protected  I18nHelper getI18NBean()
           
 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 issueCommentEdited(IssueEvent event)
           
 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 issueStarted(IssueEvent event)
          Fired when user starts work on an issue (start progress)
 void issueStopped(IssueEvent event)
          Fired when user stops work on an issue (stop progress)
 void issueUpdated(IssueEvent event)
          Fired when an issue is updated.
 void issueWorklogDeleted(IssueEvent event)
           
 void issueWorkLogged(IssueEvent event)
          Fired when work is logged against an issue.
 void issueWorklogUpdated(IssueEvent event)
           
 boolean isUnique()
          Whether this listener class should be unique.
 void workflowEvent(IssueEvent event)
          Determines how the event should be processed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractIssueEventListener

public AbstractIssueEventListener()
Method Detail

issueCreated

public void issueCreated(IssueEvent event)
Description copied from interface: IssueEventListener
Fired when an issue is created.

Specified by:
issueCreated 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

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

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

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

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

issueCommentEdited

public void issueCommentEdited(IssueEvent event)

issueWorklogUpdated

public void issueWorklogUpdated(IssueEvent event)

issueWorklogDeleted

public void issueWorklogDeleted(IssueEvent event)

issueReopened

public void issueReopened(IssueEvent event)
Description copied from interface: IssueEventListener
Fired when an issue is reopened.

Specified by:
issueReopened 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

issueStarted

public void issueStarted(IssueEvent event)
Description copied from interface: IssueEventListener
Fired when user starts work on an issue (start progress)

Specified by:
issueStarted in interface IssueEventListener

issueStopped

public void issueStopped(IssueEvent event)
Description copied from interface: IssueEventListener
Fired when user stops work on an issue (stop progress)

Specified by:
issueStopped in interface IssueEventListener

issueMoved

public void issueMoved(IssueEvent event)
Description copied from interface: IssueEventListener
Fired when an issue is moved.

Specified by:
issueMoved in interface IssueEventListener

issueGenericEvent

public void issueGenericEvent(IssueEvent event)
Description copied from interface: IssueEventListener
Fired for all other events, eg. those fired from new workflow transitions.

Specified by:
issueGenericEvent in interface IssueEventListener

workflowEvent

public void workflowEvent(IssueEvent event)
Determines how the event should be processed. Based on the event type ID within the event, the appropriate actions are called.

An event with an unknown event type ID is logged and discarded.

The customEvent method should be implemented to deal with any custom events that are added to the system

Specified by:
workflowEvent in interface IssueEventListener
Parameters:
event - - the IssueEvent object containing the event type ID

customEvent

public void customEvent(IssueEvent event)
Implement this method to deal with any custom events within the system

Specified by:
customEvent in interface IssueEventListener
Parameters:
event -

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

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

getI18NBean

protected I18nHelper getI18NBean()


Copyright © 2002-2010 Atlassian. All Rights Reserved.