com.licensespring

Class LicenseManager

java.lang.Object

com.licensespring.LicenseManager

public class LicenseManager
extends Object

A singleton instance of the LicenseManager can be gotten via .getInstance() call All requests should be done via this object. The object needs to be initialized before any other calls can be made.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LicenseManager()

Method Summary

Modifier and Type	Method and Description
License	activateLicense(com.licensespring.model.ActivationLicense identity) Activate the license on the remove server.
License	activateOfflineResponse(com.licensespring.model.LicenseIdentity identity, InputStream inputStream) Activates the license using ls_activation.lic file that was generated using LicenseSpring platform.
License	activateOfflineResponse(com.licensespring.model.LicenseIdentity identity, String filePath) Activates the license using ls_activation.lic file that was generated using LicenseSpring platform.
License	checkLicense(License license) Check license call.
void	clearLocalStorage() Clears all local license data.
boolean	deactivateLicense(com.licensespring.model.LicenseIdentity identity) A license can be deactivated using this method, then the license can be used on another device
License	getCurrent() Returns the license from the local license file Updates the usage timestamp if offline mode, check locally for clock tampering before setting usage timestamp
com.licensespring.model.InstallationFile	getInstallationFile(com.licensespring.model.LicenseIdentity identity) Gets the latest installation file for the product.
static LicenseManager	getInstance() Thread-safe method to obtain the instance of LicenseManager
com.licensespring.model.Product	getProductDetails() Fetches product data from the server
com.licensespring.dto.UnactivatedTrialLicense	getTrialLicense(com.licensespring.model.Customer customer) For a trial period an email must be provided
com.licensespring.dto.UnactivatedTrialLicense	getTrialLicense(String email) For a trial period an email must be provided
String[]	getVersions(com.licensespring.model.LicenseIdentity identity) Gets all the available versions for the product configured via configuration settings
void	initialize(LicenseSpringConfiguration configuration) Should be called once per runtime.
void	initialize(LicenseSpringConfiguration configuration, com.licensespring.internal.services.LicenseRepository repository) Should be called once per runtime.
boolean	isInitialized() Checks if the LicenseManger has been initialized
String	offlineActivationFile(com.licensespring.model.LicenseIdentity identity, String destination) Generates an offline activation file.
void	offlineActivationStream(com.licensespring.model.LicenseIdentity identity, OutputStream outputStream) Generates an offline activation request.
String	offlineDeactivationFile(com.licensespring.model.LicenseIdentity identity, String destination) Generates an offline deactivation file.
void	offlineDeactivationStream(com.licensespring.model.LicenseIdentity identity, OutputStream outputStream) Generates an offline deactivation request.
void	shutdownScheduler() Calls ExecutorService.shutdownNow() for the periodic check executor, if period check is enabled Used for cases where JVM doesn't get the shutdown signal and keeps a thread running indefinitely
void	trackVariables(com.licensespring.model.LicenseIdentity identity, Map<String,String> variables) Tracks custom device variables which can be seen in the platform.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LicenseManager

protected LicenseManager()

Method Detail

getInstance

public static LicenseManager getInstance()

Thread-safe method to obtain the instance of LicenseManager

Returns:

the LicenseManager instance

initialize

public void initialize(LicenseSpringConfiguration configuration)
                throws com.licensespring.model.exceptions.LicenseSpringException

Should be called once per runtime. The initialization also checks the existence of a local license. If the hardware id has changed, the local license will be deleted.

Parameters:

configuration - the configuration object containing required parameters.

Throws:

com.licensespring.model.exceptions.LicenseSpringException

initialize

public void initialize(LicenseSpringConfiguration configuration,
                       com.licensespring.internal.services.LicenseRepository repository)
                throws com.licensespring.model.exceptions.LicenseSpringException

Should be called once per runtime. The initialization also checks the existence of a local license. If the hardware id has changed, the local license will be deleted.

Parameters:

configuration - the configuration object containing required parameters.

repository - - sdk users can implement their own local license persistence using this method overload

Throws:

com.licensespring.model.exceptions.LicenseSpringException

getCurrent

public License getCurrent()
                   throws com.licensespring.model.exceptions.LicenseSpringException

Returns the license from the local license file Updates the usage timestamp if offline mode, check locally for clock tampering before setting usage timestamp

Returns:

the license instance

Throws:

com.licensespring.model.exceptions.LicenseSpringException

getTrialLicense

public com.licensespring.dto.UnactivatedTrialLicense getTrialLicense(String email)
                                                              throws com.licensespring.model.exceptions.LicenseSpringException

For a trial period an email must be provided

Parameters:

email - - email of the user who is signing up for the trial

Returns:

a UnactivatedTrialLicense - this license must be activated to be used.

Throws:

com.licensespring.model.exceptions.LicenseSpringException

getTrialLicense

public com.licensespring.dto.UnactivatedTrialLicense getTrialLicense(com.licensespring.model.Customer customer)
                                                              throws com.licensespring.model.exceptions.LicenseSpringException

For a trial period an email must be provided

Parameters:

customer - - customer object, can be build using the builder. Only email is required

Returns:

a UnactivatedTrialLicense - this license must be activated to be used.

Throws:

com.licensespring.model.exceptions.LicenseSpringException

activateLicense

public License activateLicense(com.licensespring.model.ActivationLicense identity)
                        throws com.licensespring.model.exceptions.LicenseSpringException

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

Parameters:

identity - - license key or (username and password) use the ActivationLicense factory methods to build.

Returns:

the activated License object

Throws:

com.licensespring.model.exceptions.LicenseSpringException

deactivateLicense

public boolean deactivateLicense(com.licensespring.model.LicenseIdentity identity)
                          throws com.licensespring.model.exceptions.LicenseSpringException

A license can be deactivated using this method, then the license can be used on another device

Parameters:

identity - - license key or username use the LicenseIdentity factory methods to build.

Returns:

- if the deactivation was successful

Throws:

com.licensespring.model.exceptions.LicenseSpringException

checkLicense

public License checkLicense(License license)
                     throws com.licensespring.model.exceptions.LicenseSpringException

