A B C D E F G H I O P R S T U V

A

activateLicence(ActivationRequest) - Method in interface com.licensespring.floating.api.FloatingApi

Activate the license.

activateLicense(ActivationLicense) - Method in class com.licensespring.floating.FloatingLicenseService

Activate the license.

addConsumption(ConsumptionRequest) - Method in interface com.licensespring.floating.api.FloatingApi

Increases the consumptions by the parameter provided.

addConsumption(LicenseIdentity, int) - Method in class com.licensespring.floating.FloatingLicenseService

Increases the consumptions on the license by the parameter provided.

addFeatureConsumption(FeatureConsumptionRequest) - Method in interface com.licensespring.floating.api.FloatingApi

Increases the consumptions of a feature by the provided parameter.

addFeatureConsumption(LicenseIdentity, String, Integer) - Method in class com.licensespring.floating.FloatingLicenseService

Increases the consumptions of a feature by the provided parameter.

addFuture(LicenseIdentity, ScheduledFuture) - Method in class com.licensespring.floating.ShutdownHooks

Adds new future for the given identity key.

addIdentity(LicenseIdentity) - Method in class com.licensespring.floating.ShutdownHooks

Adds new identity.

addShutdownHook(boolean) - Method in class com.licensespring.floating.FloatingConfiguration.FloatingConfigurationBuilder

Shutdown hooks are created for all activated licenses during the lifetime.

addShutdownHook(boolean) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

Shutdown hooks are created for the registered user for specific product.

B

BorrowedLicenseExpirationSubscriber - Interface in com.licensespring.floating

borrowedLicenseExpirationSubscriber(BorrowedLicenseExpirationSubscriber) - Method in class com.licensespring.floating.FloatingConfiguration.FloatingConfigurationBuilder

Assigns a BorrowedLicenseExpirationSubscriber instance to be used for handling borrowed license expiration events.

BorrowedLicenseExpirationSubscriber.IgnoreEventSubscriber - Class in com.licensespring.floating

Default do-nothing subscriber.

borrowLicense(LicenseBorrowRequest) - Method in interface com.licensespring.floating.api.FloatingApi

Requests to borrow a license from the LicenseSpring API.

borrowLicense(LicenseIdentity, ZonedDateTime) - Method in class com.licensespring.floating.FloatingLicenseService

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

build() - Method in class com.licensespring.floating.dto.ProxyRequest.ProxyRequestBuilder

build() - Method in class com.licensespring.floating.FloatingConfiguration.FloatingConfigurationBuilder

Build the floating configuration.

build() - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

Builds the ProxyConfiguration.

builder() - Static method in class com.licensespring.floating.dto.ProxyRequest

builder() - Static method in class com.licensespring.floating.FloatingConfiguration

Use this builder to construct FloatingConfiguration.

builder() - Static method in class com.licensespring.floating.ProxyConfiguration

Use this builder to construct the ProxyConfiguration.

buildFeign(FloatingConfiguration, Gson, AuthorizationService) - Static method in class com.licensespring.floating.api.FloatingApiFactory

Builds FloatingApi.

buildFeign(ProxyConfiguration, Gson) - Static method in class com.licensespring.floating.api.ProxyApiFactory

Builds ProxyAPI.

C

cacheHardwareID(boolean) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

canEqual(Object) - Method in class com.licensespring.floating.FloatingConfiguration

checkLicense(ActivationRequest) - Method in interface com.licensespring.floating.api.FloatingApi

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

checkLicense(LicenseIdentity) - Method in class com.licensespring.floating.FloatingLicenseService

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

checkLicenseFeature(FloatingFeatureReq) - Method in interface com.licensespring.floating.api.FloatingApi

Use this endpoint to check a license device against a license feature.

checkLicenseFeature(LicenseIdentity, String) - Method in class com.licensespring.floating.FloatingLicenseService

Check a license device against a license feature.

