com.licensespring.floating.api

Interface ProxyAPI

public interface ProxyAPI

Proxy Floating License APIs.

Method Summary

Modifier and Type	Method and Description
feign.Response	addAirgapLicense(com.licensespring.dto.floating_server.airgap.license.request.AddAirgapLicenseReq req) Add airgap license.
com.licensespring.dto.floating_server.add_consumption.response.AddConsumptionResp	addConsumption(com.licensespring.dto.floating_server.add_consumption.request.AddConsumptionReq req) Add consumption.
com.licensespring.dto.floating_server.add_feature_consumption.response.AddFeatureConsumptionResp	addFeatureConsumption(com.licensespring.dto.floating_server.add_feature_consumption.request.AddFeatureConsumptionReq req) Add feature consumption.
feign.Response	addLicense(com.licensespring.dto.floating_server.add_product.query.AddLicenseQuery query) Add license.
BorrowResponse	borrow(ProxyRequest request) Borrows a license
ProxyFeatureResponse	checkLicenseFeature(ProxyFeatureRequest featureRequest) Check if a feature is licensed.
String	featureRelease(ProxyFeatureRequest featureRequest) Release a feature registration.
String	featureReleaseAll(ProxyFeatureRequest proxyRequest) Release all feature registrations for the user.
feign.Response	generateAirgapSignature(com.licensespring.dto.floating_server.airgap.generate.request.GenerateAirgapSignatureReq req) Generate airgap signature.
feign.Response	generateOfflineLicense(com.licensespring.dto.floating_server.license.generate.GenerateOfflineLicenseReq req) Generate offline license request.
com.licensespring.LicenseData	getLicense(String product) Retrieves the LicenseData object which contains information about the license for the product.
feign.Response	health() Pings the sever.
ProxyResponse	register(ProxyRequest proxyRequest) Register a user to the Floating Offline Server and takes up one user slot.
void	removeLicense(com.licensespring.dto.floating_server.remove_product.query.RemoveLicenseQuery query) Remove license.
feign.Response	setKeys(String apiKey, String sharedKey) Sets the Api and Shared keys
feign.Response	setPassword(String passwordOld, String passwordNew) Sets the web UI password
String	unregister(ProxyRequest proxyRequest) Unregisters the current user of the product and frees the space for other registrations.
feign.Response	unregisterAll() Unregisters all users
feign.Response	uploadOfflineLicense() Upload offline license file.

Method Detail

register

ProxyResponse register(ProxyRequest proxyRequest)

Register a user to the Floating Offline Server and takes up one user slot.

Parameters:

proxyRequest - - DTO for un/registering the license user.

Returns:

the LicenseData object

unregister

String unregister(ProxyRequest proxyRequest)

Unregisters the current user of the product and frees the space for other registrations.

Parameters:

proxyRequest - - DTO for un/registering the license user.

Returns:

Response object

getLicense

com.licensespring.LicenseData getLicense(String product)

Retrieves the LicenseData object which contains information about the license for the product.

Parameters:

product - - Parameter containing product code.

Returns:

LicenseData for the registered license

health

feign.Response health()

Pings the sever.

Returns:

the Response object

setPassword

feign.Response setPassword(String passwordOld,
                           String passwordNew)

Sets the web UI password

Returns:

the Response object

setKeys

feign.Response setKeys(String apiKey,
                       String sharedKey)

Sets the Api and Shared keys

Returns:

the Response object

unregisterAll

feign.Response unregisterAll()

Unregisters all users

Returns:

the Response object

borrow

BorrowResponse borrow(ProxyRequest request)

Borrows a license

Returns:

the Response object

generateOfflineLicense

feign.Response generateOfflineLicense(com.licensespring.dto.floating_server.license.generate.GenerateOfflineLicenseReq req)

Generate offline license request.

Parameters:

req - - Generate offline license request

Returns:

the Response object

uploadOfflineLicense

feign.Response uploadOfflineLicense()

Upload offline license file.

Returns:

the Response object

addLicense

feign.Response addLicense(com.licensespring.dto.floating_server.add_product.query.AddLicenseQuery query)

Add license.

Returns:

the Response object

removeLicense

void removeLicense(com.licensespring.dto.floating_server.remove_product.query.RemoveLicenseQuery query)

Remove license.

generateAirgapSignature

feign.Response generateAirgapSignature(com.licensespring.dto.floating_server.airgap.generate.request.GenerateAirgapSignatureReq req)

Generate airgap signature.

Returns:

the Response object

addAirgapLicense

feign.Response addAirgapLicense(com.licensespring.dto.floating_server.airgap.license.request.AddAirgapLicenseReq req)

Add airgap license.

Returns:

the Response object

addConsumption

com.licensespring.dto.floating_server.add_consumption.response.AddConsumptionResp addConsumption(com.licensespring.dto.floating_server.add_consumption.request.AddConsumptionReq req)

Add consumption.

Returns:

the Response object

addFeatureConsumption

com.licensespring.dto.floating_server.add_feature_consumption.response.AddFeatureConsumptionResp addFeatureConsumption(com.licensespring.dto.floating_server.add_feature_consumption.request.AddFeatureConsumptionReq req)

Add feature consumption.

Returns:

the Response object

checkLicenseFeature

ProxyFeatureResponse checkLicenseFeature(ProxyFeatureRequest featureRequest)

Check if a feature is licensed.

Parameters:

featureRequest - - DTO containing user, product, and feature information.

Returns:

Response object

featureRelease

String featureRelease(ProxyFeatureRequest featureRequest)

Release a feature registration.

Parameters:

featureRequest - - DTO containing user, product, and feature information.

Returns:

Response object

featureReleaseAll

String featureReleaseAll(ProxyFeatureRequest proxyRequest)

Release all feature registrations for the user.

Parameters:

proxyRequest - - DTO for un/registering the license user.

Returns:

Response object