Class NewsWrmDataProvider

  • All Implemented Interfaces:
    com.atlassian.webresource.api.data.WebResourceDataProvider, com.google.common.base.Supplier<com.atlassian.json.marshal.Jsonable>, Supplier<com.atlassian.json.marshal.Jsonable>

    public class NewsWrmDataProvider
    extends Object
    implements com.atlassian.webresource.api.data.WebResourceDataProvider
    Data provider to return the news section for the Post Upgrade Landing Page.

    The news section is generated based on the I18N key values provided to the application.

    The following I18N keys are required to construct a valid news section:

    • I18N_NEWS_HEADLINE_KEY
    • I18N_NEWS_DESCRIPTION_KEY

    Each news section may also optionally contain a number of news items.

    The following I18N keys are required to construct a valid news item:

    • I18N_NEWS_ITEM_KEY_PREFIX + newsItemNumber + I18N_NEWS_ITEM_HEADLINE_SUFFIX
    • I18N_NEWS_ITEM_KEY_PREFIX + newsItemNumber + I18N_NEWS_ITEM_TEXT_SUFFIX

    Each news item may have a KB article associated with it. The following I18N keys are required to describe a KB article:

    • I18N_NEWS_ITEM_KEY_PREFIX + newsItemNumber + I18N_NEWS_ITEM_ARTICLE_LINK_SUFFIX
    • I18N_NEWS_ITEM_KEY_PREFIX + newsItemNumber + I18N_NEWS_ITEM_ARTICLE_LABEL_SUFFIX
    Since:
    6.16
    • Constructor Detail

      • NewsWrmDataProvider

        @Inject
        public NewsWrmDataProvider​(I18NBeanFactory i18NBeanFactory,
                                   LocaleManager localeManager,
                                   com.atlassian.sal.api.ApplicationProperties applicationProperties)
    • Method Detail

      • get

        public @NonNull com.atlassian.json.marshal.Jsonable get()
        Specified by:
        get in interface com.google.common.base.Supplier<com.atlassian.json.marshal.Jsonable>
        Specified by:
        get in interface Supplier<com.atlassian.json.marshal.Jsonable>