10Duke Scale C++ Client
Loading...
Searching...
No Matches
Public Member Functions | List of all members
tenduke::se::licensing::rest::ScaleLicensingApi Class Referenceabstract

#include <ScaleLicensingApi.h>

Detailed Description

Low-level licensing client interface.

This matches the REST-API and implementations are used to access the REST API.

ScaleLicensingApi is a factory for actual API requests: Methods return instances of "request"-classes. Executing the request makes the actual REST API call and returns the response.

"Request-level" errors from request execution are reported with exceptions. Note that checkout/heartbeat/release calls return responses normally, when the problem is argument-specific. For example, trying to checkout a seat from license that has all seats already checked out does not throw an exception, but returns tenduke::se::licensing::LicenseCheckoutResponse, which has errors-vector describing the errors. This means that for example checkout can partially succeed and fail at the same time.

Some examples of "request-level" errors are e.g. missing/expired credentials or rate-limiting. The official documentation describes several types of errors.

Inheritance diagram for tenduke::se::licensing::rest::ScaleLicensingApi:
tenduke::se::licensing::rest::ScaleLicensingApiImpl

Public Member Functions

virtual std::unique_ptr<::tenduke::se::licensing::rest::LicenseCheckoutRequest > checkoutLicenses (const ::tenduke::se::licensing::LicenseCheckoutParameters &parameters) const =0
 Checkout license(s).
 
virtual std::unique_ptr<::tenduke::se::licensing::rest::LicenseCheckoutRequest > checkoutLicensesWithKey (const std::string &licenseKey, const ::tenduke::se::licensing::LicenseCheckoutParameters &parameters) const =0
 Checkout license(s) with license key.
 
virtual std::unique_ptr<::tenduke::se::licensing::rest::DescribeLicenseKeyRequest > describeLicenseKey (const std::string &licenseKey, const ::tenduke::se::Paging &paging, bool withMetadata) const =0
 Describe license key.
 
virtual std::unique_ptr<::tenduke::se::licensing::rest::EndMeteredUseRequest > endMeteredLicenseUse (const ::tenduke::se::licensing::EndMeteredUseParameters &parameters) const =0
 Ends metered license use.
 
virtual std::unique_ptr<::tenduke::se::licensing::rest::EndMeteredUseRequest > endMeteredLicenseUseByKey (const std::string &licenseKey, const ::tenduke::se::licensing::EndMeteredUseParameters &parameters) const =0
 Ends metered license use with license key.
 
virtual std::unique_ptr<::tenduke::se::licensing::rest::LicenseHeartbeatRequest > heartbeatLicenses (const ::tenduke::se::licensing::LicenseHeartbeatParameters &parameters) const =0
 Does license heartbeat.
 
virtual std::unique_ptr<::tenduke::se::licensing::rest::LicenseHeartbeatRequest > heartbeatLicensesWithKey (const std::string &licenseKey, const ::tenduke::se::licensing::LicenseHeartbeatParameters &parameters) const =0
 Does license heartbeat with license key.
 
virtual std::unique_ptr<::tenduke::se::licensing::rest::HeartbeatMeteredUseRequest > heartbeatMeteredLicenseUse (const ::tenduke::se::licensing::HeartbeatMeteredUseParameters &parameters) const =0
 Does license heartbeat for metered license use.
 
virtual std::unique_ptr<::tenduke::se::licensing::rest::HeartbeatMeteredUseRequest > heartbeatMeteredLicenseUseByKey (const std::string &licenseKey, const ::tenduke::se::licensing::HeartbeatMeteredUseParameters &parameters) const =0
 Does license heartbeat with license key for metered license use.
 
virtual std::unique_ptr<::tenduke::se::licensing::rest::LicenseReleaseRequest > releaseLicenses (const ::tenduke::se::licensing::LicenseReleaseParameters &parameters) const =0
 Releases licenses.
 
virtual std::unique_ptr<::tenduke::se::licensing::rest::LicenseReleaseRequest > releaseLicensesWithKey (const std::string &licenseKey, const ::tenduke::se::licensing::LicenseReleaseParameters &parameters) const =0
 Releases licenses with license key.
 
