com.atlassian.jira.license

Class LicenseBannerHelperImpl

java.lang.Object

com.atlassian.jira.license.LicenseBannerHelperImpl

All Implemented Interfaces:

LicenseBannerHelper

public class LicenseBannerHelperImpl
extends Object
implements LicenseBannerHelper

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 90, 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 90 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 90 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.

Since:

v6.3

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LicenseBannerHelperImpl

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

Method Detail

getExpiryBanner

@Nonnull
public String getExpiryBanner()

Description copied from interface: LicenseBannerHelper

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).

Specified by:

getExpiryBanner in interface LicenseBannerHelper

Returns:

license banner HTML, or "" if no banner should be displayed.

See Also:

LicenseDetails.isExpired()

getLicenseFlag

@Nonnull
public String getLicenseFlag()

Description copied from interface: LicenseBannerHelper

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).

Specified by:

getLicenseFlag in interface LicenseBannerHelper

Returns:

license banner HTML, or "" if no banner should be displayed.

See Also:

LicenseDetails.isEntitledToSupport()

remindMeLater

public void remindMeLater()

Description copied from interface: LicenseBannerHelper

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

Specified by:

remindMeLater in interface LicenseBannerHelper

clearRemindMe

public void clearRemindMe()

Description copied from interface: LicenseBannerHelper

Reset the remind me state of the current user.

Specified by:

clearRemindMe in interface LicenseBannerHelper