com.atlassian.sal.api.license

Interface ProductLicense

All Known Subinterfaces:

SingleProductLicenseDetailsView

@PublicApi
public interface ProductLicense

Represents license information for an individual role-based "Product" that lives on a platform.

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNLIMITED_USER_COUNT

Method Summary

Methods

Modifier and Type	Method and Description
int	getNumberOfUsers() Returns the number of users allowed by the current license.
String	getProductDisplayName() Returns the "official" product name as it occurs in the license.
String	getProductKey() Returns the product key as it occurs in the license.
boolean	isUnlimitedNumberOfUsers() Returns true if this license authorises an unlimited number of users.

Field Detail

UNLIMITED_USER_COUNT

static final int UNLIMITED_USER_COUNT

See Also:

Constant Field Values

Method Detail

getProductKey

@Nonnull
String getProductKey()

Returns the product key as it occurs in the license.

eg "com.atlassian.servicedesk", "crucible", "conf"

Returns:

the product key

isUnlimitedNumberOfUsers

boolean isUnlimitedNumberOfUsers()

Returns true if this license authorises an unlimited number of users.

Returns:

true if this license authorises an unlimited number of users.

See Also:

getNumberOfUsers()

getNumberOfUsers

int getNumberOfUsers()

Returns the number of users allowed by the current license.

Returns:

the number of user allowed by the license, UNLIMITED_USER_COUNT if there is no limit

See Also:

isUnlimitedNumberOfUsers()

getProductDisplayName

@Nonnull
String getProductDisplayName()

Returns the "official" product name as it occurs in the license.

eg "Service Desk"

You would normally try to extract this name from the plugin itself, but this is included as a fallback in case the license is installed but the plugin is not.

The product name is a trademark and is never internationalised.

Returns:

the "official" product name as it occurs in the license.