virtual std::unique_ptr<::tenduke::se::licensing::rest::StartMeteredUseRequest > startMeteredLicenseUse (const ::tenduke::se::licensing::StartMeteredUseParameters &parameters) const =0
 Starts metere license use.
 
virtual std::unique_ptr<::tenduke::se::licensing::rest::StartMeteredUseRequest > startMeteredLicenseUseWithKey (const std::string &licenseKey, const ::tenduke::se::licensing::StartMeteredUseParameters &parameters) const =0
 Starts metered license use with license key.
 

Member Function Documentation

◆ checkoutLicenses()

virtual std::unique_ptr<::tenduke::se::licensing::rest::LicenseCheckoutRequest > tenduke::se::licensing::rest::ScaleLicensingApi::checkoutLicenses ( const ::tenduke::se::licensing::LicenseCheckoutParameters &  parameters) const
pure virtual

Checkout license(s).

Parameters
parameterscheckout parameters
Returns
executable request to checkout the licenses

Implemented in tenduke::se::licensing::rest::ScaleLicensingApiImpl.

◆ checkoutLicensesWithKey()

virtual std::unique_ptr<::tenduke::se::licensing::rest::LicenseCheckoutRequest > tenduke::se::licensing::rest::ScaleLicensingApi::checkoutLicensesWithKey ( const std::string &  licenseKey,
const ::tenduke::se::licensing::LicenseCheckoutParameters &  parameters 
) const
pure virtual

Checkout license(s) with license key.

Parameters
licenseKeythe license key
parameterscheckout parameters
Returns
executable request to checkout the licenses

Implemented in tenduke::se::licensing::rest::ScaleLicensingApiImpl.

◆ describeLicenseKey()

virtual std::unique_ptr<::tenduke::se::licensing::rest::DescribeLicenseKeyRequest > tenduke::se::licensing::rest::ScaleLicensingApi::describeLicenseKey ( const std::string &  licenseKey,
const ::tenduke::se::Paging &  paging,
bool  withMetadata 
) const
pure virtual

Describe license key.

Describes licenses that a license key grants usage rights to. This endpoint can be called using only a license key. Current use of licenses checked out using a license key (client bindings) can be requested at: /actions/describe-license-key-client-bindings. Paging detail: The common case is having one or only a few licenses per license key. That means paging is likely not needed and requests to this endpoint can omit using offset and limit in that case.

Parameters
licenseKeythe license key
paging-
withMetadata-
Returns
executable request to describe the license key

Implemented in tenduke::se::licensing::rest::ScaleLicensingApiImpl.

◆ endMeteredLicenseUse()

virtual std::unique_ptr<::tenduke::se::licensing::rest::EndMeteredUseRequest > tenduke::se::licensing::rest::ScaleLicensingApi::endMeteredLicenseUse ( const ::tenduke::se::licensing::EndMeteredUseParameters &  parameters) const
pure virtual

Ends metered license use.

Parameters
parameters-
Returns
executable request to end metered license use

Implemented in tenduke::se::licensing::rest::ScaleLicensingApiImpl.

◆ endMeteredLicenseUseByKey()

virtual std::unique_ptr<::tenduke::se::licensing::rest::EndMeteredUseRequest > tenduke::se::licensing::rest::ScaleLicensingApi::endMeteredLicenseUseByKey ( const std::string &  licenseKey,
const ::tenduke::se::licensing::EndMeteredUseParameters &  parameters 
) const
pure virtual

Ends metered license use with license key.

Parameters
licenseKeythe license key
parameters-
Returns
executable request to end metered license use

Implemented in tenduke::se::licensing::rest::ScaleLicensingApiImpl.

◆ heartbeatLicenses()

virtual std::unique_ptr<::tenduke::se::licensing::rest::LicenseHeartbeatRequest > tenduke::se::licensing::rest::ScaleLicensingApi::heartbeatLicenses ( const ::tenduke::se::licensing::LicenseHeartbeatParameters &  parameters) const
pure virtual

Does license heartbeat.

Parameters
parameters-
Returns
executable request to do license heartbeat

