tenduke::se::licensing::rest::DefaultLicenseCheckoutRequest Class Reference

#include <DefaultLicenseCheckoutRequest.h>

Detailed Description

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

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

Public Member Functions
	DefaultLicenseCheckoutRequest (::tenduke::se::licensing::LicenseCheckoutParameters parameters, const std::shared_ptr< const ::tenduke::se::ClientProperties > &clientProperties, const std::shared_ptr< const ::tenduke::se::rest::RESTConfiguration > &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, const std::string &licenseKey=::tenduke::se::licensing::rest::AbstractLicenseRequest::NO_LICENSE_KEY, bool metered=::tenduke::se::licensing::rest::AbstractLicenseRequest::NON_METERED)
	Constructs new instance.
::tenduke::se::licensing::LicenseCheckoutResponse	execute () override
	Execute the request synchronously.
Public Member Functions inherited from tenduke::se::licensing::rest::AbstractLicenseRequest
	AbstractLicenseRequest (std::string licenseKey, bool metered, const std::shared_ptr< const ::tenduke::se::ClientProperties > &clientProperties, const std::shared_ptr< const ::tenduke::se::rest::RESTConfiguration > &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)
	Constructs new instance.

Protected Member Functions
::tenduke::se::licensing::LicenseCheckoutResponse	fromJSON (const std::string &jsonDocument) const
	Maps the request entity from JSON message payload.
Protected Member Functions inherited from tenduke::se::licensing::rest::AbstractLicenseRequest
std::string	getLicenseKey () const
	Returns license key.
bool	hasLicenseKey () const
	Checks if this is license-key request.
bool	isMetered () const
	Checks if this metered-request.
void	setClientClaims (::tenduke::http::HTTPRequestBuilder &request) const
	Sets client claims to the request.

Additional Inherited Members
Static Public Attributes inherited from tenduke::se::licensing::rest::AbstractLicenseRequest
static const std::string	NO_LICENSE_KEY
	Magic value to indicate that this is not a license key request.
static const bool	METERED = true
	Magic value to indicate that this is metered license request.
static const bool	NON_METERED = false
	Magic value to indicate that this is normal (not metered) license request.
Protected Attributes inherited from tenduke::se::licensing::rest::AbstractLicenseRequest
const std::shared_ptr< const ::tenduke::se::ClientProperties >	clientProperties
	Client properties.
const std::shared_ptr< const ::tenduke::se::rest::RESTConfiguration >	configuration
	Config.
const std::shared_ptr< const ::tenduke::http::HTTPClient >	http
	HTTP-client.
const std::shared_ptr< const ::tenduke::http::HTTPRequestAuthenticator >	httpRequestAuthenticator
	HTTP-request authenticator.
const std::shared_ptr< const ::tenduke::http::HTTPResponseToException >	throwException
	Throw-exception.
const std::shared_ptr< const ::tenduke::json::JSONParser >	parseJSON
	Parses JSON.

Constructor & Destructor Documentation

DefaultLicenseCheckoutRequest()

tenduke::se::licensing::rest::DefaultLicenseCheckoutRequest::DefaultLicenseCheckoutRequest	(	::tenduke::se::licensing::LicenseCheckoutParameters	parameters,
		const std::shared_ptr< const ::tenduke::se::ClientProperties > &	clientProperties,
		const std::shared_ptr< const ::tenduke::se::rest::RESTConfiguration > &	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,
		const std::string &	licenseKey = ::tenduke::se::licensing::rest::AbstractLicenseRequest::NO_LICENSE_KEY,
		bool	metered = ::tenduke::se::licensing::rest::AbstractLicenseRequest::NON_METERED )

Constructs new instance.

Parameters

parameters	-
clientProperties	-
configuration	-
httpClient	-
httpRequestAuthenticator	-
throwException	-
jsonParser	-
jwtParser	-
jwtToLease	-
licenseKey	-
metered	-

Member Function Documentation

execute()

LicenseCheckoutResponse tenduke::se::licensing::rest::DefaultLicenseCheckoutRequest::execute ( )

overridevirtual

Execute the request synchronously.

Returns

the response.

Exceptions

tenduke::http::HTTPException	e.g. internal server errors, invalid configuration (e.g. HTTP 404 not found) et al.
tenduke::net::NetworkingException	e.g. timeouts, networking communication problems
tenduke::TimedOut	generic time outs
tenduke::TendukeException	depending on business logic problems (invalid json, cryptography issues, unexpected response etc.) These are usually subclasses of tenduke::TendukeException

Implements tenduke::se::APIRequest<::tenduke::se::licensing::LicenseCheckoutResponse >.

---

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

• api/src/licensing/rest/licenses/DefaultLicenseCheckoutRequest.h
• api/src/licensing/rest/licenses/DefaultLicenseCheckoutRequest.cpp