@PublicSpi public abstract class AbstractIssueEventListener extends Object implements IssueEventListener
Constructor and Description |
---|
AbstractIssueEventListener() |
Modifier and Type | Method and Description |
---|---|
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.
|
protected I18nHelper |
getI18NBean() |
protected void |
handleDefaultIssueEvent(IssueEvent event)
If you need to treat all the issue events equally, override this method and add logic to handle events.
|
void |
init(Map params)
Initialises the listener with the given parameters.
|
boolean |
isInternal()
Indicates whether this listener is internal, meaning it cannot be
removed by an administrator.
|
void |
issueAssigned(IssueEvent event)
Fired when an issue is assigned or unassigned.
|
void |
issueClosed(IssueEvent event)
Fired when an issue is closed.
|
void |
issueCommentDeleted(IssueEvent event)
The default behaviour for this method calls
issueUpdated(IssueEvent event) . |
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()
Indicates whether JIRA should only create one instance of this listener.
|
void |
workflowEvent(IssueEvent event)
Determines how the event should be processed.
|
public void issueCreated(IssueEvent event)
IssueEventListener
issueCreated
in interface IssueEventListener
public void issueUpdated(IssueEvent event)
IssueEventListener
The update changelog will be attached to the event as an action.
issueUpdated
in interface IssueEventListener
public void issueAssigned(IssueEvent event)
IssueEventListener
Check the issue assignee to work out which is the case.
issueAssigned
in interface IssueEventListener
public void issueResolved(IssueEvent event)
IssueEventListener
The resolution comment (if there is one) will be attached to the event as an action.
issueResolved
in interface IssueEventListener
public void issueClosed(IssueEvent event)
IssueEventListener
The closure comment (if there is one) will be attached to the event as an action.
issueClosed
in interface IssueEventListener
public void issueCommented(IssueEvent event)
IssueEventListener
The comment will be attached to the event as an action.
issueCommented
in interface IssueEventListener
public void issueCommentEdited(IssueEvent event)
public void issueCommentDeleted(IssueEvent event)
issueUpdated(IssueEvent event)
.
This preserves the behaviour of JIRA prior to v5.2public void issueWorklogUpdated(IssueEvent event)
public void issueWorklogDeleted(IssueEvent event)
public void issueReopened(IssueEvent event)
IssueEventListener
issueReopened
in interface IssueEventListener
public void issueDeleted(IssueEvent event)
IssueEventListener
issueDeleted
in interface IssueEventListener
public void issueWorkLogged(IssueEvent event)
IssueEventListener
The work log will be attached to the event as an action.
issueWorkLogged
in interface IssueEventListener
public void issueStarted(IssueEvent event)
IssueEventListener
issueStarted
in interface IssueEventListener
public void issueStopped(IssueEvent event)
IssueEventListener
issueStopped
in interface IssueEventListener
public void issueMoved(IssueEvent event)
IssueEventListener
issueMoved
in interface IssueEventListener
public void issueGenericEvent(IssueEvent event)
IssueEventListener
issueGenericEvent
in interface IssueEventListener
protected void handleDefaultIssueEvent(IssueEvent event)
event
- The received eventpublic void workflowEvent(IssueEvent event)
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
workflowEvent
in interface IssueEventListener
event
- - the IssueEvent object containing the event type IDpublic void customEvent(IssueEvent event)
customEvent
in interface IssueEventListener
event
- IssueEventpublic void init(Map params)
JiraListener
init
in interface JiraListener
params
- the initialisation parameters given in the Listener Propertiespublic String[] getAcceptedParams()
JiraListener
getAcceptedParams
in interface JiraListener
public boolean isInternal()
JiraListener
isInternal
in interface JiraListener
true
if this is an Atlassian listener, otherwise public boolean isUnique()
JiraListener
isUnique
in interface JiraListener
public String getDescription()
JiraListener
A good description will describe what this listener does and explain the parameters required for configuring it.
getDescription
in interface JiraListener
protected I18nHelper getI18NBean()
Copyright © 2002-2022 Atlassian. All Rights Reserved.