tenduke::ee::licensing::LicensingClient Class Reference

#include <LicensingClient.h>

Detailed Description

High-level client for licensing operations.

This service provides operations for checking out and releasing licenses.

Methods have two overloads: one with parameters, and another one, which builds the parameters fluently and then calls the actual methods. For example, to checkout license fluently:

tenduke::ee::licensing::LicensingClient &client = ...; // get the client from somewhere
auto result = client.checkoutLicenses()
  .seat("product-1")
  .execute(); // execute() will call client.checkoutLicenses(parameters) under the hood.

Methods annotated to throw exceptions (this includes the execute() of the fluent request builders) throw exceptions inheriting from tenduke::TendukeException. Examples:

• tenduke::net::NetworkingException (and subclasses) when a networking problem occurs, for example tenduke::net::RequestTimedOut when network request times out
• tenduke::http::HTTPException (and subclasses) when for example the server returns HTTP-error code. Typical example might be tenduke::http::ServerError when server has internal problems or is in maintenance.
• tenduke::jwt::JWTParsingException (and subclasses) when JWT-parsing fails. These should not usually happen, but might be caused by corrupt response. For example tenduke::jwt::JWTValidationException might indicate some issue with validation (corrupt checksum, incorrect validation key), but also might be cause if some one has tampered the token

The default implementation provided out-of-the box is tenduke::ee::licensing::impl::StatefulLicensingClient. See the class description for more details (particularly how the user session is maintained).

Inheritance diagram for tenduke::ee::licensing::LicensingClient:

Public Member Functions
virtual tenduke::ee::licensing::LicenseCheckoutResponse	checkoutLicenses (const tenduke::ee::licensing::LicenseCheckoutParameters &parameters) const =0
	Checks out license(s).
virtual tenduke::ee::licensing::FluentLicenseCheckout	checkoutLicenses () const =0
	Checks out license(s) fluently.
virtual tenduke::ee::licensing::LicenseReleaseResponse	releaseLicenses (const tenduke::ee::licensing::LicenseReleaseParameters &parameters) const =0
	Releases checked out license(s).
virtual tenduke::ee::licensing::FluentLicenseRelease	releaseLicenses () const =0
	Releases checked out license(s) fluently.
virtual::tenduke::ee::licensing::LicenseRenewResponse	renewLeases (const ::tenduke::ee::licensing::LicenseRenewParameters &parameters) const =0
	Renews leases.
virtual::tenduke::ee::licensing::FluentLicenseRenew	renewLeases () const =0
	Renews leases fluently.

Member Function Documentation

checkoutLicenses() [1/2]

virtual tenduke::ee::licensing::FluentLicenseCheckout tenduke::ee::licensing::LicensingClient::checkoutLicenses ( ) const

pure virtual

Checks out license(s) fluently.

See the tenduke::ee::licensing::FluentLicenseCheckout (and its superclass) for complete set of parameters.

Returns

checkoutLicenses builder

Implemented in StatefulLicensingClient, and tenduke::ee::licensing::impl::StatefulLicensingClient.

checkoutLicenses() [2/2]

virtual tenduke::ee::licensing::LicenseCheckoutResponse tenduke::ee::licensing::LicensingClient::checkoutLicenses ( const tenduke::ee::licensing::LicenseCheckoutParameters & parameters ) const

pure virtual

Checks out license(s).

Parameters

parameters

the request parameters

Returns

the result

Exceptions

tenduke::TendukeException

and subclasses. See class documentation.

Implemented in StatefulLicensingClient, and tenduke::ee::licensing::impl::StatefulLicensingClient.

releaseLicenses() [1/2]

virtual tenduke::ee::licensing::FluentLicenseRelease tenduke::ee::licensing::LicensingClient::releaseLicenses ( ) const

pure virtual

Releases checked out license(s) fluently.

See the tenduke::ee::licensing::FluentLicenseRelease (and its superclass) for complete set of parameters.

Returns

release builder

Implemented in StatefulLicensingClient, and tenduke::ee::licensing::impl::StatefulLicensingClient.

releaseLicenses() [2/2]

virtual tenduke::ee::licensing::LicenseReleaseResponse tenduke::ee::licensing::LicensingClient::releaseLicenses ( const tenduke::ee::licensing::LicenseReleaseParameters & parameters ) const

pure virtual

Releases checked out license(s).

Parameters

parameters

the request parameters

Returns

the result

Exceptions

tenduke::TendukeException

and subclasses. See class documentation.

Implemented in StatefulLicensingClient, and tenduke::ee::licensing::impl::StatefulLicensingClient.

renewLeases() [1/2]

virtual::tenduke::ee::licensing::FluentLicenseRenew tenduke::ee::licensing::LicensingClient::renewLeases ( ) const

pure virtual

Renews leases fluently.

See tenduke::ee::licensing::LicensingClient::renewLeases(const tenduke::ee::licensing::LicenseRenewParameters &) const for details.

Returns

renew-leases builder

Implemented in StatefulLicensingClient, and tenduke::ee::licensing::impl::StatefulLicensingClient.

renewLeases() [2/2]

virtual::tenduke::ee::licensing::LicenseRenewResponse tenduke::ee::licensing::LicensingClient::renewLeases ( const ::tenduke::ee::licensing::LicenseRenewParameters & parameters ) const

pure virtual

Renews leases.

NOTE: Renewal returns new leases (i.e. leases with new lease ID), these leases replace the original leases.

Parameters

parameters

the request parameters

Returns

the result

Exceptions

tenduke::TendukeException

and subclasses. See class documentation.

Implemented in StatefulLicensingClient, and tenduke::ee::licensing::impl::StatefulLicensingClient.

---

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

• client/enterprise/api/src/licensing/LicensingClient.h