CheckLicenseSubscriber - Interface in com.licensespring.floating

The CheckLicense subscriber is a way to get notified when the background check completes.

CheckLicenseSubscriber.IgnoreCheckEventSubscriber - Class in com.licensespring.floating

Default do-nothing class.

checkSubscriber(CheckLicenseSubscriber) - Method in class com.licensespring.floating.FloatingConfiguration.FloatingConfigurationBuilder

Add the CheckLicenseSubscriber implementation, which receives events on a background thread, which periodically call the check API.

com.licensespring.floating - package com.licensespring.floating

This package contains the main public classes to be used when implementing the LicenseSpring Floating Client.

com.licensespring.floating.api - package com.licensespring.floating.api

This package contains all classes required to successfully call FloatingApi or ProxyAPI.

com.licensespring.floating.dto - package com.licensespring.floating.dto

This package contains all DTO classes required to make requests to floating server, either floating cloud or on-premises server.

connectionSpecs(List<ConnectionSpec>) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

createShutdownHook() - Method in class com.licensespring.floating.ProxyShutdownHook

Creates new shutdown hook.

createShutdownHook() - Method in class com.licensespring.floating.ShutdownHooks

Creates new shutdown hook.

D

deactivateLicense(LicenseRequest) - Method in interface com.licensespring.floating.api.FloatingApi

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

deactivateLicense(LicenseIdentity) - Method in class com.licensespring.floating.FloatingLicenseService

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

E

enablePeriodicCheck(boolean) - Method in class com.licensespring.floating.FloatingConfiguration.FloatingConfigurationBuilder

Enable periodic check invocation.

enablePeriodicCheck(boolean) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

Enable periodic registration invocation.

enablePeriodicRegister(boolean) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

If true, this property enables periodic calls to register method to prolong the valid registration period.

enableRetrying(boolean) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

equals(Object) - Method in class com.licensespring.floating.dto.ProxyRequest

equals(Object) - Method in class com.licensespring.floating.dto.ProxyResponse

equals(Object) - Method in class com.licensespring.floating.FloatingConfiguration

equals(Object) - Method in class com.licensespring.floating.ProxyConfiguration

F

FloatingApi - Interface in com.licensespring.floating.api

Floating License APIs.

FloatingApiFactory - Class in com.licensespring.floating.api

Api factory for building FloatingApi.

FloatingConfiguration - Class in com.licensespring.floating

Floating configuration object.

FloatingConfiguration.FloatingConfigurationBuilder - Class in com.licensespring.floating

The Floating SDK configuration builder.

FloatingLicenseService - Class in com.licensespring.floating

All requests for floating cloud licenses should be done via this object.

FloatingLicenseService(FloatingConfiguration) - Constructor for class com.licensespring.floating.FloatingLicenseService

Floating service has to be built using the FloatingConfiguration.

G

getApiUrl() - Method in class com.licensespring.floating.ProxyConfiguration

Retrieves the URL of the proxy server.

getBorrowedLicenseExpirationSubscriber() - Method in class com.licensespring.floating.FloatingConfiguration

BorrowedLicenseExpirationSubscriber is an interface to be used for handling borrowed license expiration events.

getCheckLicenseSubscriber() - Method in class com.licensespring.floating.FloatingConfiguration

CheckSubscriber is an interface that provides two methods (onSuccess and onError), it is used to monitor the response from the periodic checks.

getConnectionSpecs() - Method in class com.licensespring.floating.ProxyConfiguration

Specifies configuration for the socket connection that HTTP traffic travels through.

getData(Gson) - Method in class com.licensespring.floating.dto.ProxyResponse

getHost() - Method in class com.licensespring.floating.ProxyConfiguration

Required parameter.

getHostnameVerifier() - Method in class com.licensespring.floating.ProxyConfiguration

Verifier used to confirm that response certificates apply to requested hostnames for HTTPS connections.

getIdentity(Gson) - Method in class com.licensespring.floating.dto.ProxyResponse

getIdentityProvider() - Method in class com.licensespring.floating.ProxyConfiguration

Set a custom IdentityProvider which generates unique keys for a particular device Default implementation is based on ONCE_PER_PROCESS id.

getLicense(String) - Method in interface com.licensespring.floating.api.ProxyAPI

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

getLicense() - Method in class com.licensespring.floating.ProxyFloatingService

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

getLicenseJson() - Method in class com.licensespring.floating.dto.ProxyResponse

getLicenseJsonSnakeCase() - Method in class com.licensespring.floating.dto.ProxyResponse

getLicenseSpringAPIVersion() - Method in class com.licensespring.floating.ProxyConfiguration

LicenseSpring API version.

getPort() - Method in class com.licensespring.floating.ProxyConfiguration

Required parameter.

getProduct() - Method in class com.licensespring.floating.dto.ProxyRequest

Product code.

getProduct() - Method in class com.licensespring.floating.ProxyConfiguration

Required parameter, every license is attached to a particular product.

getProxyCertPath() - Method in class com.licensespring.floating.ProxyConfiguration

Optional parameter, used to configure client to trust proxy certificate.

getProxyHost() - Method in class com.licensespring.floating.ProxyConfiguration

Optional parameter, used to configure all API calls to use a proxy service.

getProxyPass() - Method in class com.licensespring.floating.ProxyConfiguration

Optional parameter, used to configure Basic authentication for a proxy service.

getProxyPort() - Method in class com.licensespring.floating.ProxyConfiguration

Optional parameter, used to configure all API calls to use a proxy service.

getProxyRegisterSubscriber() - Method in class com.licensespring.floating.ProxyConfiguration

ProxyRegisterSubscriber is an interface that provides two methods (onSuccess and onError), it is used to monitor the response from the periodic registers.

getProxyUser() - Method in class com.licensespring.floating.ProxyConfiguration

Optional parameter, used to configure Basic authentication for a proxy service.

getRequestLogging() - Method in class com.licensespring.floating.ProxyConfiguration

HTTP Request/Response logging for debugging purposes.

getRequestTimeout() - Method in class com.licensespring.floating.ProxyConfiguration

Optional parameter for setting the timeout when making api requests (in seconds) default is 10 seconds

getUser() - Method in class com.licensespring.floating.dto.ProxyRequest

Unique user identification.

H

hashCode() - Method in class com.licensespring.floating.dto.ProxyRequest

hashCode() - Method in class com.licensespring.floating.dto.ProxyResponse

hashCode() - Method in class com.licensespring.floating.FloatingConfiguration

hashCode() - Method in class com.licensespring.floating.ProxyConfiguration

health() - Method in interface com.licensespring.floating.api.ProxyAPI

Pings the sever.

host(String) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

hostnameVerifier(HostnameVerifier) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

I

identityProvider(IdentityProvider) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

HardwareIdStrategy

IgnoreCheckEventSubscriber() - Constructor for class com.licensespring.floating.CheckLicenseSubscriber.IgnoreCheckEventSubscriber

IgnoreEventSubscriber() - Constructor for class com.licensespring.floating.BorrowedLicenseExpirationSubscriber.IgnoreEventSubscriber

IgnoreRegisterEventSubscriber() - Constructor for class com.licensespring.floating.ProxyRegisterSubscriber.IgnoreRegisterEventSubscriber

installationFile(LicenseRequest) - Method in interface com.licensespring.floating.api.FloatingApi

Gets the latest installation file for the product.

installationFile(LicenseIdentity) - Method in class com.licensespring.floating.FloatingLicenseService

Gets the latest installation file for the product.

isAddShutdownHook() - Method in class com.licensespring.floating.FloatingConfiguration

If true, this property adds a shutdown hook that will release currently active licenses before shutting down the runtime process.

isAddShutdownHook() - Method in class com.licensespring.floating.ProxyConfiguration

