LicenseManager

After completing SDK Initialization, there are a number of methods and objects available to the app developer.

getCurrent()

In case no active license is available the property value will be null.

License currentLicense = licenseManager.getCurrent();

getTrialLicense(String email)

You can generate a trial key directly from the app using the SDK, which will automatically associate this license key with the provided email. You can later use this data from the LicenseSpring platform to send out email campaigns targeting trial users for example.

After you generate a trial key - the UnactivatedTrialLicense object will be returned, you still need to activate it using a call to licenseManager.activateLicense()

try {
  UnactivatedTrialLicense trial = licenseManager.getTrialLicense("[email protected]");
  License license = licenseManager.activateLicense(trial.createIdentity());
}
catch(LicenseSpringException e)
{
  log.error("Something went wrong",e);
  return;
}

activateLicenseKey(ActivationLicense identity)

Attempts to activate the product using provided ActivationIdentity. Returns the License object that has been activated.

// keybased
ActivationLicense keyBased = ActivationLicense.fromKey("license-key");
License activated = licenseManager.activateLicense(keyBased);

// OR username/pass based - Note that this is the only API which requires the password.
// LicenseSpring will never store user passwords via the SDK.
ActivationLicense userBased = ActivationLicense.fromUsername("username", "password");
License activated = licenseManager.ActivateLicense(userBased);

deactivateLicense(LicenseIdentity identity)

License is deactivated using a method on the Manager. You need to supply the current license identity.

boolean isDeactivated = licenseManager.deactivateLicense(LicenseIdentity.fromKey("sample-key"));

getInstallationFile(LicenseIdentity identity)

Returns the latest valid installation file, if installation files are defined in the LicenseSpring platform. For more details please see Product Versioning

InstallationFile installationFile = licenseManager.getInstallationFile(LicenseIdentity.fromKey("sample-key"));

getVersions(LicenseIdentity identity)

Returns all available versions of the product app that are specified in LicenseSpring platform. For more details please see Product Versioning. Version class only contains String version.

trackVariables(LicenseIdentity identity, Map<String, String> variables)

Tracks device based variables for end uses. Can use the Variable builder as a utility.

// build your own Map
licenseManager.trackVariables(LicenseIdentity.fromKey("sample-key"), new HashMap<>);

// use utility class to add some variables and track them
DeviceVariables deviceVars = DeviceVariables.builder()
                .variable("one", "some value")
                .variable("another_var", "other_value")
                .build();

licenseManager.trackVariables(LicenseIdentity.fromKey("sample-key"), deviceVars.getVariables());

getProduct()

Gets product details from LicenseSpring servers.

Product product = licenseManager.getProductDetails();
log.info(product.getProductName());
log.info(product.getShortCode());
log.info(product.isAllowTrial());
log.info(product.getTrialDays());
log.info(product.getAuthorizationMethod());

getAirGapActivationCode

Gets the activation code used for air-gapped license.

Needs the LicenseSpringConfiguration field: airGappedPublicKey to work with Air Gap Licenses.

AirGappedActivation activation = licenseManager.getAirGapActivationCode(
	LicenseIdentity.fromKey("sample-key"), "initializationCodeFromPlatform"
);

log.info(activation.getActivationCode());
log.info(activation.getHardwareId());
log.info(activation.getLicenseKey());

activateAirGapResponse

Activates the air-gapped license from the license policy file.

Needs the LicenseSpringConfiguration field: airGappedPublicKey to work with Air Gap Licenses.

License license = licenseManager.activateAirGapResponse(
	LicenseIdentity.fromKey("sample-key"), 
  	"pathToPolicyFile",
    "policyId"
);

log.info(license.getHardwareId());
log.info(license.getIdentity().getLicenseKey());

verifyAirGapConfirmationCode

Verifies the confirmation code for air-gapped license.

Needs the LicenseSpringConfiguration field: airGappedPublicKey to work with Air Gap Licences.

boolean verified = licenseManager.verifyAirGapConfirmationCode(
	LicenseIdentity.fromKey("sample-key"), 
  	"policyIdFromPlatform",
    "confirmationCodeFromPlatform"
);

log.info(verified);