com.licensespring.floating

Class ProxyFloatingService

java.lang.Object

com.licensespring.floating.ProxyFloatingService

public class ProxyFloatingService
extends Object

All request for offline floating licenses should be done via this object. The object needs to be initialized before any calls are made.

Constructor Summary

Constructors

Constructor and Description
ProxyFloatingService(ProxyConfiguration proxyConfiguration) Proxy floating service has to be built using the ProxyConfiguration.

Method Summary

Modifier and Type	Method and Description
void	addAirgapLicense(com.licensespring.dto.proxy_floating_service.AddAirgapLicenseParams params)
com.licensespring.dto.floating_server.add_consumption.response.AddConsumptionResp	addConsumption(com.licensespring.dto.proxy_floating_service.AddConsumptionParams params)
AddConsumptionToFeatureResponse	addConsumptionToFeatureV2(Long licenseId, AddConsumptionToFeatureRequest payload)
AddConsumptionToLicenseResponse	addConsumptionToLicenseV2(Long licenseId, AddConsumptionToLicenseRequest payload)
com.licensespring.dto.floating_server.add_feature_consumption.response.AddFeatureConsumptionResp	addFeatureConsumption(com.licensespring.dto.proxy_floating_service.AddFeatureConsumptionParams params)
void	addLicense(com.licensespring.dto.proxy_floating_service.AddLicenseParams params)
AddLicenseResponse	addLicenseV2(com.licensespring.dto.proxy_floating_service.AddLicenseParams params)
AddUserResponse	addUser(AddUserRequest payload)
BorrowResponse	borrow() Borrows a license slot if the license has that feature enabled
BorrowLicenseResponse	borrowLicenseV2(Long licenseId, BorrowLicenseParams payload) Borrows a license slot if the license has that feature enabled
ChangePasswordResponse	changePassword(ChangePasswordRequest payload)
ProxyFeatureResponse	checkLicenseFeature(String feature) Check if a feature is licensed.
String	generateAirgapSignature(com.licensespring.dto.proxy_floating_service.GenerateAirgapSignatureParams params)
void	generateOfflineLicense(String licenseKey)
com.licensespring.LicenseData	getLicense() Fetches license data from the server for the product specified in the ProxyConfiguration object.
com.licensespring.LicenseData	getLicenseById(Long id)
List<com.licensespring.LicenseData>	getLicenses()
boolean	isV2Api()
LoginResponse	login(LoginRequest payload)
com.licensespring.LicenseData	register() Register the user.
RegisterFeatureForUserResponse	registerFeatureForUserV2(Long licenseId, RegisterFeatureForUserRequest payload)
com.licensespring.LicenseData	registerUserToLicenseV2(Long licenseId, RegisterUserToLicenseRequest payload)
boolean	releaseAllFeatures(String feature) Release all feature registrations for the user.
boolean	releaseFeature(String feature) Release a feature registration.
void	removeLicense()
RemoveLicenseResponse	removeLicenseById(Long id)
RemoveUserResponse	removeUser(RemoveUserRequest payload)
boolean	serverHealthy() Check if the server is healthy.
boolean	setKeys(String apiKey, String sharedKey) Sets the apiKey and sharedKey on the floating server
boolean	setPassword(String oldPassword, String newPassword) Changes the password on the floating server (or for the user if RBAC is enabled)
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
boolean	unregister() Unregister the user.
boolean	unregisterAll() Unregisters all users
void	unregisterFeatureForUserV2(Long licenseId, UnregisterFeatureForUserRequest payload)
void	unregisterUserFromLicenseV2(Long licenseId, UnregisterUserFromLicenseRequest payload)
void	uploadOfflineLicense()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyFloatingService

public ProxyFloatingService(ProxyConfiguration proxyConfiguration)

Proxy floating service has to be built using the ProxyConfiguration.

Parameters:

proxyConfiguration - build via the builder pattern

Method Detail

isV2Api

public boolean isV2Api()

register

public com.licensespring.LicenseData register()
                                       throws com.licensespring.model.exceptions.LicenseSpringException

Register the user. Each registration lasts for the time specified in the LicenseSpring platform for the specific product (Floating timeout). In order to prolong the registration time this needs to be called periodically (leave enablePeriodicCheck property in ProxyConfiguration enabled, or call this method periodically).

Returns:

the LicenseData object

Throws:

com.licensespring.model.exceptions.LicenseSpringException

unregister

public boolean unregister()
                   throws com.licensespring.model.exceptions.LicenseSpringException

Unregister the user. Removes the user registration from the server and frees up one user spot.

Returns:

true if the action was successful, false otherwise

Throws:

com.licensespring.model.exceptions.LicenseSpringException

getLicense

public com.licensespring.LicenseData getLicense()
                                         throws com.licensespring.model.exceptions.LicenseSpringException

Fetches license data from the server for the product specified in the ProxyConfiguration object.

Returns:

the LicenseData object

Throws:

com.licensespring.model.exceptions.LicenseSpringException

getLicenses

public List<com.licensespring.LicenseData> getLicenses()
                                                throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException

serverHealthy

public boolean serverHealthy()
                      throws com.licensespring.model.exceptions.LicenseSpringException

Check if the server is healthy.

Returns:

true if the health check was successful, false otherwise

Throws:

com.licensespring.model.exceptions.LicenseSpringException

setPassword

public boolean setPassword(String oldPassword,
                           String newPassword)
                    throws com.licensespring.model.exceptions.LicenseSpringException

Changes the password on the floating server (or for the user if RBAC is enabled)

Returns:

