public class

LicenseBannerHelperImpl

extends Object
implements LicenseBannerHelper
java.lang.Object
   ↳ com.atlassian.jira.license.LicenseBannerHelperImpl

Class Overview

Implements license-related reminders and warnings.

When one or more licensed applications are about to expire, a warning will inform the administrators. Applications may be licensed within a single or multiple licenses.

Either the maintenance or the subscription, for non-perpetual licenses, may be expiring.

When the administrator dismisses the flag ot gets snoozed. The reminder schedule is 45, 30, 15 and 7 days before due date, as well as on the day of expiry. For subscription licenses the administrator is reminded by a banner, that can not be suppressed. When multiple licenses are expiring at different times within the 45 day notification period, the schedule will follow the earliest license's reminder epochs.

The remind me later flag will be cleared when all licenses are renewed, hence are beyond the 45 day notification period

Special care is taken to display correct messages for single or multiple applications expiring.

Expiring licenses take priority over maintenance expiry, maintaining only one flag or banner displaying for all expirations.

Summary

Public Constructors
LicenseBannerHelperImpl(JiraAuthenticationContext context, GlobalPermissionManager globalPermissionManager, UserPropertyManager propertyManager, JiraLicenseManager jiraLicenseManager, SoyTemplateRendererProvider rendererProvider, FeatureManager featureManager, BaseUrl baseUrl)
Public Methods
void clearRemindMe()
Reset the remind me state of the current user.
@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).
@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.
void remindMeLater()
Hide the license flag for the calling user.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.license.LicenseBannerHelper

Public Constructors

public LicenseBannerHelperImpl (JiraAuthenticationContext context, GlobalPermissionManager globalPermissionManager, UserPropertyManager propertyManager, JiraLicenseManager jiraLicenseManager, SoyTemplateRendererProvider rendererProvider, FeatureManager featureManager, BaseUrl baseUrl)

Public Methods

public void clearRemindMe ()

Reset the remind me state of the current user.

@Nonnull public 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.

@Nonnull public 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.

public void remindMeLater ()

Hide the license flag for the calling user. The flag will re-appear later.