If true, this property adds a shutdown hook that will release currently active licenses before shutting down the runtime process.

isCacheHardwareID() - Method in class com.licensespring.floating.ProxyConfiguration

Set true to allow caching of hardware IDs, otherwise the SDK directly invokes the IdentityProvider.getKey() every time the SDK needs the hardware id.

isEnablePeriodicCheck() - Method in class com.licensespring.floating.FloatingConfiguration

If true, this property enables periodic calls to check method to prolong the license validity period.

isEnablePeriodicRegister() - Method in class com.licensespring.floating.ProxyConfiguration

If true, this property enables periodic calls to register method to prolong the valid registration period.

isEnableRetrying() - Method in class com.licensespring.floating.ProxyConfiguration

Boolean value that allows or disables retrying on failed API call.

O

onBorrowedLicenseExpiration(LicenseBorrowResponse) - Method in interface com.licensespring.floating.BorrowedLicenseExpirationSubscriber

Invoked when the borrowed license has reached or surpassed its expiration time.

onError(LicenseIdentity, LicenseSpringException) - Method in interface com.licensespring.floating.CheckLicenseSubscriber

Defines what to do when an error arises while doing the background check call to the server.

onError(ProxyRequest, LicenseSpringException) - Method in interface com.licensespring.floating.ProxyRegisterSubscriber

Defines what to do when an error arises while doing the background register call to server.

onSuccess(CheckResponse) - Method in interface com.licensespring.floating.CheckLicenseSubscriber

This method is called when the license has been successfully activated in the background.

onSuccess(LicenseData) - Method in interface com.licensespring.floating.ProxyRegisterSubscriber

This method is called when the registration was successful.

P

port(Integer) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

product(String) - Method in class com.licensespring.floating.dto.ProxyRequest.ProxyRequestBuilder

Product code.

product(String) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

productDetails(String) - Method in interface com.licensespring.floating.api.FloatingApi

Fetches product data from the server

productDetails() - Method in class com.licensespring.floating.FloatingLicenseService

Fetches product data from the server.

ProxyAPI - Interface in com.licensespring.floating.api

Proxy Floating License APIs.

ProxyApiFactory - Class in com.licensespring.floating.api

Api factory for building ProxyAPI.

proxyCertPath(String) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

ProxyConfiguration - Class in com.licensespring.floating

Offline Proxy Floating configuration object.

ProxyConfiguration.ProxyConfigurationBuilder - Class in com.licensespring.floating

Builder for ProxyConfiguration.

ProxyFloatingService - Class in com.licensespring.floating

All request for offline floating licenses should be done via this object.

ProxyFloatingService(ProxyConfiguration) - Constructor for class com.licensespring.floating.ProxyFloatingService

Proxy floating service has to be built using the ProxyConfiguration.

proxyHost(String) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

proxyPass(String) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

proxyPort(Integer) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

proxyRegisterSubscriber(ProxyRegisterSubscriber) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

Add the CheckLicenseSubscriber implementation, which receives events on a background thread, which periodically call the registration API.

ProxyRegisterSubscriber - Interface in com.licensespring.floating

The ProxyRegisterSubscriber is a way to get notified when the background register completes.

ProxyRegisterSubscriber.IgnoreRegisterEventSubscriber - Class in com.licensespring.floating

Default do-nothing class.

ProxyRequest - Class in com.licensespring.floating.dto

Data Transfer Object that is used for register and unregister API endpoints.

ProxyRequest.ProxyRequestBuilder - Class in com.licensespring.floating.dto

ProxyResponse - Class in com.licensespring.floating.dto

ProxyResponse(String, String) - Constructor for class com.licensespring.floating.dto.ProxyResponse

ProxyShutdownHook - Class in com.licensespring.floating

Shutdown hook class for creating a hook that will unregister the user before shutdown.

ProxyShutdownHook(ProxyFloatingService) - Constructor for class com.licensespring.floating.ProxyShutdownHook