true if the password was changed

Throws:

com.licensespring.model.exceptions.LicenseSpringException

changePassword

public ChangePasswordResponse changePassword(ChangePasswordRequest payload)
                                      throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException

setKeys

public boolean setKeys(String apiKey,
                       String sharedKey)
                throws com.licensespring.model.exceptions.LicenseSpringException

Sets the apiKey and sharedKey on the floating server

Returns:

true if the keys were changed

Throws:

com.licensespring.model.exceptions.LicenseSpringException

unregisterAll

public boolean unregisterAll()
                      throws com.licensespring.model.exceptions.LicenseSpringException

Unregisters all users

Returns:

true if the password was changed

Throws:

com.licensespring.model.exceptions.LicenseSpringException

borrow

public BorrowResponse borrow()
                      throws com.licensespring.model.exceptions.LicenseSpringException

Borrows a license slot if the license has that feature enabled

Returns:

the BorrowResponse object

Throws:

com.licensespring.model.exceptions.LicenseSpringException

borrowLicenseV2

public BorrowLicenseResponse borrowLicenseV2(Long licenseId,
                                             BorrowLicenseParams payload)
                                      throws com.licensespring.model.exceptions.LicenseSpringException

Borrows a license slot if the license has that feature enabled

Returns:

the BorrowResponse object

Throws:

com.licensespring.model.exceptions.LicenseSpringException

registerUserToLicenseV2

public com.licensespring.LicenseData registerUserToLicenseV2(Long licenseId,
                                                             RegisterUserToLicenseRequest payload)
                                                      throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException

unregisterUserFromLicenseV2

public void unregisterUserFromLicenseV2(Long licenseId,
                                        UnregisterUserFromLicenseRequest payload)
                                 throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException

registerFeatureForUserV2

public RegisterFeatureForUserResponse registerFeatureForUserV2(Long licenseId,
                                                               RegisterFeatureForUserRequest payload)
                                                        throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException

unregisterFeatureForUserV2

public void unregisterFeatureForUserV2(Long licenseId,
                                       UnregisterFeatureForUserRequest payload)
                                throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException

addConsumptionToLicenseV2

public AddConsumptionToLicenseResponse addConsumptionToLicenseV2(Long licenseId,
                                                                 AddConsumptionToLicenseRequest payload)
                                                          throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException

addConsumptionToFeatureV2

public AddConsumptionToFeatureResponse addConsumptionToFeatureV2(Long licenseId,
                                                                 AddConsumptionToFeatureRequest payload)
                                                          throws com.licensespring.model.exceptions.LicenseSpringException

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

generateOfflineLicense

public void generateOfflineLicense(String licenseKey)
                            throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException

uploadOfflineLicense

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

Throws:

com.licensespring.model.exceptions.LicenseSpringException

addLicense

public void addLicense(com.licensespring.dto.proxy_floating_service.AddLicenseParams params)
                throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException

addLicenseV2

public AddLicenseResponse addLicenseV2(com.licensespring.dto.proxy_floating_service.AddLicenseParams params)
                                throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException

getLicenseById

public com.licensespring.LicenseData getLicenseById(Long id)
                                             throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException

removeLicenseById

public RemoveLicenseResponse removeLicenseById(Long id)
                                        throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException

removeLicense

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

Throws:

com.licensespring.model.exceptions.LicenseSpringException

generateAirgapSignature

public String generateAirgapSignature(com.licensespring.dto.proxy_floating_service.GenerateAirgapSignatureParams params)
                               throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException

addAirgapLicense

public void addAirgapLicense(com.licensespring.dto.proxy_floating_service.AddAirgapLicenseParams params)
                      throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException

addConsumption

public com.licensespring.dto.floating_server.add_consumption.response.AddConsumptionResp addConsumption(com.licensespring.dto.proxy_floating_service.AddConsumptionParams params)
                                                                                                 throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException

addFeatureConsumption

public com.licensespring.dto.floating_server.add_feature_consumption.response.AddFeatureConsumptionResp addFeatureConsumption(com.licensespring.dto.proxy_floating_service.AddFeatureConsumptionParams params)
                                                                                                                       throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException

checkLicenseFeature

public ProxyFeatureResponse checkLicenseFeature(String feature)
                                         throws com.licensespring.model.exceptions.LicenseSpringException

Check if a feature is licensed.

Parameters:

feature - The feature code to check

Returns:

the LicenseData object

Throws:

com.licensespring.model.exceptions.LicenseSpringException

releaseFeature

public boolean releaseFeature(String feature)
                       throws com.licensespring.model.exceptions.LicenseSpringException

Release a feature registration.

Parameters:

feature - The feature code to release

Returns:

true if the action was successful, false otherwise

Throws:

com.licensespring.model.exceptions.LicenseSpringException

releaseAllFeatures

public boolean releaseAllFeatures(String feature)
                           throws com.licensespring.model.exceptions.LicenseSpringException

Release all feature registrations for the user.

Returns:

true if the action was successful, false otherwise

Throws:

com.licensespring.model.exceptions.LicenseSpringException

addUser

public AddUserResponse addUser(AddUserRequest payload)
                        throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException

removeUser

public RemoveUserResponse removeUser(RemoveUserRequest payload)
                              throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException

login

public LoginResponse login(LoginRequest payload)
                    throws com.licensespring.model.exceptions.LicenseSpringException

Throws:

com.licensespring.model.exceptions.LicenseSpringException