com.atlassian.sal.api.license

Interface BaseLicenseDetails

All Known Subinterfaces:

MultiProductLicenseDetails, SingleProductLicenseDetailsView

@PublicApi
public interface BaseLicenseDetails

Common license properties that appear in all the different kind of Product Licenses that may occur in Atlassian applications.

This interface must not contain properties which may have multiple values in Multi-Product Platform licenses (eg NumberOfUsers).

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the description that appears in the license.
Date	getLicenseExpiryDate() Returns the license expiry date.
String	getLicenseTypeName() Returns the license type name exactly as it appears in the license.
Date	getMaintenanceExpiryDate() Returns the Maintenance expiry date.
String	getOrganisationName() Returns the Organisation Name.
String	getProperty(String key) Retrieves an arbitrary property from the license.
String	getServerId() Returns the Server-ID as it appears in this license.
String	getSupportEntitlementNumber() Returns the Support Entitlement Number (SEN) for this license.
boolean	isDataCenter() Returns true if this is a "Data Center" license.
boolean	isEnterpriseLicensingAgreement() Returns true if this is an "Enterprise Licensing Agreement" license.
boolean	isEvaluationLicense() Returns true if this is an evaluation license.
boolean	isPerpetualLicense() Returns true if this license never expires.

Method Detail

isEvaluationLicense

boolean isEvaluationLicense()

Returns true if this is an evaluation license.

Returns:

true if this is an evaluation license.

See Also:

getLicenseTypeName()

getLicenseTypeName

@Nonnull
String getLicenseTypeName()

Returns the license type name exactly as it appears in the license.

Returns:

the license type name exactly as it appears in the license.

See Also:

isEvaluationLicense()

getOrganisationName

String getOrganisationName()

Returns the Organisation Name.

Returns:

the Organisation Name.

getSupportEntitlementNumber

@Nullable
String getSupportEntitlementNumber()

Returns the Support Entitlement Number (SEN) for this license.

This should only return null for Development licenses.

Returns:

the Support Entitlement Number (SEN) for this license.

getDescription

String getDescription()

Returns the description that appears in the license.

Returns:

the description that appears in the license.

getServerId

String getServerId()

Returns the Server-ID as it appears in this license.

Returns:

the Server-ID as it appears in this license.

isPerpetualLicense

boolean isPerpetualLicense()

Returns true if this license never expires.

This is equivalent to calling:

    getLicenseExpiryDate() == null

Returns:

true if this license never expires.

getLicenseExpiryDate

@Nullable
Date getLicenseExpiryDate()

Returns the license expiry date.

Perpetual licenses will never expire and will return a null expiry date.
Subscription licenses will have an expiry date.
It is recommended that you display the expiry date to users for subscription licenses, and the maintenance expiry date to users for perpetual licenses.

Returns:

the license expiry date or null if this is a perpetual license.

See Also:

isPerpetualLicense(), getMaintenanceExpiryDate()

getMaintenanceExpiryDate

@Nullable
Date getMaintenanceExpiryDate()

Returns the Maintenance expiry date. That is, the date up until which the customer can receive support.

Returns:

the Maintenance expiry date.

isDataCenter

boolean isDataCenter()

Returns true if this is a "Data Center" license.

Returns:

true if this is a "Data Center" license.

isEnterpriseLicensingAgreement

boolean isEnterpriseLicensingAgreement()

Returns true if this is an "Enterprise Licensing Agreement" license.

Returns:

true if this is an "Enterprise Licensing Agreement" license.

getProperty

@Nullable
String getProperty(@Nonnull
                             String key)

Retrieves an arbitrary property from the license.

Parameters:

key - the property key

Returns:

the value of the given property in the license.