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
com.licensespring.LicenseData	getLicense() Fetches license data from the server for the product specified in the ProxyConfiguration object.
com.licensespring.LicenseData	register() Register the user.
Boolean	serverHealthy() Check if the server is healthy.
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.

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

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

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

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