10Duke Scale C++ Client: tenduke::se::licensing::rest::ScaleLicensingApiImpl Class Reference

Searching...

No Matches

#include <ScaleLicensingApiImpl.h>

Detailed Description

Default implementation of tenduke::se::licensing::rest::ScaleLicensingApi.

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

Public Member Functions
	ScaleLicensingApiImpl (const std::shared_ptr<::tenduke::se::ClientProperties > &clientProperties, const std::shared_ptr<::tenduke::se::BackendConfiguration > &configuration, const std::shared_ptr< const ::tenduke::http::HTTPClient > &httpClient, const std::shared_ptr< const ::tenduke::http::HTTPRequestAuthenticator > &httpRequestAuthenticator, const std::shared_ptr< const ::tenduke::http::HTTPResponseToException > &throwException, const std::shared_ptr< const ::tenduke::json::JSONParser > &jsonParser, const std::shared_ptr< const ::tenduke::jwt::JWTParser > &jwtParser, const std::shared_ptr< const ::tenduke::se::licensing::JWTToLease > &jwtToLease)
	Constructs new instance.

std::unique_ptr<::tenduke::se::licensing::rest::LicenseCheckoutRequest >	checkoutLicenses (const ::tenduke::se::licensing::LicenseCheckoutParameters &parameters) const override
	Checkout license(s).

std::unique_ptr<::tenduke::se::licensing::rest::LicenseCheckoutRequest >	checkoutLicensesWithKey (const std::string &licenseKey, const ::tenduke::se::licensing::LicenseCheckoutParameters &parameters) const override
	Checkout license(s) with license key.

std::unique_ptr<::tenduke::se::licensing::rest::DescribeLicenseKeyRequest >	describeLicenseKey (const std::string &licenseKey, const ::tenduke::se::Paging &paging, bool withMetadata) const override
	Describe license key.

std::unique_ptr<::tenduke::se::licensing::rest::EndMeteredUseRequest >	endMeteredLicenseUse (const ::tenduke::se::licensing::EndMeteredUseParameters &parameters) const override
	Ends metered license use.

std::unique_ptr<::tenduke::se::licensing::rest::EndMeteredUseRequest >	endMeteredLicenseUseByKey (const std::string &licenseKey, const ::tenduke::se::licensing::EndMeteredUseParameters &parameters) const override
	Ends metered license use with license key.

std::unique_ptr<::tenduke::se::licensing::rest::LicenseHeartbeatRequest >	heartbeatLicenses (const ::tenduke::se::licensing::LicenseHeartbeatParameters &parameters) const override
	Does license heartbeat.

std::unique_ptr<::tenduke::se::licensing::rest::LicenseHeartbeatRequest >	heartbeatLicensesWithKey (const std::string &licenseKey, const ::tenduke::se::licensing::LicenseHeartbeatParameters &parameters) const override
	Does license heartbeat with license key.

std::unique_ptr<::tenduke::se::licensing::rest::HeartbeatMeteredUseRequest >	heartbeatMeteredLicenseUse (const ::tenduke::se::licensing::HeartbeatMeteredUseParameters &parameters) const override
	Does license heartbeat for metered license use.

std::unique_ptr<::tenduke::se::licensing::rest::HeartbeatMeteredUseRequest >	heartbeatMeteredLicenseUseByKey (const std::string &licenseKey, const ::tenduke::se::licensing::HeartbeatMeteredUseParameters &parameters) const override
	Does license heartbeat with license key for metered license use.

std::unique_ptr<::tenduke::se::licensing::rest::LicenseReleaseRequest >	releaseLicenses (const ::tenduke::se::licensing::LicenseReleaseParameters &parameters) const override
	Releases licenses.

std::unique_ptr<::tenduke::se::licensing::rest::LicenseReleaseRequest >	releaseLicensesWithKey (const std::string &licenseKey, const ::tenduke::se::licensing::LicenseReleaseParameters &parameters) const override
	Releases licenses with license key.

