LicenseSpring C++ SDK 7.27.0
Easily add Software Licensing to your application
License.h
Go to the documentation of this file.
1#ifndef LS_LICENSE_H
2#define LS_LICENSE_H
3
4#ifdef _MSC_VER
5#pragma once
6#pragma warning( push )
7#pragma warning( disable : 4251 )
8#endif
9
10#include <vector>
11#include <functional>
12#include "LicenseType.h"
13#include "CustomField.h"
14#include "InstallationFile.h"
15#include "LicenseID.h"
16#include "LicenseFeature.h"
17#include "DeviceVariable.h"
18#include "Customer.h"
19#include "ProductDetails.h"
20#include "LicenseUser.h"
21#include "Exceptions.h"
22
23#pragma push_macro("check") // Workaround for Unreal Engine
24#undef check
25
26namespace LicenseSpring
27{
29 using LicenseWatchdogCallback = std::function<void( const LicenseSpringException& ex )>;
30
34 {
35 public:
36 using ptr_t = std::shared_ptr<License>;
37
39 virtual ~License() {};
40
43 virtual const LicenseID& id() const = 0;
44
47 virtual const std::string& key() const = 0;
48
51 virtual const std::string& user() const = 0;
52
55 virtual LicenseType type() const = 0;
56
59 virtual Customer owner() const = 0;
60
64 virtual LicenseUser::ptr_t licenseUser() const = 0;
65
70 virtual ProductDetails productDetails() const = 0;
71
74 virtual std::string status() const = 0;
75
78 virtual bool isActive() const = 0;
79
82 virtual bool isEnabled() const = 0;
83
86 virtual bool isValid() const = 0;
87
90 virtual bool isTrial() const = 0;
91
94 virtual bool isAirGapped() const = 0;
95
99 virtual uint32_t policyId() const = 0;
100
103 virtual bool isOfflineActivated() const = 0;
104
108 virtual bool isVMAllowed() const = 0;
109
112 virtual bool isFloating() const = 0;
113
117 virtual bool isBorrowed() const = 0;
118
122 virtual bool isSubscriptionGracePeriodStarted() const = 0;
123
126 virtual bool isGracePeriodStarted() const = 0;
127
130 virtual tm gracePeriodEndDateTime() const = 0;
131
134 virtual tm gracePeriodEndDateTimeUTC() const = 0;
135
138 virtual int gracePeriodHoursRemaining() const = 0;
139
143 virtual uint32_t maxFloatingUsers() const = 0;
144
149 virtual uint32_t floatingInUseCount() const = 0;
150
153 virtual uint32_t floatingTimeout() const = 0;
154
158 virtual const std::string& floatingClientId() const = 0;
159
162 virtual tm validityPeriod() const = 0;
163
166 virtual tm validityPeriodUtc() const = 0;
167
171 virtual tm validityWithGracePeriod() const = 0;
172
176 virtual tm validityWithGracePeriodUtc() const = 0;
177
181 virtual uint32_t subscriptionGracePeriod() const = 0;
182
186 virtual uint32_t maxBorrowTime() const = 0;
187
190 virtual tm maintenancePeriod() const = 0;
191
194 virtual tm maintenancePeriodUtc() const = 0;
195
198 virtual tm lastCheckDate() const = 0;
199
202 virtual tm lastCheckDateUtc() const = 0;
203
207 virtual tm floatingEndDateTime() const = 0;
208
212 virtual tm floatingEndDateTimeUtc() const = 0;
213
217 virtual const std::string& startDate() const = 0;
218
221 virtual const std::string& metadata() const = 0;
222
226 virtual LicenseFeature feature( const std::string& featureCode ) const = 0;
227
230 virtual std::vector<LicenseFeature> features() const = 0;
231
234 virtual std::vector<CustomField> customFields() const = 0;
235
239 virtual const std::vector<CustomField>& userData() const = 0;
240
245 virtual std::string userData( const std::string& key ) const = 0;
246
252 virtual void addUserData( const CustomField& data, bool saveLicense = true ) = 0;
253
257 virtual void removeUserData( const std::string& key = std::string(), bool saveLicense = true ) = 0;
258
261 virtual int32_t totalConsumption() const = 0;
262
265 virtual int32_t maxConsumption() const = 0;
266
269 virtual int32_t maxOverages() const = 0;
270
273 virtual bool isOveragesAllowed() const = 0;
274
277 virtual bool isUnlimitedConsumptionAllowed() const = 0;
278
282
285 virtual bool isResetConsumptionEnabled() const = 0;
286
289 virtual uint32_t timesActivated() const = 0;
290
293 virtual uint32_t maxActivations() const = 0;
294
297 virtual uint32_t transferCount() const = 0;
298
302 virtual bool isAutoReleaseSet() const = 0;
303
306 virtual void setAutoRelease( bool autoRelease ) = 0;
307
313 virtual void updateConsumption( int32_t value = 1, bool saveLicense = true ) = 0;
314
321 virtual void updateFeatureConsumption( const std::string& featureCode, int32_t value = 1, bool saveLicense = true ) = 0;
322
323 // Local checks
327 virtual bool isExpired() const = 0;
328
331 virtual bool isMaintenancePeriodExpired() const = 0;
332
336 virtual int daysRemainingUtc() const = 0;
337
341 virtual int daysRemaining() const = 0;
342
345 virtual int maintenanceDaysRemaining() const = 0;
346
349 static const int MaxDaysRemainingValue;
350
353 virtual int daysPassedSinceLastCheck() const = 0;
354
362 virtual void localCheck() = 0;
363
364 // Requests to LicenseSpring server
365
378 virtual bool deactivate( bool removeLocalData = false ) = 0;
379
384 virtual bool changePassword( const std::string& password, const std::string& newPassword ) = 0; // may throw exceptions
385
398
411 virtual bool syncConsumption( int32_t requestOverage = -1 ) = 0;
412
425 virtual bool syncFeatureConsumption( const std::string& featureCode = std::string() ) = 0;
426
436 virtual void addDeviceVariable( const std::string& name, const std::string& value,
437 bool saveLicense = true ) = 0;
438
445 virtual void addDeviceVariable( const DeviceVariable& variable, bool saveLicense = true ) = 0;
446
450 virtual void addDeviceVariables( const std::vector<DeviceVariable>& variables ) = 0;
451
458 virtual bool sendDeviceVariables() = 0;
459
467 virtual std::vector<DeviceVariable> getDeviceVariables( bool getFromBackend = false ) = 0;
468
472 virtual DeviceVariable deviceVariable( const std::string& name ) const = 0;
473
477 virtual const std::string& deviceVariableValue( const std::string& name ) const = 0;
478
484 virtual void setupLicenseWatchdog( LicenseWatchdogCallback callback, uint32_t timeout = 0 ) = 0;
485
489 virtual void resumeLicenseWatchdog() = 0;
490
493 virtual void stopLicenseWatchdog() = 0;
494
500 virtual void registerFloatingLicense() = 0;
501
510 virtual void releaseFloatingLicense( bool throwExceptions = false ) = 0;
511
522 virtual void borrow( uint32_t hours, uint32_t days = 0 ) = 0;
523
533 virtual void borrow( const std::string& borrowEndDateTime = std::string() ) = 0;
534
538 virtual std::wstring deactivateOffline( const std::wstring& deactivationRequestFile = std::wstring() ) = 0;
539
548 virtual bool updateOffline( const std::wstring& path, bool resetConsumption = false ) = 0;
549
554 virtual void unlinkFromDevice() = 0;
555
559 virtual std::string getAirGapDeactivationCode( const std::string& initializationCode ) = 0;
560
564 virtual void deactivateAirGap( const std::string& confirmationCode ) = 0;
565
568 virtual bool isLicenseBelongsToThisDevice( DeviceIDAlgorithm deviceIDAlgorithm ) = 0;
569
572 };
573
575 std::string LS_API TmToString( const tm& dateTime, const std::string& format = std::string( "%d-%m-%Y" ) );
576
577} // namespace LicenseSpring
578
579#pragma pop_macro("check")
580
581#ifdef _MSC_VER
582#pragma warning( pop )
583#endif
584
585#endif // LS_LICENSE_H
#define LS_API
Macros that expands to dllexport, dllimport or nothing on non Windows platforms or in case of static ...
Definition: APIDef.h:22
DeviceIDAlgorithm
Type of Device ID algorithm used by the SDK.
Definition: PODTypes.h:101
Class used for encapsulating LSConsumptionPeriod and converting cosumption period to/from string.
Class for storing key-value data field.
Definition: CustomField.h:18
Class that encapsulates information about a customer.
Definition: Customer.h:18
Class for storing key-value device variable.
std::shared_ptr< InstallationFile > ptr_t
Class that encapsulates information about license feature.
Class that encapsulates license information.
Definition: License.h:34
virtual void deactivateAirGap(const std::string &confirmationCode)=0
Verify Confirmation code and deactivate air gap license.
virtual bool isVMAllowed() const =0
Checker for whether the license is allowed to work under virtual machine or not.
virtual tm validityPeriod() const =0
Getter for license validity period in local time.
virtual const std::string & deviceVariableValue(const std::string &name) const =0
Get device variable value by name.
virtual uint32_t subscriptionGracePeriod() const =0
Getter for grace period of the Subscription license in hours.
virtual bool isBorrowed() const =0
Checker for whether the license is borrowed.
virtual Customer owner() const =0
Getter for license owner.
virtual int gracePeriodHoursRemaining() const =0
How many hours remaining till grace period ends.
virtual int32_t totalConsumption() const =0
Returns license current total consumption.
virtual bool checkLicenseBelongsToThisDevice()=0
Checks if license belongs to any of the DeviceIDAlgorithm values.
virtual void setupLicenseWatchdog(LicenseWatchdogCallback callback, uint32_t timeout=0)=0
Setup and run license watchdog, a background thread which periodically checks the license.
virtual void borrow(const std::string &borrowEndDateTime=std::string())=0
Borrow floating license till provided end date time.
virtual tm maintenancePeriod() const =0
Getter for license maintenance period in local time.
virtual tm lastCheckDateUtc() const =0
Getter for license last check date in UTC.
std::shared_ptr< License > ptr_t
Definition: License.h:36
virtual uint32_t maxBorrowTime() const =0
Maximum borrowing period in hours.
virtual void addDeviceVariable(const std::string &name, const std::string &value, bool saveLicense=true)=0
Add new or update existing device variable to license daata.
virtual tm validityPeriodUtc() const =0
Getter for license validity period in UTC.
virtual void releaseFloatingLicense(bool throwExceptions=false)=0
Revoke floating license, typically should be called at the end of app execution.
virtual bool isMaintenancePeriodExpired() const =0
Compare system date time with maintenance period time.
virtual LicenseUser::ptr_t licenseUser() const =0
Getter for license user, it's a person assigned to the license.
virtual uint32_t maxFloatingUsers() const =0
Getter for max simultaneous license users (devices or instances).
virtual bool isActive() const =0
Checker for if the license is active.
virtual tm floatingEndDateTimeUtc() const =0
Floating license validity end date time in UTC.
virtual std::vector< CustomField > customFields() const =0
Getter for list of custom fields associated with the license.
virtual uint32_t floatingTimeout() const =0
Getter for timeout of the floating license in minutes.
virtual const LicenseID & id() const =0
Getter for license ID.
virtual uint32_t maxActivations() const =0
How many times license can be activated.
virtual void updateFeatureConsumption(const std::string &featureCode, int32_t value=1, bool saveLicense=true)=0
Increase or decrease feature consumption by given value.
virtual void updateConsumption(int32_t value=1, bool saveLicense=true)=0
Increase or decrease license consumption by given value.
virtual bool isOveragesAllowed() const =0
Checks if overage is allowed for Consumption license.
virtual ConsumptionPeriod consumptionPeriod() const =0
Returns period of time after which consumption is reset.
virtual bool syncFeatureConsumption(const std::string &featureCode=std::string())=0
Sync Consumption Feature(s) with the backend, if code not provided sync all consumption features.
virtual void unlinkFromDevice()=0
Unlinks license from cuurent device ID.
virtual bool updateOffline(const std::wstring &path, bool resetConsumption=false)=0
Update license data accordingly to provided file.
virtual void addDeviceVariable(const DeviceVariable &variable, bool saveLicense=true)=0
Add new or update existing device variable to license daata.
virtual uint32_t policyId() const =0
Policy id of the license.
virtual void stopLicenseWatchdog()=0
Stops license watchdog background thread.
virtual void setAutoRelease(bool autoRelease)=0
Sets auto release flag. Meaningful only for floating license.
virtual ProductDetails productDetails() const =0
Getter for product details.
virtual tm validityWithGracePeriod() const =0
Getter for license validity period including grace period in local time.
virtual bool isOfflineActivated() const =0
Checker for if license is offline activated.
virtual tm maintenancePeriodUtc() const =0
Getter for license maintenance period in UTC.
virtual bool sendDeviceVariables()=0
Send current device variables list to the backend (see device variables on the platform)
virtual void registerFloatingLicense()=0
Register floating license using floatingClientId.
virtual tm lastCheckDate() const =0
Getter for license last check date in local time.
virtual uint32_t timesActivated() const =0
How many times license already been activated.
virtual const std::string & metadata() const =0
Getter for license metadata.
virtual const std::string & key() const =0
Getter for license key.
virtual std::string getAirGapDeactivationCode(const std::string &initializationCode)=0
Get air gap Deactivation code.
static const int MaxDaysRemainingValue
Maximum value for daysRemaining, e.g. in case of perpetual license.
Definition: License.h:349
virtual bool isExpired() const =0
Compare system date time with license validity date time.
virtual int32_t maxConsumption() const =0
Returns license maximum consumption.
virtual bool isEnabled() const =0
Checker for if the license is enabled.
virtual LicenseFeature feature(const std::string &featureCode) const =0
Getter method for license feature.
virtual std::string status() const =0
Getter for license status.
virtual std::wstring deactivateOffline(const std::wstring &deactivationRequestFile=std::wstring())=0
Creates offline deactivation file request.
virtual bool isLicenseBelongsToThisDevice(DeviceIDAlgorithm deviceIDAlgorithm)=0
Checks if license belongs to this DeviceIDAlgorithm.
virtual bool changePassword(const std::string &password, const std::string &newPassword)=0
Change password for user based license.
virtual LicenseType type() const =0
Getter for license type.
virtual bool isSubscriptionGracePeriodStarted() const =0
Check if grace period started for subscription license.
virtual void resumeLicenseWatchdog()=0
Resume background thread, you can call this within your callback in order to resume periodic license ...
virtual bool isGracePeriodStarted() const =0
Check if grace period started for a license.
virtual const std::string & startDate() const =0
Getter method license start date.
virtual std::vector< DeviceVariable > getDeviceVariables(bool getFromBackend=false)=0
Get device variables from the local license or from the backend.
virtual int daysRemaining() const =0
Almost the same as UTC counterpart, but days counter will be changed on local midnight.
virtual uint32_t floatingInUseCount() const =0
Getter for current floatings slots in use count, including this user (instance).
virtual bool isAirGapped() const =0
Checker for if the license is air gapped.
virtual bool isFloating() const =0
Checker for whether the license is floating or not.
virtual tm validityWithGracePeriodUtc() const =0
Getter for license validity period including grace period in UTC.
virtual bool isUnlimitedConsumptionAllowed() const =0
Checks if unlimited consumption is allowed for Consumption license.
virtual int32_t maxOverages() const =0
Returns maximum overage allowed for the license.
virtual int maintenanceDaysRemaining() const =0
How many days remaining till end of maintenance days.
virtual ~License()
Destructor for license.
Definition: License.h:39
virtual int daysPassedSinceLastCheck() const =0
How many days passed from last online check.
virtual tm gracePeriodEndDateTime() const =0
Getter for grace period end date time in local time.
virtual bool syncConsumption(int32_t requestOverage=-1)=0
Sync Consumption license with the server.
virtual bool isValid() const =0
Checker for if the license is valid.
virtual void addDeviceVariables(const std::vector< DeviceVariable > &variables)=0
Add new or update existing device variables to license daata.
virtual bool isAutoReleaseSet() const =0
Returns auto release flag. Meaningful only for floating license.
virtual bool isTrial() const =0
Checker for if the license is a trial.
virtual bool isResetConsumptionEnabled() const =0
Checks if consumption reset is allowed for Consumption license.
virtual const std::string & floatingClientId() const =0
Getter for floating user (client) or instance id.
virtual void borrow(uint32_t hours, uint32_t days=0)=0
Borrow floating license for provided time interval.
virtual tm gracePeriodEndDateTimeUTC() const =0
Getter for grace period end date time in UTC.
virtual const std::vector< CustomField > & userData() const =0
Returns user data stored within license object.
virtual void addUserData(const CustomField &data, bool saveLicense=true)=0
Adds user data to the license object. This method allows you to store custom data securely inside lic...
virtual int daysRemainingUtc() const =0
How many days remaining till license expires.
virtual bool deactivate(bool removeLocalData=false)=0
Sends deactivate license request to the backend.
virtual void removeUserData(const std::string &key=std::string(), bool saveLicense=true)=0
Removes user data from the license.
virtual tm floatingEndDateTime() const =0
Getter for floating license validity end date time in local time zone.
virtual std::vector< LicenseFeature > features() const =0
Getter for list of license features associated with the license.
virtual uint32_t transferCount() const =0
How many times license has been transferred between devices.
virtual InstallationFile::ptr_t check(const InstallFileFilter &filter=InstallFileFilter())=0
Online license check, sync the license with the backend, throws exceptions in case of errors.
virtual void localCheck()=0
Check license local without connection to the backend.
virtual DeviceVariable deviceVariable(const std::string &name) const =0
Get device variable by name.
virtual std::string userData(const std::string &key) const =0
Getter for user data by given key.
virtual const std::string & user() const =0
Getter for user.
Class that represents License identifier.
Definition: LicenseID.h:19
Base class for all LicenseSpring exceptions.
Definition: Exceptions.h:19
Class used for encapsulating the type of license, comparing types of licenses, and converting them to...
Definition: LicenseType.h:19
std::shared_ptr< LicenseUser > ptr_t
Definition: LicenseUser.h:21
Class that encapsulates information about a product.
std::string LS_API TmToString(const tm &dateTime, const std::string &format=std::string("%d-%m-%Y"))
Helper function, converts datetime to string using given format. See strftime reference for format de...
std::function< void(const LicenseSpringException &ex)> LicenseWatchdogCallback
Callback function which being called in case of error in background thread (watchdog thread).
Definition: License.h:29
Helper struct for filtering installation files by environment and channel.