com.licensespring.floating

Class FloatingLicenseService

java.lang.Object

com.licensespring.floating.FloatingLicenseService

public class FloatingLicenseService
extends Object

All requests for floating cloud licenses should be done via this object. The object needs to be initialized before any other calls can be made.

Constructor Summary

Constructors

Constructor and Description
FloatingLicenseService(FloatingConfiguration configuration) Floating service has to be built using the FloatingConfiguration.

Method Summary

Modifier and Type	Method and Description
com.licensespring.LicenseData	activateLicense(com.licensespring.model.ActivationLicense identity) Activate the license.
void	addConsumption(com.licensespring.model.LicenseIdentity identity, int consumptions) Increases the consumptions on the license by the parameter provided.
void	addFeatureConsumption(com.licensespring.model.LicenseIdentity identity, String feature, Integer consumptions) Increases the consumptions of a feature by the provided parameter.
com.licensespring.dto.floating.LicenseBorrowResponse	borrowLicense(com.licensespring.model.LicenseIdentity identity, ZonedDateTime borrowedUntil) Borrows a license using provided license identity and a specified datetime until which the license is borrowed.
com.licensespring.dto.CheckResponse	checkLicense(com.licensespring.model.LicenseIdentity identity) Checks if license is valid and syncs local consumptions if configuration property enableLocalCaching is true.
com.licensespring.model.LicenseFeature	checkLicenseFeature(com.licensespring.model.LicenseIdentity identity, String featureCode) Check a license device against a license feature.
boolean	deactivateLicense(com.licensespring.model.LicenseIdentity identity) A license can be deactivated using this method, then the license can be used on another device.
com.licensespring.model.InstallationFile	installationFile(com.licensespring.model.LicenseIdentity identity) Gets the latest installation file for the product.
com.licensespring.model.Product	productDetails() Fetches product data from the server.
void	releaseFloatingFeature(com.licensespring.model.LicenseIdentity identity, String featureCode) Release a license device from a floating license feature.
void	releaseLicense(com.licensespring.model.LicenseIdentity identity) Releases a floating cloud license from current device and syncs local consumptions if configuration property enableLocalCaching is true.
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, com.licensespring.model.DeviceVariables variables) Tracks custom device variables which can be seen in the platform.
String[]	versions(com.licensespring.model.LicenseIdentity identity) Gets all the available versions for the product configured via configuration settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

FloatingLicenseService

public FloatingLicenseService(FloatingConfiguration configuration)

Floating service has to be built using the FloatingConfiguration.

Parameters:

configuration - build via the builder pattern

Method Detail

activateLicense

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

Activate the license. 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 LicenseData object

Throws:

com.licensespring.model.exceptions.LicenseSpringException

releaseLicense

public void releaseLicense(com.licensespring.model.LicenseIdentity identity)
                    throws com.licensespring.model.exceptions.LicenseSpringException

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

Parameters:

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

Throws:

com.licensespring.model.exceptions.LicenseSpringException

checkLicense

public com.licensespring.dto.CheckResponse checkLicense(com.licensespring.model.LicenseIdentity identity)
                                                 throws com.licensespring.model.exceptions.LicenseSpringException

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

Parameters:

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

Returns:

the CheckResponse object

Throws:

com.licensespring.model.exceptions.LicenseSpringException

addConsumption

public void addConsumption(com.licensespring.model.LicenseIdentity identity,
                           int consumptions)
                    throws com.licensespring.model.exceptions.LicenseSpringException

Increases the consumptions on the license by the parameter provided.

Parameters:

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

consumptions - number of consumptions

Throws:

com.licensespring.model.exceptions.LicenseSpringException

addFeatureConsumption

public void addFeatureConsumption(com.licensespring.model.LicenseIdentity identity,
                                  String feature,
                                  Integer consumptions)
                           throws com.licensespring.model.exceptions.LicenseSpringException

Increases the consumptions of a feature by the provided parameter.

Parameters:

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

feature - feature which was consumed

consumptions - number of consumptions

Throws:

com.licensespring.model.exceptions.LicenseSpringException

installationFile

public com.licensespring.model.InstallationFile installationFile(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

trackVariables

public void trackVariables(com.licensespring.model.LicenseIdentity identity,
                           com.licensespring.model.DeviceVariables variables)

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.

variables - map of variables you want to track

versions

public String[] versions(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

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:

true if deactivation was successful, false otherwise

Throws:

com.licensespring.model.exceptions.LicenseSpringException

productDetails

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

Fetches product data from the server.

Returns:

the Product object

Throws:

com.licensespring.model.exceptions.LicenseSpringException

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

borrowLicense

public com.licensespring.dto.floating.LicenseBorrowResponse borrowLicense(com.licensespring.model.LicenseIdentity identity,
                                                                          ZonedDateTime borrowedUntil)
                                                                   throws com.licensespring.model.exceptions.LicenseSpringException

Borrows a license using provided license identity and a specified datetime until which the license is borrowed.

Parameters:

identity - a LicenseIdentity object containing details for identifying the license to be borrowed.

borrowedUntil - a ZonedDateTime indicating until when the license should be borrowed.

Returns:

a LicenseBorrowResponse object containing details of the borrowed license.

Throws:

com.licensespring.model.exceptions.LicenseSpringException - if the API call encounters a client-side error, server-side error, or there’s an infrastructure error. The specific type of exception can provide more detailed context regarding the error.

releaseFloatingFeature

public void releaseFloatingFeature(com.licensespring.model.LicenseIdentity identity,
                                   String featureCode)
                            throws com.licensespring.model.exceptions.LicenseSpringException

Release a license device from a floating license feature.

Parameters:

identity - license identity

featureCode - feature code

Throws:

com.licensespring.model.exceptions.LicenseSpringException

checkLicenseFeature

public com.licensespring.model.LicenseFeature checkLicenseFeature(com.licensespring.model.LicenseIdentity identity,
                                                                  String featureCode)
                                                           throws com.licensespring.model.exceptions.LicenseSpringException

Check a license device against a license feature. Once checked this device will be connected to the feature. If a feature is a floating feature, device will also take one floating slot if available.

Parameters:

identity - license identity

featureCode - feature code

Returns:

check license feature response

Throws:

com.licensespring.model.exceptions.LicenseSpringException