Floating Features

Similar to Floating Licenses, LicenseSpring supports Floating Features.

In this guide you can find an overview of the floating features functionality: registering and releasing floating features and setting up the Floating Features Watchdog.

Check if a feature is floating

As with floating licenses, you can check if a feature is floating using properties for cloud, as well as offline floating features. To start, use the following code to check if a license feature is floating:

foreach (ILicenseFeature licenseFeature in license.Features())
{
  if(licenseFeature.IsFloating || licenseFeature.IsOfflineFloating)
  {
    // DO SOMETHING WITH A FLOATING FEATURE
  }
}

for(const auto& feature : license->features())
{
    if(feature.isFloating() || feature.isOfflineFloating())
    {
        // do something with a floating feature
    }
}

## add getters
for feature in license.features():
    feature_data = get_feature_data(feature)
    if feature_data["is_floating"] or feature_data["is_floating_cloud"]

LicenseData data = license.getData();
List<LicenseFeature> features = data.getProductFeatures();

for (LicenseFeature feature : features) {
  if (feature.isFloating() || feature.isFloatingCloud()) {
    // Do something with a floating feature...
  }
}

for feature in license.features {
    if feature.isFloating || feature.isOfflineFloating {
        // DO SOMETHING WITH A FLOATING FEATURE
    }
}

Floating slots

Developers will want to know the maximum number of users that can simultaneously use a floating feature and the current number of users using the feature. That can be done with:

uint maxUsers = licenseFeature.FloatingSlotsCount;
uint currentUsers = licenseFeature.FloatingSlotsInUse;

int32_t maxUsers = feature.floatingUsers()
int32_t currentUsers = feature.floatingInUseCount();

feature_lkprod1f1fc1 = license.get_feature_data("lkprod1f1fc1")

feature_lkprod1f1fc1["floating_timeout"] # if feature is floating type
feature_lkprod1f1fc1["floating_users"] # if feature is floating type

Long floatingTimeout = feature.getFloatingTimeout();
Long floatingUsers = feature.getFloatingUsers();

let floatingTimeout = feature.floatingTimeout
let floatingUsers = feature.floatingInUseCount

Floating timeout

You can get information on the floating feature timeout (in minutes) and the point in time until which a registered feature is valid (time of registration + floating feature timeout). After that time, LicenseSpring server will automatically release the feature - if it's not registered again.

uint floatingTimeout = license.FloatingTimeout;
DateTime floatingEndDateTime = license.FloatingEndDateTime;
DateTime floatingEndDateTimeUtc = license.FloatingEndDateTimeUtc;

int32_t floatingTimeout = feature.floatingTimeout();
tm floatingEndDateTime = feature.floatingEndDateTime();
tm floatingEndDateTimeUtc = feature.floatingEndDateTimeUtc();

feature_lkprod1f1fc1 = license.get_feature_data("lkprod1f1fc1")

feature_lkprod1f1fc1["floating_timeout"]
feature_lkprod1f1fc1["floating_end_date"]
feature_lkprod1f1fc1["floating_start_date"]

Long floatingTimeout = feature.getFloatingTimeout();

let floatingTimeout = license.floatingTimeout
let floatingEndDate = license.floatingEndDate

Registering and releasing floating features

Similar to floating licenses, floating features have to be periodically registered on the server for them to take up a floating slot.

ILicenseManager licenseManager = LicenseManager.GetInstance();
ILicense license = licenseManager.CurrentLicense();
ILicenseFeature feature = license.Features().First(e => e.IsFloating);
license.RegisterFloatingFeature(feature);
// You can find a similar sample in the console sample app 
// that is a part of the SDK.

auto licenseManager = LicenseManager::create(pConfiguration);
auto license = licenseManager->getCurrentLicense();
auto feature = license->features().front();
license->registerFloatingFeature(feature.code());

// You can find a similar sample in CppSample 
// if you wish not to add the feature to the watchdog, License::registerFloatingFeature has an optional `addToWatchdog` bool parameter.

license.check_feature("feature_code")

// Go SDK v2
ld, err = lh.CheckLicenseFeature(ctx, featureCode)

LicenseIdentity identity = LicenseIdentity.fromKey("<LICENSE-KEY>");
String featureCode = "<FEATURE-CODE>";
service.checkLicenseFeature(identity, featureCode)

let floatingFeature = license.features.filter { $0.isFloating || $0.isOfflineFloating }.first!
try license.registerFloatingFeature(floatingFeature)

