10Duke Enterprise C++ Client
Loading...
Searching...
No Matches
tenduke::ee::licensing::authzapi::AuthzLicensingClient Class Referenceabstract

#include <AuthzLicensingClient.h>

Detailed Description

Low-level client for licensing operations using 10Duke /authz/-API.

You probably want to use higher level client (see tenduke::ee::licensing::LicensingClient).

This client is a factory, creating requests for actions like checkout. The created requests perform the actual call. The requests are reusable, which might be useful if you want to do re-try logic.

See https://docs.enterprise.10duke.com/developer-guide/consuming-licenses/consume-a-license/.

Inheritance diagram for tenduke::ee::licensing::authzapi::AuthzLicensingClient:
tenduke::ee::licensing::authzapi::DefaultAuthzLicensingClient tenduke::test::mocks::AuthzLicensingClientMock

Public Member Functions

virtual std::unique_ptr< tenduke::ee::licensing::authzapi::LicenseCheckoutRequestcheckout (const tenduke::ee::licensing::LicenseCheckoutParameters &parameters) const =0
 Checks out license(s).
 
virtual std::unique_ptr< tenduke::ee::licensing::authzapi::LicenseReleaseRequestrelease (const tenduke::ee::licensing::LicenseReleaseParameters &parameters) const =0
 Releases checked out license(s).
 
virtual std::unique_ptr<::tenduke::ee::licensing::authzapi::LicenseRenewRequestrenew (const ::tenduke::ee::licensing::LicenseRenewParameters &parameters) const =0
 Renews leases of checked out license(s).
 

Member Function Documentation

◆ checkout()

virtual std::unique_ptr< tenduke::ee::licensing::authzapi::LicenseCheckoutRequest > tenduke::ee::licensing::authzapi::AuthzLicensingClient::checkout ( const tenduke::ee::licensing::LicenseCheckoutParameters parameters) const
pure virtual

Checks out license(s).

Creates a checkout request. Call tenduke::ee::licensing::authzapi::LicenseCheckoutRequest::execute() on the request.

Parameters
parametersthe request parameters
Returns
the request

Implemented in tenduke::ee::licensing::authzapi::DefaultAuthzLicensingClient.

◆ release()

virtual std::unique_ptr< tenduke::ee::licensing::authzapi::LicenseReleaseRequest > tenduke::ee::licensing::authzapi::AuthzLicensingClient::release ( const tenduke::ee::licensing::LicenseReleaseParameters parameters) const
pure virtual

Releases checked out license(s).

Creates a release request. Call tenduke::ee::licensing::authzapi::LicenseReleaseRequest::execute() on the request.

Parameters
parametersthe request parameters
Returns
the request

Implemented in tenduke::ee::licensing::authzapi::DefaultAuthzLicensingClient.

◆ renew()

virtual std::unique_ptr<::tenduke::ee::licensing::authzapi::LicenseRenewRequest > tenduke::ee::licensing::authzapi::AuthzLicensingClient::renew ( const ::tenduke::ee::licensing::LicenseRenewParameters parameters) const
pure virtual

Renews leases of checked out license(s).

Creates a renew request. Call tenduke::ee::licensing::authzapi::LicenseRenewRequest::execute() on the request.

Parameters
parametersthe request parameters
Returns
the request

Implemented in tenduke::ee::licensing::authzapi::DefaultAuthzLicensingClient.


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