Package com.atlassian.jira.license

Interface LicenseBannerHelper

All Known Implementing Classes:
LicenseBannerHelperImpl
public interface LicenseBannerHelper
Knows how to generate and control the license banner. A license warning is displayed on the UI if the license is about to expire.
Since:
v6.3

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canViewLicenseInfo()
     
    void
    clearRemindMe()
    Reset the remind me state of the current user.
    String
    getExpiryBanner()
    Returns HTML to render expiry banners for all licenses that are expired or are about to expire, or an empty string if no banners are required (ie: no licenses have expired or are near expiry).
    String
    getLicenseFlag()
    Returns HTML to render flags for all licenses that about to expire or whose maintenance period has expired or is about to expire.
    void
    remindMeLater()
    Hide the license flag for the calling user.

  • Method Details

    • getExpiryBanner

      @Nonnull String getExpiryBanner()
      Returns HTML to render expiry banners for all licenses that are expired or are about to expire, or an empty string if no banners are required (ie: no licenses have expired or are near expiry).
      Returns:
      license banner HTML, or "" if no banner should be displayed.
      See Also:

    • canViewLicenseInfo

      boolean canViewLicenseInfo()
      Returns:
      true if the license banner can be displayed to the current user and false otherwise

    • getLicenseFlag

      @Nonnull String getLicenseFlag()
      Returns HTML to render flags for all licenses that about to expire or whose maintenance period has expired or is about to expire. Returns an empty string if no banners are required (ie: all licenses are within maintenance).
      Returns:
      license banner HTML, or "" if no banner should be displayed.
      See Also:

    • remindMeLater

      void remindMeLater()
      Hide the license flag for the calling user. The flag will re-appear later.

    • clearRemindMe

      void clearRemindMe()
      Reset the remind me state of the current user.