Note that in the C++ SDK you need to pass the feature code instead of the feature object to License::registerFloatingFeature

Likewise, if you wish to release a feature before its timeout, you can do it like so:

ILicenseManager licenseManager = LicenseManager.GetInstance();
ILicense license = licenseManager.CurrentLicense();
ILicenseFeature feature = license
                           .Features()
                           .First(e => e.FloatingEndDateTime > DateTime.Now);
license.ReleaseFloatingFeature(feature);
// You can find a similar sample in the console sample app 
// that is a part of the SDK.

auto licenseManager = LicenseManager::create(pConfiguration);
auto license = licenseManager->getCurrentLicense();
auto feature = license->features().front();
license->releaseFloatingFeature(feature.code());

license.release_feature("lkprod1f1fc1")

ld, err = lh.ReleaseFloatingLicenseFeature(ctx, featureCode)

LicenseIdentity identity = LicenseIdentity.fromKey("<LICENSE-KEY>");
String featureCode = "<FEATURE-CODE>";
service.releaseFloatingFeature(identity, featureCode);

let floatingFeature = license.features.filter { $0.isFloating || $0.isOfflineFloating }.first!
license.ReleaseFloatingFeature(feature)

In .NET SDK, ILicenseFeature data is not refreshed after registering and releasing the feature. In order to get updated values like FloatingSlotsInUse and FloatingEndDateTime you have to call ILicense.Features() method again.

The same applies to the C++ SDK. You have to call license->features() again to get updated feature values.

Floating feature borrowing

If the license user is planning to be offline for a longer period of time, they can borrow a floating feature instead. Borrowing a feature removes it from the feature watchdog.

For user-based licenses, the application must collect the user's password or initiate an SSO login via their Identity Provider:

std::string featureCode = "floatingfeature";
license->borrowFloatingFeature(featureCode);

std::string accountCode;
bool useAuthCode = true;
auto url = manager->getSSOUrl(accountCode, useAuthCode);

std::string authCode; // extracted from the redirect URI
std::string borrowEndDateTime; // empty timestamp indicates maximum allowed borrow length
std::string redirectUri; // set when using alternative redirect URI
license->borrowFloatingFeature(featureCode, borrowEndDateTime, accountCode, useAuthCode, redirectUri);

Watchdog setup

Similar to a floating license watchdog, floating features have to initialize the watchdog in order to use its functionalities. See: Floating Licensing.

Once configured, floating features only need to be registered once. The watchdog ensures they remain active until they are manually released. Be sure to release them when the application shuts down to free up the slots.

You initialize the watchdog like so:

void WatchdogCallbackMethod(LicenseSpringException e)
{
  // DO SOMETHING
}

license.SetupFloatingFeatureWatchdog(WatchdogCallbackMethod);

// Callback method will be invoked only if an exception in a watchdog thread
// is raised. If you want to invoke the callback on every feature
// registration you can pass an optional parameter to the method:
license.SetupFloatingFeatureWatchdog(WatchdogCallbackMethod, true);

// The separate feature watchdog is deprecated since v8.2.0. See Floating licensing
// on how to set up the unified extended watchdog

void watchdogCallback( const LicenseSpringException& ex )
{
  // DO SOMETHING
}

license->setupFeatureWatchdog(watchdogCallback);

license.setup_feature_watch_dog(callback,timeout)

FloatingConfiguration config = FloatingConfiguration.builder()
  .enableFloatingFeaturePeriodicCheck(true)
  .build();

typealias LicenseWatchdogCallback = (LSError?) -> Void

license.setupFloatingFeatureWatchdog(callback: { error in
    //do something
}, runCallbackOnEveryCheck: true)

Setting up the watchdog will also start the thread. If you wish to stop automatically extending your floating features, you can stop the watchdog:

license.StopFloatingFeatureWatchdog();

license->stopFeatureWatchdog();

license.stop_feature_watch_dog()

license.stopFloatingFeatureWatchdog()

And once stopped, it can be restarted again:

license.StartFloatingFeatureWatchdog();

license->resumeFeatureWatchdog();

license.startFloatingFeatureWatchdog();

The legacy License::setupLicenseWatchdog and License::setupFeatureWatchdog (and their LicenseHandler / C-interface counterparts) are marked [[deprecated]] since v8.2.0. They continue to work, but you'll get a compile-time deprecation warning until you migrate.

PreviousAir Gapped Licensing

NextFloating Licensing

Last updated 3 months ago

Was this helpful?