com.atlassian.jira.event.listeners.search
Class IssueIndexListener

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

All Implemented Interfaces:

IssueEventListener, JiraListener, EventListener

public class IssueIndexListener
extends AbstractIssueEventListener

This listener updates the search index within JIRA.

Do not delete ;)

Field Summary

static String

NAME

Constructor Summary

IssueIndexListener()

Method Summary

void	customEvent(IssueEvent event) Implement this method to deal with any custom events within the system
String[]	getAcceptedParams() Get a list of the parameters for this listener.
String	getDescription() A textual description of the listener.
void	init(Map params) Initialise the listener.
boolean	isInternal() Should not be deleted - required for JIRA operation
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	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() As we wish to only have one IssueIndexListener at a time - enforce uniqueness

Methods inherited from class com.atlassian.jira.event.issue.AbstractIssueEventListener

getI18NBean, issueStarted, issueStopped, workflowEvent

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

IssueIndexListener

public IssueIndexListener()

Method Detail

init

public void init(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

Overrides:

init in class AbstractIssueEventListener

Parameters:

params - initialisation parameters

getAcceptedParams

public String[] getAcceptedParams()

Description copied from interface: JiraListener

Get a list of the parameters for this listener.

Specified by:

getAcceptedParams in interface JiraListener

Overrides:

getAcceptedParams in class AbstractIssueEventListener

Returns:

list of the parameters for this listener.

isInternal

public boolean isInternal()

Should not be deleted - required for JIRA operation

Specified by:

isInternal in interface JiraListener

Overrides:

isInternal in class AbstractIssueEventListener

Returns:

true if this is an Internal Listener.

issueCreated

public void issueCreated(IssueEvent event)

Description copied from interface: IssueEventListener

Fired when an issue is created.

Specified by:

issueCreated in interface IssueEventListener

Overrides:

issueCreated in class AbstractIssueEventListener

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

Overrides:

issueUpdated in class AbstractIssueEventListener

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

Overrides:

issueAssigned in class AbstractIssueEventListener

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

Overrides:

issueResolved in class AbstractIssueEventListener

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

Overrides:

issueClosed in class AbstractIssueEventListener

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

Overrides:

issueCommented in class AbstractIssueEventListener

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

Overrides:

issueWorkLogged in class AbstractIssueEventListener

issueReopened

public void issueReopened(IssueEvent event)

Description copied from interface: IssueEventListener

Fired when an issue is reopened.

Specified by:

issueReopened in interface IssueEventListener

Overrides:

issueReopened in class AbstractIssueEventListener

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

Overrides:

issueGenericEvent in class AbstractIssueEventListener

issueCommentEdited

public void issueCommentEdited(IssueEvent event)

Overrides:

issueCommentEdited in class AbstractIssueEventListener

issueWorklogUpdated

public void issueWorklogUpdated(IssueEvent event)

Overrides:

issueWorklogUpdated in class AbstractIssueEventListener

issueWorklogDeleted

public void issueWorklogDeleted(IssueEvent event)

Overrides:

issueWorklogDeleted in class AbstractIssueEventListener

issueDeleted

public void issueDeleted(IssueEvent event)

Description copied from interface: IssueEventListener

Fired when an issue is deleted.

Specified by:

issueDeleted in interface IssueEventListener

Overrides:

issueDeleted in class AbstractIssueEventListener

issueMoved

public void issueMoved(IssueEvent event)

Description copied from interface: IssueEventListener

Fired when an issue is moved.

Specified by:

issueMoved in interface IssueEventListener

Overrides:

issueMoved in class AbstractIssueEventListener

customEvent

public void customEvent(IssueEvent event)

Description copied from class: AbstractIssueEventListener

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

Specified by:

customEvent in interface IssueEventListener

Overrides:

customEvent in class AbstractIssueEventListener

Parameters:

event - IssueEvent

isUnique

public boolean isUnique()

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

Specified by:

isUnique in interface JiraListener

Overrides:

isUnique in class AbstractIssueEventListener

Returns:

Whether this listener class should be unique.

getDescription

public 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

Overrides:

getDescription in class AbstractIssueEventListener

Returns:

A HTML description of the listener