com.licensespring.api

Interface LicenseClientAPI

All Known Implementing Classes:

OfflineLicenseClientApi

public interface LicenseClientAPI

License APIs

Method Summary

Modifier and Type	Method and Description
com.licensespring.LicenseData	activateLicence(com.licensespring.dto.ActivationRequest request) Activate the license.
void	addConsumption(com.licensespring.dto.ConsumptionRequest request) Increases the consumptions by the parameter provided.
void	addFeatureConsumption(com.licensespring.dto.FeatureConsumptionRequest request) Increases the consumptions of a feature by the provided parameter.
com.licensespring.dto.CheckResponse	checkLicense(com.licensespring.dto.ActivationRequest request) Checks if license is valid and syncs local consumptions if configuration property enableLocalCaching is true.
String	deactivateLicence(com.licensespring.dto.LicenseRequest request) Releases a floating cloud license from current device and syncs local consumptions if configuration property enableLocalCaching is true.
com.licensespring.model.InstallationFile	installationFile(com.licensespring.dto.LicenseRequest request) Gets the latest installation file for the product.
com.licensespring.model.Product	productDetails(String product) Fetches product data from the server
void	trackVariables(com.licensespring.dto.VariableRequest request) Tracks custom device variables which can be seen in the platform.
com.licensespring.dto.UnactivatedTrialLicense	trialKey(com.licensespring.dto.TrialLicenseRequest request) This method provides a trial key.
List<com.licensespring.model.Version>	versions(com.licensespring.dto.LicenseRequest request) Gets all the available versions for the product configured via configuration settings

Method Detail

activateLicence

com.licensespring.LicenseData activateLicence(com.licensespring.dto.ActivationRequest request)

Activate the license. Licenses can be activated multiple times for the same device.

Parameters:

request - - DTO for transferring required data.

Returns:

the LicenseData object

deactivateLicence

String deactivateLicence(com.licensespring.dto.LicenseRequest request)

Releases a floating cloud license from current device and syncs local consumptions if configuration property enableLocalCaching is true.

Parameters:

request - - DTO for transferring required data.

checkLicense

com.licensespring.dto.CheckResponse checkLicense(com.licensespring.dto.ActivationRequest request)

Checks if license is valid and syncs local consumptions if configuration property enableLocalCaching is true.

Parameters:

request - - DTO for transferring required data.

Returns:

the CheckResponse object

versions

List<com.licensespring.model.Version> versions(com.licensespring.dto.LicenseRequest request)

Gets all the available versions for the product configured via configuration settings

Parameters:

request - - DTO for transferring required data.

Returns:

array of strings with all available versions

installationFile

com.licensespring.model.InstallationFile installationFile(com.licensespring.dto.LicenseRequest request)

Gets the latest installation file for the product.

Parameters:

request - - DTO for transferring required data.

Returns:

the installationFile object

trackVariables

void trackVariables(com.licensespring.dto.VariableRequest request)

Tracks custom device variables which can be seen in the platform. Variables are updated every time a new value is tracked for the same key and device.

Parameters:

request - - DTO for transferring required data.

addConsumption

void addConsumption(com.licensespring.dto.ConsumptionRequest request)

Increases the consumptions by the parameter provided.

Parameters:

request - - DTO for transferring required data.

addFeatureConsumption

void addFeatureConsumption(com.licensespring.dto.FeatureConsumptionRequest request)

Increases the consumptions of a feature by the provided parameter.

Parameters:

request - - DTO for transferring required data.

trialKey

com.licensespring.dto.UnactivatedTrialLicense trialKey(com.licensespring.dto.TrialLicenseRequest request)

This method provides a trial key. This is just a key, license requires additional activation.

Parameters:

request - DTO providing required info

Returns:

Unactivated trial license

productDetails

com.licensespring.model.Product productDetails(String product)

Fetches product data from the server

Parameters:

product - Product name

Returns:

Product