std::unique_ptr<::tenduke::se::licensing::rest::StartMeteredUseRequest >	startMeteredLicenseUse (const ::tenduke::se::licensing::StartMeteredUseParameters &parameters) const override
	Starts metere license use.

std::unique_ptr<::tenduke::se::licensing::rest::StartMeteredUseRequest >	startMeteredLicenseUseWithKey (const std::string &licenseKey, const ::tenduke::se::licensing::StartMeteredUseParameters &parameters) const override
	Starts metered license use with license key.

Protected Member Functions
virtual std::unique_ptr<::tenduke::se::licensing::rest::LicenseCheckoutRequest >	checkout (const ::tenduke::se::licensing::LicenseCheckoutParameters &parameters, const std::string &licenseKey, bool metered) const
	Helper to create checkout request.

virtual std::unique_ptr<::tenduke::se::licensing::rest::LicenseHeartbeatRequest >	heartbeat (const ::tenduke::se::licensing::LicenseHeartbeatParameters &parameters, const std::string &licenseKey, bool metered) const
	Helper to create heartbeat request.

virtual std::unique_ptr< tenduke::se::licensing::rest::LicenseReleaseRequest >	release (const ::tenduke::se::licensing::LicenseReleaseParameters &parameters, const std::string &licenseKey, bool metered) const
	Helper to create release request.

Constructor & Destructor Documentation

◆ ScaleLicensingApiImpl()

tenduke::se::licensing::rest::ScaleLicensingApiImpl::ScaleLicensingApiImpl	(	const std::shared_ptr<::tenduke::se::ClientProperties > &	clientProperties,
		const std::shared_ptr<::tenduke::se::BackendConfiguration > &	configuration,
		const std::shared_ptr< const ::tenduke::http::HTTPClient > &	httpClient,
		const std::shared_ptr< const ::tenduke::http::HTTPRequestAuthenticator > &	httpRequestAuthenticator,
		const std::shared_ptr< const ::tenduke::http::HTTPResponseToException > &	throwException,
		const std::shared_ptr< const ::tenduke::json::JSONParser > &	jsonParser,
		const std::shared_ptr< const ::tenduke::jwt::JWTParser > &	jwtParser,
		const std::shared_ptr< const ::tenduke::se::licensing::JWTToLease > &	jwtToLease
	)

Constructs new instance.

Parameters

clientProperties	-
configuration	-
httpClient	-
httpRequestAuthenticator	-
throwException	-
jsonParser	-
jwtParser	-
jwtToLease	-

Member Function Documentation

◆ checkout()

std::unique_ptr<::LicenseCheckoutRequest > tenduke::se::licensing::rest::ScaleLicensingApiImpl::checkout	(	const ::tenduke::se::licensing::LicenseCheckoutParameters &	parameters,
		const std::string &	licenseKey,
		bool	metered
	)		const

protectedvirtual

Helper to create checkout request.

Parameters

parameters	-
licenseKey	-
metered	-

Returns: -

◆ checkoutLicenses()

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

overridevirtual

Checkout license(s).

Parameters

parameters checkout parameters

Returns: executable request to checkout the licenses

Implements tenduke::se::licensing::rest::ScaleLicensingApi.

◆ checkoutLicensesWithKey()

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

overridevirtual

Checkout license(s) with license key.

Parameters

licenseKey	the license key
parameters	checkout parameters

Returns: executable request to checkout the licenses

Implements tenduke::se::licensing::rest::ScaleLicensingApi.

◆ describeLicenseKey()

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

overridevirtual

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

licenseKey	the license key
paging	-
withMetadata	-

Returns: executable request to describe the license key

Implements tenduke::se::licensing::rest::ScaleLicensingApi.

◆ endMeteredLicenseUse()

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

overridevirtual

Ends metered license use.

Parameters

parameters -

Returns: executable request to end metered license use

Implements tenduke::se::licensing::rest::ScaleLicensingApi.

