Package com.atlassian.jira.util.system.check

Interface SystemEnvironmentChecklistRetriever

All Known Implementing Classes:
DefaultSystemEnvironmentChecklistRetriever
public interface SystemEnvironmentChecklistRetriever
This class exists purely so that classes can have the system environment checklist injected for testing as opposed to looking up messages statically. System checks typically include warnings for specific detected problems such as running in an unsupported JVM or container.
Since:
7.0

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getEnglishWarningMessages()
    Gets all known system warning messages as specified in the checklist, but in English.
    List<String>
    getWarningMessages(Locale locale, boolean asHtml)
    Gets all known system warning messages as specified in the checklist.

  • Method Details

    • getWarningMessages

      List<String> getWarningMessages(Locale locale, boolean asHtml)
      Gets all known system warning messages as specified in the checklist. This does not retrieve all warnings in the system; only those specifically configured to show in this list.
      Parameters:
      locale - the locale to use for these messages, usually the current user's locale
      asHtml - whether to provide html tag wrappers around the message for nicer display in the browser
      Returns:
      a list of messages

    • getEnglishWarningMessages

      List<String> getEnglishWarningMessages()
      Gets all known system warning messages as specified in the checklist, but in English. This does not retrieve all warnings in the system; only those specifically configured to show in this list. This is the same as calling getWarningMessages(Locale.ENGLISH, false).
      Returns:
      a list of messages