@PublicApi public interface

ReindexMessageManager

com.atlassian.jira.config.ReindexMessageManager
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Manages messages for JIRA's administration section that inform users of the need to reindex due to configuration changes.

Summary

Constants
String DISMISSAL_FLAG Flag used to determine if a user has dismissed a reindex message or not.
Public Methods
void clear()
Clears any current message.
void clearMessageForTimestamp(Date time)
Clears message if it was posted before a specific time
String getMessage(ApplicationUser user)
Get current message localised for given user.
ReindexMessage getMessageObject()
Get current message object for given user.
void pushMessage(ApplicationUser user, String i18nTask)
Pushes a new message.
void pushRawMessage(ApplicationUser user, String i18nTask)
Pushes a new raw message.

Constants

public static final String DISMISSAL_FLAG

Flag used to determine if a user has dismissed a reindex message or not.

Constant Value: "com.atlassian.jira.reindex.required"

Public Methods

public void clear ()

Clears any current message.

public void clearMessageForTimestamp (Date time)

Clears message if it was posted before a specific time

Parameters
time If the message was posted before this time it will be cleared.

public String getMessage (ApplicationUser user)

Get current message localised for given user.

Parameters
user the current user
Returns
  • the current message, localised for the current user, presented in HTML (and already escaped). null if there is no current message.

public ReindexMessage getMessageObject ()

Get current message object for given user.

Returns
  • the current message data.

public void pushMessage (ApplicationUser user, String i18nTask)

Pushes a new message. This will replace any existing messages.

Parameters
user the user performing the task. May be null, in which case a more generic notification will be displayed
i18nTask the i18n key of the task being performed.

public void pushRawMessage (ApplicationUser user, String i18nTask)

Pushes a new raw message. This will replace any existing messages.

Parameters
user the user performing the task. May be null, in which case a more generic notification will be displayed
i18nTask the i18n key of the message being performed.