◆ endMeteredLicenseUseByKey()

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

overridevirtual

Ends metered license use with license key.

Parameters

licenseKey	the license key
parameters	-

Returns: executable request to end metered license use

Implements tenduke::se::licensing::rest::ScaleLicensingApi.

◆ heartbeat()

std::unique_ptr<::LicenseHeartbeatRequest > tenduke::se::licensing::rest::ScaleLicensingApiImpl::heartbeat	(	const ::tenduke::se::licensing::LicenseHeartbeatParameters &	parameters,
		const std::string &	licenseKey,
		bool	metered
	)		const

protectedvirtual

Helper to create heartbeat request.

Parameters

parameters	-
licenseKey	-
metered	-

Returns: -

◆ heartbeatLicenses()

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

overridevirtual

Does license heartbeat.

Parameters

parameters -

Returns: executable request to do license heartbeat

Implements tenduke::se::licensing::rest::ScaleLicensingApi.

◆ heartbeatLicensesWithKey()

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

overridevirtual

Does license heartbeat with license key.

Parameters

licenseKey	the license key
parameters	-

Returns: executable request to do license heartbeat

Implements tenduke::se::licensing::rest::ScaleLicensingApi.

◆ heartbeatMeteredLicenseUse()

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

overridevirtual

Does license heartbeat for metered license use.

Parameters

parameters -

Returns: executable request to do license heartbeat

Implements tenduke::se::licensing::rest::ScaleLicensingApi.

◆ heartbeatMeteredLicenseUseByKey()

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

overridevirtual

Does license heartbeat with license key for metered license use.

Parameters

licenseKey	the license key
parameters	-

Returns: executable request to do license heartbeat

Implements tenduke::se::licensing::rest::ScaleLicensingApi.

◆ release()

std::unique_ptr<::LicenseReleaseRequest > tenduke::se::licensing::rest::ScaleLicensingApiImpl::release	(	const ::tenduke::se::licensing::LicenseReleaseParameters &	parameters,
		const std::string &	licenseKey,
		bool	metered
	)		const

protectedvirtual

Helper to create release request.

Parameters

parameters	-
licenseKey	-
metered	-

Returns: -

◆ releaseLicenses()

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

overridevirtual

Releases licenses.

Parameters

parameters -

Returns: executable request to release licenses

Implements tenduke::se::licensing::rest::ScaleLicensingApi.

◆ releaseLicensesWithKey()

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

overridevirtual

Releases licenses with license key.

Parameters

licenseKey	the license key
parameters	-

Returns: executable request to release licenses

Implements tenduke::se::licensing::rest::ScaleLicensingApi.

◆ startMeteredLicenseUse()

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

overridevirtual

Starts metere license use.

Parameters

parameters -

Returns: executable request to start metered license use

Implements tenduke::se::licensing::rest::ScaleLicensingApi.

◆ startMeteredLicenseUseWithKey()

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

overridevirtual

Starts metered license use with license key.

Parameters

licenseKey	the license key
parameters	-

Returns: executable request to start metered license use

Implements tenduke::se::licensing::rest::ScaleLicensingApi.

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

api/src/licensing/rest/licenses/ScaleLicensingApiImpl.h
api/src/licensing/rest/licenses/ScaleLicensingApiImpl.cpp

Detailed Description

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

◆ ScaleLicensingApiImpl()

Member Function Documentation

◆ checkout()

◆ checkoutLicenses()

◆ checkoutLicensesWithKey()

◆ describeLicenseKey()

◆ endMeteredLicenseUse()

◆ endMeteredLicenseUseByKey()

◆ heartbeat()

◆ heartbeatLicenses()

◆ heartbeatLicensesWithKey()

◆ heartbeatMeteredLicenseUse()

◆ heartbeatMeteredLicenseUseByKey()

◆ release()

◆ releaseLicenses()

◆ releaseLicensesWithKey()

◆ startMeteredLicenseUse()

◆ startMeteredLicenseUseWithKey()