@Internal public interface

LicenseDetailsFactory

com.atlassian.jira.license.LicenseDetailsFactory
Known Indirect Subclasses

@Internal

This interface is an internal implementation detail and will change without notice.

Clients that depend on @Internal classes and interfaces can not expect to be compatible with any version other than the version they were compiled against (even minor version and milestone releases may break binary compatibility with respect to @Internal elements).

Class Overview

Provides the ability to extract a LicenseDetails object from a license String.

Summary

Public Methods
@Nonnull LicenseDetails getLicense(String licenseString)
Converts an encoded license key into a LicenseDetails.
boolean isDecodeable(String licenseString)
Determines whether a license string can be decoded by this factory.

Public Methods

@Nonnull public LicenseDetails getLicense (String licenseString)

Converts an encoded license key into a LicenseDetails. This method never returns null, if the provided license key is undecodable or not for a JIRA Product a com.atlassian.extras.api.LicenseException is thrown.

Parameters
licenseString the encoded license key.
Returns
  • the corresponding license details.
Throws
LicenseException if licenseString was null or could not be decoded (see isDecodeable(String).

public boolean isDecodeable (String licenseString)

Determines whether a license string can be decoded by this factory. If this returns true, then getLicense is guaranteed to return a valid non-placeholder LicenseDetails object.

Parameters
licenseString the (usually encrypted) license string to test
Returns
  • true if the license string can be interpreted by this factory, false otherwise