Implemented in tenduke::se::licensing::rest::ScaleLicensingApiImpl.

◆ heartbeatLicensesWithKey()

virtual std::unique_ptr<::tenduke::se::licensing::rest::LicenseHeartbeatRequest > tenduke::se::licensing::rest::ScaleLicensingApi::heartbeatLicensesWithKey ( const std::string &  licenseKey,
const ::tenduke::se::licensing::LicenseHeartbeatParameters &  parameters 
) const
pure virtual

Does license heartbeat with license key.

Parameters
licenseKeythe license key
parameters-
Returns
executable request to do license heartbeat

Implemented in tenduke::se::licensing::rest::ScaleLicensingApiImpl.

◆ heartbeatMeteredLicenseUse()

virtual std::unique_ptr<::tenduke::se::licensing::rest::HeartbeatMeteredUseRequest > tenduke::se::licensing::rest::ScaleLicensingApi::heartbeatMeteredLicenseUse ( const ::tenduke::se::licensing::HeartbeatMeteredUseParameters &  parameters) const
pure virtual

Does license heartbeat for metered license use.

Parameters
parameters-
Returns
executable request to do license heartbeat

Implemented in tenduke::se::licensing::rest::ScaleLicensingApiImpl.

◆ heartbeatMeteredLicenseUseByKey()

virtual std::unique_ptr<::tenduke::se::licensing::rest::HeartbeatMeteredUseRequest > tenduke::se::licensing::rest::ScaleLicensingApi::heartbeatMeteredLicenseUseByKey ( const std::string &  licenseKey,
const ::tenduke::se::licensing::HeartbeatMeteredUseParameters &  parameters 
) const
pure virtual

Does license heartbeat with license key for metered license use.

Parameters
licenseKeythe license key
parameters-
Returns
executable request to do license heartbeat

Implemented in tenduke::se::licensing::rest::ScaleLicensingApiImpl.

◆ releaseLicenses()

virtual std::unique_ptr<::tenduke::se::licensing::rest::LicenseReleaseRequest > tenduke::se::licensing::rest::ScaleLicensingApi::releaseLicenses ( const ::tenduke::se::licensing::LicenseReleaseParameters &  parameters) const
pure virtual

Releases licenses.

Parameters
parameters-
Returns
executable request to release licenses

Implemented in tenduke::se::licensing::rest::ScaleLicensingApiImpl.

◆ releaseLicensesWithKey()

virtual std::unique_ptr<::tenduke::se::licensing::rest::LicenseReleaseRequest > tenduke::se::licensing::rest::ScaleLicensingApi::releaseLicensesWithKey ( const std::string &  licenseKey,
const ::tenduke::se::licensing::LicenseReleaseParameters &  parameters 
) const
pure virtual

Releases licenses with license key.

Parameters
licenseKeythe license key
parameters-
Returns
executable request to release licenses

Implemented in tenduke::se::licensing::rest::ScaleLicensingApiImpl.

◆ startMeteredLicenseUse()

virtual std::unique_ptr<::tenduke::se::licensing::rest::StartMeteredUseRequest > tenduke::se::licensing::rest::ScaleLicensingApi::startMeteredLicenseUse ( const ::tenduke::se::licensing::StartMeteredUseParameters &  parameters) const
pure virtual

Starts metere license use.

Parameters
parameters-
Returns
executable request to start metered license use

Implemented in tenduke::se::licensing::rest::ScaleLicensingApiImpl.

◆ startMeteredLicenseUseWithKey()

virtual std::unique_ptr<::tenduke::se::licensing::rest::StartMeteredUseRequest > tenduke::se::licensing::rest::ScaleLicensingApi::startMeteredLicenseUseWithKey ( const std::string &  licenseKey,
const ::tenduke::se::licensing::StartMeteredUseParameters &  parameters 
) const
pure virtual

Starts metered license use with license key.

Parameters
licenseKeythe license key
parameters-
Returns
executable request to start metered license use

Implemented in tenduke::se::licensing::rest::ScaleLicensingApiImpl.

The documentation for this class was generated from the following file: