tenduke::ee::licensing Namespace Reference

Detailed Description

Classes, functions and globals related to 10Duke Enterprise licensing.

This namespace contains classes, functions and globals related to 10Duke Enterprise licensing.

Namespaces
namespace	authzapi
	Low-level client for licensing operations using 10Duke authz-API.
namespace	impl
	Implementations of licensing related services.

Classes
class	FluentLicenseCheckout
	Utility for fluently building tenduke::ee::licensing::LicenseCheckoutRequest. More...
class	FluentLicenseCheckoutBuilder
	Inheritable base class building checkout request parameters fluently. More...
class	FluentLicenseCheckoutParameters
	Builder for creating tenduke::ee::licensing::LicenseCheckoutParameters fluently. More...
class	FluentLicenseRelease
	Utility to release license(s) fluently. More...
class	FluentLicenseReleaseBuilder
	Utility for building tenduke::ee::licensing::LicenseReleaseRequest. More...
class	FluentLicenseReleaseParameters
	Utility for building tenduke::ee::licensing::LicenseReleaseParameters fluently. More...
class	FluentLicenseRenew
	Utility for fluently building tenduke::ee::licensing::authzapi::LicenseRenewRequest. More...
class	FluentLicenseRenewBuilder
	Inheritable base class building renew request parameters fluently. More...
class	FluentLicenseRenewParameters
	Builder for creating tenduke::ee::licensing::LicenseRenewParameters fluently. More...
class	InvalidLicenseToken
	Thrown in certain cases when license token is invalid. More...
class	Lease
	Describes checked out licensed item. More...
class	LicenseCheckoutItem
	Licensed item to be checked out. More...
class	LicenseCheckoutParameters
	Parameters for license checkout request. More...
class	LicenseCheckoutResponse
	Response from license checkout request. More...
class	LicenseReleaseParameters
	Parameters for license-release request. More...
class	LicenseRenewItem
	A license lease to renew. More...
class	LicenseRenewParameters
	Parameters for license renew request. More...
class	LicenseTokens
	Service for managing licenses tokens. More...
class	LicensingClient
	High-level client for licensing operations. More...
class	LicensingConfiguration
	10Duke licensing configuration. More...
class	LicensingError
	Describes an error returned from the API. More...
class	LicensingException
	Generic licensing-related exception. More...
class	LicensingResponse
	Response from tenduke::ee::licensing::LicensingRequest. More...
class	OfflineLicenseTokenParser
	Service for parsing standalone license tokens. More...

Functions
	LicenseReleaseResponse (const std::vector< std::string > &leaseIds, const std::map< std::string, tenduke::ee::licensing::LicensingError > &errors)
	Response from tenduke::ee::licensing::LicenseReleaseRequest.
bool	failed () override
	Checks it the entire request failed, i.e.
	LicenseRenewResponse (const std::map< std::string, tenduke::ee::licensing::Lease > &leases, const std::map< std::string, tenduke::ee::licensing::LicensingError > &errors)
	Response from license renew -request.
std::unique_ptr<::tenduke::ee::licensing::OfflineLicenseTokenParser >	createOfflineLicenseTokenParser (const std::string &validationKeyPEM)
	Creates instance of tenduke::ee::licensing::OfflineLicenseTokenParser.

Variables
const std::int64_t	LEASE_DOES_NOT_EXPIRE = -1
	Magic value for "lease expires epoch seconds" to denote that lease does not expire.
const std::vector< std::string >	leaseIds
	Id's of successfully released leases.

Function Documentation

createOfflineLicenseTokenParser()

std::unique_ptr<::OfflineLicenseTokenParser > tenduke::ee::licensing::createOfflineLicenseTokenParser

(

const std::string &

validationKeyPEM

)

Creates instance of tenduke::ee::licensing::OfflineLicenseTokenParser.

The function can be called and created service can be used without network connection.

Parameters

validationKeyPEM

Validation key in PEM-format. This key is used to validate signature of the license token. If empty string, then the signatures will not be validated.

Returns

new parser

Exceptions

tenduke::crypto::CryptoException

if the key is invalid

failed()

bool tenduke::ee::licensing::failed ( )

override

Checks it the entire request failed, i.e.

there are errors but no successfully released leases.

Returns

-

LicenseReleaseResponse()

tenduke::ee::licensing::LicenseReleaseResponse	(	const std::vector< std::string > &	leaseIds,
		const std::map< std::string, tenduke::ee::licensing::LicensingError > &	errors )

Response from tenduke::ee::licensing::LicenseReleaseRequest.

Like the checkout response, the result is not atomic: Some items may have failed, some succeeded. See `tenduke::ee::licensing::LicenseCheckoutResponse" for details. */ class LicenseReleaseResponse : public tenduke::ee::licensing::LicensingResponse { public: /** Constructs new instance.

Parameters

leaseIds	ID's of released leases
errors	the failed leases. Key is the lease id.

LicenseRenewResponse()

tenduke::ee::licensing::LicenseRenewResponse	(	const std::map< std::string, tenduke::ee::licensing::Lease > &	leases,
		const std::map< std::string, tenduke::ee::licensing::LicensingError > &	errors )

Response from license renew -request.

Like the checkout response, the result is not atomic: Some items may have failed, some succeeded. See `tenduke::ee::licensing::LicenseCheckoutResponse" for details. */ class LicenseRenewResponse : public tenduke::ee::licensing::LicenseCheckoutResponse { public: /** Constructs new instance.

Parameters

leases	successfully renewed leases. Key is the licensed item name.
errors	the failed licensed items. Key is the licensed item name.