com.licensespring.floating.api

Interface FloatingApi

public interface FloatingApi

Floating 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.floating.LicenseBorrowResponse	borrowLicense(com.licensespring.dto.floating.LicenseBorrowRequest request) Requests to borrow a license from the LicenseSpring API.
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.
com.licensespring.model.LicenseFeature	checkLicenseFeature(com.licensespring.dto.FloatingFeatureReq params) Use this endpoint to check a license device against a license feature.
String	deactivateLicense(com.licensespring.dto.LicenseRequest request) A license can be deactivated using this method, then the license can be used on another device
com.licensespring.model.InstallationFile	getInstallationFile(com.licensespring.dto.api.installation_file.query.InstallationFileQuery request) Gets the installation file for the product.
com.licensespring.model.Product	getProductDetails(com.licensespring.dto.api.product_details.query.ProductDetailsQuery params) Fetches product data from the server
List<com.licensespring.model.Version>	getProductVersions(com.licensespring.dto.api.versions.query.ProductVersionsQuery request) Gets all the available versions for the product configured via configuration settings
void	releaseFloatingFeature(com.licensespring.dto.FloatingFeatureReq request) Use this endpoint to release a license device from a floating license feature.
void	releaseLicense(com.licensespring.dto.LicenseRequest request) Releases a floating cloud license from current device and syncs local consumptions if configuration property enableLocalCaching is true.
void	trackVariables(com.licensespring.dto.VariableRequest request) Tracks custom device variables which can be seen in the platform.

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

releaseLicense

void releaseLicense(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

getProductVersions

List<com.licensespring.model.Version> getProductVersions(com.licensespring.dto.api.versions.query.ProductVersionsQuery request)

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

Parameters:

request - - DTO for transferring required data.

Returns:

list of all available versions

getInstallationFile

com.licensespring.model.InstallationFile getInstallationFile(com.licensespring.dto.api.installation_file.query.InstallationFileQuery request)

Gets the 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.

getProductDetails

com.licensespring.model.Product getProductDetails(com.licensespring.dto.api.product_details.query.ProductDetailsQuery params)

Fetches product data from the server

Parameters:

params - params

Returns:

Product

deactivateLicense

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

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

Parameters:

request - - DTO for transferring required data.

Returns:

borrowLicense

com.licensespring.dto.floating.LicenseBorrowResponse borrowLicense(com.licensespring.dto.floating.LicenseBorrowRequest request)

Requests to borrow a license from the LicenseSpring API.

This endpoint allows a device to borrow a license, provided the LicenseBorrowRequest contains valid parameters. Upon a successful API call, the borrowed license details and status are returned encapsulated in a LicenseBorrowResponse object. Endpoint: POST /floating/borrow

Parameters:

request - the data object containing parameters necessary for borrowing a license, encapsulated in a LicenseBorrowRequest object.

Returns:

a LicenseBorrowResponse object containing the details of the borrowed license and its validity period, or containing error details in case the API call fails.

Throws:

com.licensespring.model.exceptions.validation.ServerValidationException - if the API call encounters a client-side error (4xx), with details provided in the ErrorResponse from the server.

com.licensespring.model.exceptions.infrastructure.ServerError - if the API call encounters a server-side error (5xx), with a message containing details about the method and the response status.

com.licensespring.model.exceptions.infrastructure.InfrastructureException - if there’s an IOException.

releaseFloatingFeature

void releaseFloatingFeature(com.licensespring.dto.FloatingFeatureReq request)

Use this endpoint to release a license device from a floating license feature.

Parameters:

request - request

checkLicenseFeature

com.licensespring.model.LicenseFeature checkLicenseFeature(com.licensespring.dto.FloatingFeatureReq params)

Use this endpoint to 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:

params - params

Returns:

check license feature response