com.licensespring.floating

Class FloatingConfiguration.FloatingConfigurationBuilder

java.lang.Object

com.licensespring.BaseConfiguration.ConfigurationBuilder<FloatingConfiguration,FloatingConfiguration.FloatingConfigurationBuilder>

com.licensespring.floating.FloatingConfiguration.FloatingConfigurationBuilder

Enclosing class:

FloatingConfiguration

public static final class FloatingConfiguration.FloatingConfigurationBuilder
extends com.licensespring.BaseConfiguration.ConfigurationBuilder<FloatingConfiguration,FloatingConfiguration.FloatingConfigurationBuilder>

The Floating SDK configuration builder.

Method Summary

Modifier and Type	Method and Description
FloatingConfiguration.FloatingConfigurationBuilder	addShutdownHook(boolean addShutdownHook) Shutdown hooks are created for all activated licenses during the lifetime.
FloatingConfiguration.FloatingConfigurationBuilder	borrowedLicenseExpirationSubscriber(BorrowedLicenseExpirationSubscriber borrowedLicenseExpirationSubscriber) Assigns a BorrowedLicenseExpirationSubscriber instance to be used for handling borrowed license expiration events.
FloatingConfiguration	build() Build the floating configuration.
FloatingConfiguration.FloatingConfigurationBuilder	checkSubscriber(CheckLicenseSubscriber checkLicenseSubscriber) Add the CheckLicenseSubscriber implementation, which receives events on a background thread, which periodically call the check API.
FloatingConfiguration.FloatingConfigurationBuilder	enablePeriodicCheck(boolean enablePeriodicCheck) Enable periodic check invocation.
protected FloatingConfiguration.FloatingConfigurationBuilder	self()
String	toString() Autogenerated toString

Methods inherited from class com.licensespring.BaseConfiguration.ConfigurationBuilder

apiKey, appName, appVersion, cacheHardwareID, connectionSpecs, disableSsl, enableNegativeConsumptions, enableRetrying, getCacheHardwareID, getEnableRetrying, getIdentityProvider, hostnameVerifier, identityProvider, infoToStore, productCode, proxyCertPath, proxyHost, proxyPass, proxyPort, proxyUser, requestLogging, requestTimeout, serviceURL, sharedKey, sslConfig, sslConfig, storeMachineInfo

Methods inherited from class java.lang.Object

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

Method Detail

addShutdownHook

public FloatingConfiguration.FloatingConfigurationBuilder addShutdownHook(boolean addShutdownHook)

Shutdown hooks are created for all activated licenses during the lifetime. This behaviour is on by default. Set false to disable.

Parameters:

addShutdownHook - should the sdk add a shutdown hook for license deactivation.

Returns:

the floating configuration builder

enablePeriodicCheck

public FloatingConfiguration.FloatingConfigurationBuilder enablePeriodicCheck(boolean enablePeriodicCheck)

Enable periodic check invocation. On by default.

Parameters:

enablePeriodicCheck - the enable periodic check

Returns:

the floating configuration builder

checkSubscriber

public FloatingConfiguration.FloatingConfigurationBuilder checkSubscriber(CheckLicenseSubscriber checkLicenseSubscriber)

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

Parameters:

checkLicenseSubscriber - the implementation handling check events.

Returns:

the floating configuration builder

borrowedLicenseExpirationSubscriber

public FloatingConfiguration.FloatingConfigurationBuilder borrowedLicenseExpirationSubscriber(BorrowedLicenseExpirationSubscriber borrowedLicenseExpirationSubscriber)

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

Parameters:

borrowedLicenseExpirationSubscriber - An instance of BorrowedLicenseExpirationSubscriber.

Returns:

The current builder instance.

self

protected FloatingConfiguration.FloatingConfigurationBuilder self()

Specified by:

self in class com.licensespring.BaseConfiguration.ConfigurationBuilder<FloatingConfiguration,FloatingConfiguration.FloatingConfigurationBuilder>

Returns:

reference to self

build

public FloatingConfiguration build()
                            throws com.licensespring.model.exceptions.validation.ConfigurationException

Build the floating configuration. May throw configuration exception if required parameters are not present, or invalid HardwareStrategy combination.

Specified by:

build in class com.licensespring.BaseConfiguration.ConfigurationBuilder<FloatingConfiguration,FloatingConfiguration.FloatingConfigurationBuilder>

Returns:

the built immutable configuration

Throws:

com.licensespring.model.exceptions.validation.ConfigurationException

toString

public String toString()

Autogenerated toString

Overrides:

toString in class com.licensespring.BaseConfiguration.ConfigurationBuilder<FloatingConfiguration,FloatingConfiguration.FloatingConfigurationBuilder>

Returns:

textual representation of the configuration builder state.