public class

IssueIndexListener

extends AbstractIssueEventListener
java.lang.Object
   ↳ com.atlassian.jira.event.issue.AbstractIssueEventListener
     ↳ com.atlassian.jira.event.listeners.search.IssueIndexListener

Class Overview

This listener updates the search index within JIRA.

Do not delete ;)

Summary

Constants
String NAME
Public Constructors
IssueIndexListener()
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()
Should not be deleted - required for JIRA operation
boolean isUnique()
As we wish to only have one IssueIndexListener at a time - enforce uniqueness
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).
void issueCommentEdited(IssueEvent event)
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 issueWorklogDeleted(IssueEvent event)
void issueWorklogUpdated(IssueEvent event)
[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

Constants

public static final String NAME

Constant Value: "Issue Index Listener"

Public Constructors

public IssueIndexListener ()

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 ()

Should not be deleted - required for JIRA operation

Returns
  • true if this is an Atlassian listener, otherwise false

public boolean isUnique ()

As we wish to only have one IssueIndexListener at a time - enforce uniqueness

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 issueCommentDeleted (IssueEvent event)

The default behaviour for this method calls issueUpdated(IssueEvent). This preserves the behaviour of JIRA prior to v5.2

public void issueCommentEdited (IssueEvent event)

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 issueWorklogDeleted (IssueEvent event)

public void issueWorklogUpdated (IssueEvent event)