Check license call. Method syncs any consumptions made (feature or c The license passed is not the same as the license object passed to the method. The returned license is recreated from the LS servers - note that If the grace period is set on the SDK configuration, a ServerError or ConnectionException will perform a local check of the license object - after the grace period has passed, and the check is performed again the method will rethrow the exception, instead if the server returns 400 - license_not_found (deleted license), the license file is deleted from the repository

Parameters:

license - - the license can be gotten via the getCurrent() method on the LicenseManager

Returns:

the updated license -

Throws:

com.licensespring.model.exceptions.LicenseSpringException

getInstallationFile

public com.licensespring.model.InstallationFile getInstallationFile(com.licensespring.model.LicenseIdentity identity)
                                                             throws com.licensespring.model.exceptions.LicenseSpringException

Gets the latest installation file for the product.

Parameters:

identity - - license key or username use the LicenseIdentity factory methods to build.

Returns:

the installationFile object

Throws:

com.licensespring.model.exceptions.LicenseSpringException

getVersions

public String[] getVersions(com.licensespring.model.LicenseIdentity identity)
                     throws com.licensespring.model.exceptions.LicenseSpringException

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

Parameters:

identity - - license key or username use the LicenseIdentity factory methods to build.

Returns:

array of strings with all available versions

Throws:

com.licensespring.model.exceptions.LicenseSpringException

trackVariables

public void trackVariables(com.licensespring.model.LicenseIdentity identity,
                           Map<String,String> variables)
                    throws com.licensespring.model.exceptions.LicenseSpringException

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:

identity - - license key or username use the LicenseIdentity factory methods to build.

Throws:

com.licensespring.model.exceptions.LicenseSpringException

clearLocalStorage

public void clearLocalStorage()
                       throws com.licensespring.model.exceptions.LicenseSpringException

Clears all local license data.

Throws:

com.licensespring.model.exceptions.LicenseSpringException

getProductDetails

public com.licensespring.model.Product getProductDetails()
                                                  throws com.licensespring.model.exceptions.LicenseSpringException

Fetches product data from the server

Returns:

Product information

Throws:

com.licensespring.model.exceptions.LicenseSpringException

offlineActivationStream

public void offlineActivationStream(com.licensespring.model.LicenseIdentity identity,
                                    OutputStream outputStream)

Generates an offline activation request. The offline request needs to passed to the server. The response the The method does not close the passed input stream, the caller should close the owned stream.

Parameters:

identity - license key or username use the LicenseIdentity factory methods to build.

outputStream - the stream to write the offline deactivation request

offlineActivationFile

public String offlineActivationFile(com.licensespring.model.LicenseIdentity identity,
                                    String destination)

Generates an offline activation file. The file needs to be activated by uploading it to the LicenseSpring platform.

Parameters:

identity - license key or username use the LicenseIdentity factory methods to build.

Returns:

Path to the activation file that was generated

Throws:

com.licensespring.model.exceptions.LicenseSpringException

offlineDeactivationFile

public String offlineDeactivationFile(com.licensespring.model.LicenseIdentity identity,
                                      String destination)

Generates an offline deactivation file. The file needs to be activated by uploading it to the LicenseSpring platform.

Parameters:

identity - license key or username use the LicenseIdentity factory methods to build.

destination - - the destination file. If null, the SDK will attempt to locate the user Desktop on any platform. If the Desktop folder doesn't exist, it will save the file in user home. Default name is ls_deactivation.req

Returns:

Path to the activation file that was generated

Throws:

com.licensespring.model.exceptions.LicenseSpringException

offlineDeactivationStream

public void offlineDeactivationStream(com.licensespring.model.LicenseIdentity identity,
                                      OutputStream outputStream)

Generates an offline deactivation request. The offline request needs to passed to the server. Deletes local license storage after the request is generated and written to the stream. The method does not close the passed input stream, the caller should close the owned stream.

Parameters:

identity - license key or username use the LicenseIdentity factory methods to build.

outputStream - the stream to write the offline deactivation request

Throws:

com.licensespring.model.exceptions.LicenseSpringException

activateOfflineResponse

public License activateOfflineResponse(com.licensespring.model.LicenseIdentity identity,
                                       String filePath)

Activates the license using ls_activation.lic file that was generated using LicenseSpring platform.

Parameters:

identity - license key or username use the LicenseIdentity factory methods to build.

filePath - - the source file. If null, the SDK will attempt to locate the user Desktop on any platform. If the Desktop folder doesn't exist, it will load the file from user home. Default name is ls_activation.lic

Returns:

the activated License

Throws:

com.licensespring.model.exceptions.LicenseSpringException

activateOfflineResponse

public License activateOfflineResponse(com.licensespring.model.LicenseIdentity identity,
                                       InputStream inputStream)

Activates the license using ls_activation.lic file that was generated using LicenseSpring platform. The method does not close the passed input stream, the caller should close the owned stream.

Parameters:

identity - license key or username use the LicenseIdentity factory methods to build.

inputStream - the input stream containing the server response to offline activation

Returns:

the activated License

Throws:

com.licensespring.model.exceptions.LicenseSpringException

isInitialized

public boolean isInitialized()

Checks if the LicenseManger has been initialized

Returns:

the initialization status of the LicenseManager singleton

shutdownScheduler

public void shutdownScheduler()

Calls ExecutorService.shutdownNow() for the periodic check executor, if period check is enabled Used for cases where JVM doesn't get the shutdown signal and keeps a thread running indefinitely