Package com.atlassian.jira.config

Interface ReindexMessageManager

All Known Implementing Classes:
DefaultReindexMessageManager, NoOpReindexMessageManager
@PublicApi public interface ReindexMessageManager
Manages messages for JIRA's administration section that inform users of the need to reindex due to configuration changes.
Since:
v4.0

  • Field Details

    • DISMISSAL_FLAG

      static final String DISMISSAL_FLAG
      Flag used to determine if a user has dismissed a reindex message or not.
      Since:
      6.4
      See Also:

  • Method Details

    • pushMessage

      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.

    • pushRawMessage

      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.

    • clear

      void clear()
      Clears any current message.

    • getMessage

      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.

    • getMessageObject

      ReindexMessage getMessageObject()
      Get current message object for given user.
      Returns:
      the current message data.
      Since:
      v5.2

    • clearMessageForTimestamp

      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.
      Since:
      v5.2