Constructor for creating the ProxyShutdownHook object in charge of handling the state of registered user.

proxyUser(String) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

R

register(ProxyRequest) - Method in interface com.licensespring.floating.api.ProxyAPI

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

register() - Method in class com.licensespring.floating.ProxyFloatingService

Register the user.

releaseFloatingFeature(FloatingFeatureReq) - Method in interface com.licensespring.floating.api.FloatingApi

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

releaseFloatingFeature(LicenseIdentity, String) - Method in class com.licensespring.floating.FloatingLicenseService

Release a license device from a floating license feature.

releaseLicense(LicenseRequest) - Method in interface com.licensespring.floating.api.FloatingApi

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

releaseLicense(LicenseIdentity) - Method in class com.licensespring.floating.FloatingLicenseService

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

removeFuture(LicenseIdentity) - Method in class com.licensespring.floating.ShutdownHooks

Removes given future for the given identity key.

removeIdentity(LicenseIdentity) - Method in class com.licensespring.floating.ShutdownHooks

Removes given identity.

removeOnBorrowExpiredHook(LicenseIdentity, boolean) - Method in class com.licensespring.floating.ShutdownHooks

Removes onBorrowExpired hook for the given identity key.

requestLogging(Logger.Level) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

requestTimeout(Long) - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

S

self() - Method in class com.licensespring.floating.FloatingConfiguration.FloatingConfigurationBuilder

self() - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

serverHealthy() - Method in class com.licensespring.floating.ProxyFloatingService

Check if the server is healthy.

setOnBorrowExpiredHook(LicenseIdentity, ScheduledFuture<?>) - Method in class com.licensespring.floating.ShutdownHooks

Sets onBorrowExpired hook for the given identity key.

ShutdownHooks - Class in com.licensespring.floating

Shutdown hook class for creating a hook that will release all licenses before shutdown.

ShutdownHooks(FloatingLicenseService, FloatingConfiguration) - Constructor for class com.licensespring.floating.ShutdownHooks

Constructor for creating the ShutdownHooks object in charge of handling the state of activated licenses.

shutdownScheduler() - Method in class com.licensespring.floating.FloatingLicenseService

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

shutdownScheduler() - Method in class com.licensespring.floating.ProxyFloatingService

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

T

toString() - Method in class com.licensespring.floating.dto.ProxyRequest.ProxyRequestBuilder

toString() - Method in class com.licensespring.floating.dto.ProxyRequest

toString() - Method in class com.licensespring.floating.dto.ProxyResponse

toString() - Method in class com.licensespring.floating.FloatingConfiguration.FloatingConfigurationBuilder

Autogenerated toString

toString() - Method in class com.licensespring.floating.FloatingConfiguration

toString() - Method in class com.licensespring.floating.ProxyConfiguration.ProxyConfigurationBuilder

Autogenerated toString containing all the fields.

toString() - Method in class com.licensespring.floating.ProxyConfiguration

Autogenerated toString containing all the fields.

trackVariables(VariableRequest) - Method in interface com.licensespring.floating.api.FloatingApi

Tracks custom device variables which can be seen in the platform.

trackVariables(LicenseIdentity, DeviceVariables) - Method in class com.licensespring.floating.FloatingLicenseService

Tracks custom device variables which can be seen in the platform.

U

unregister(ProxyRequest) - Method in interface com.licensespring.floating.api.ProxyAPI

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

unregister() - Method in class com.licensespring.floating.ProxyFloatingService

Unregister the user.

user(String) - Method in class com.licensespring.floating.dto.ProxyRequest.ProxyRequestBuilder

Unique user identification.

V

versions(LicenseRequest) - Method in interface com.licensespring.floating.api.FloatingApi

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

versions(LicenseIdentity) - Method in class com.licensespring.floating.FloatingLicenseService

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

A B C D E F G H I O P R S T U V