tenduke::se::licensing::rest::DefaultDescribeLicenseKeyRequest Class Reference

#include <DefaultDescribeLicenseKeyRequest.h>

Detailed Description

Default implmentation of tenduke::se::licensing::rest::DescribeLicenseKeyRequest.

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

Public Member Functions
	DefaultDescribeLicenseKeyRequest (const ::tenduke::se::BackendConfiguration &backendConfiguration, 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, std::string licenseKey, const ::tenduke::se::Paging &paging, bool withMetadata)
	Constructs new instance.
::tenduke::se::licensing::LicenseKeyLicensesStatus	execute () override
	Execute the request synchronously.
Public Member Functions inherited from tenduke::se::licensing::rest::AbstractPagingAPIRequest<::tenduke::se::licensing::LicenseKeyLicensesStatus >
	AbstractPagingAPIRequest (const std::string &baseUrl, 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, ::tenduke::se::Paging paging)
	Constructs new instance.
Public Member Functions inherited from tenduke::se::licensing::rest::AbstractAPIRequestMixin< T >
	AbstractAPIRequestMixin (std::string baseUrl, 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::LicenseKeyLicensesStatus	fromJSON (const std::string &responseBody) const override
	Converts the response body from JSON to the response type.
void	buildUrl (::tenduke::net::URLBuilder &) const override
	Builds the request URL.
Protected Member Functions inherited from tenduke::se::licensing::rest::AbstractPagingAPIRequest<::tenduke::se::licensing::LicenseKeyLicensesStatus >
::tenduke::http::HTTPRequestBuilder &	setHeaders (::tenduke::http::HTTPRequestBuilder &request) const override
	Sets the paging headers to the request.
Protected Member Functions inherited from tenduke::se::licensing::rest::AbstractAPIRequestMixin< T >
virtual T	executeRequest ()
	Executes the request.
virtual ::tenduke::http::HTTPRequestBuilder &	setHeaders (::tenduke::http::HTTPRequestBuilder &request) const
	Sets additional headers.

Additional Inherited Members
Protected Attributes inherited from tenduke::se::licensing::rest::AbstractAPIRequestMixin< T >
const std::string	baseUrl
	Base-URL for the request.
const std::shared_ptr< const ::tenduke::http::HTTPClient >	http
	HTTP-client to execute the request.
const std::shared_ptr< const ::tenduke::http::HTTPRequestAuthenticator >	httpRequestAuthenticator
	For authenticating the request.
const std::shared_ptr< const ::tenduke::http::HTTPResponseToException >	throwException
	Service to throw exceptions based on HTTP status codes.
const std::shared_ptr< const ::tenduke::json::JSONParser >	parseJSON
	For parsing the response payload.

Constructor & Destructor Documentation

DefaultDescribeLicenseKeyRequest()

tenduke::se::licensing::rest::DefaultDescribeLicenseKeyRequest::DefaultDescribeLicenseKeyRequest	(	const ::tenduke::se::BackendConfiguration &	backendConfiguration,
		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,
		std::string	licenseKey,
		const ::tenduke::se::Paging &	paging,
		bool	withMetadata
	)

Constructs new instance.

Parameters

backendConfiguration	-
httpClient	-
httpRequestAuthenticator	-
throwException	-
jsonParser	-
licenseKey	-
paging	-
withMetadata	-

Member Function Documentation

buildUrl()

void tenduke::se::licensing::rest::DefaultDescribeLicenseKeyRequest::buildUrl ( ::tenduke::net::URLBuilder &  urlBuilder ) const

overrideprotectedvirtual

Builds the request URL.

Parameters

urlBuilder

-

Reimplemented from tenduke::se::licensing::rest::AbstractAPIRequestMixin< T >.

execute()

LicenseKeyLicensesStatus tenduke::se::licensing::rest::DefaultDescribeLicenseKeyRequest::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< T >.

fromJSON()

LicenseKeyLicensesStatus tenduke::se::licensing::rest::DefaultDescribeLicenseKeyRequest::fromJSON ( const std::string &  responseBody ) const

overrideprotectedvirtual

Converts the response body from JSON to the response type.

Parameters

responseBody

-

Returns

-

Implements tenduke::se::licensing::rest::AbstractAPIRequestMixin< T >.

---

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

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