com.atlassian.jira.config
Interface ReindexMessageManager

All Known Implementing Classes:
DefaultReindexMessageManager

@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

Method Summary
 void clear()
          Clears any current message.
 String getMessage(com.atlassian.crowd.embedded.api.User user)
          Get current message localised for given user.
 void pushMessage(com.atlassian.crowd.embedded.api.User user, String i18nTask)
          Pushes a new message.
 

Method Detail

pushMessage

void pushMessage(com.atlassian.crowd.embedded.api.User 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.

clear

void clear()
Clears any current message.


getMessage

String getMessage(com.atlassian.crowd.embedded.api.User 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.


Copyright © 2002-2012 Atlassian. All Rights Reserved.