tenduke::se::licensing::DefaultLicenseConsumers Class Reference

#include <DefaultLicenseConsumers.h>

Detailed Description

Default implementation of tenduke::se::licensing::LicenseConsumers.

This is stateful service, which maintains the OIDC-session automatically, that is, the service automatically shows browser to log the user in, when necessary.

Inheritance diagram for tenduke::se::licensing::DefaultLicenseConsumers:

Public Member Functions
	DefaultLicenseConsumers (const std::shared_ptr< const ::tenduke::se::licensing::rest::ScaleConsumersApi > &rest, const std::shared_ptr<::tenduke::oidc::OIDCSession > &oidc)
	Constructs new instance.
tenduke::se::licensing::LicenseConsumerClientBindingStatus	describeLicenseConsumerClientBindings (const std::string &licenseeId, const std::string &licenseConsumerId, const ::tenduke::se::Paging &paging, const ::tenduke::se::Filter &filter) override
	Analyzes licenses that a license consumer is known to have a checkout for currently.
::tenduke::se::licensing::LicenseConsumerClientBindingStatus	describeLicenseConsumerClientBindings (const std::string &licenseeId) override
	Overload of describeLicenseConsumerClientBindings, which provides default values for optional arguments.
std::vector<::tenduke::se::licensing::Licensee >	describeLicenseConsumerLicensees (const std::string &licenseConsumerId, const ::tenduke::se::Paging &paging) override
	Returns Licensees the LicenseConsumer is associated to.
std::vector<::tenduke::se::licensing::Licensee >	describeLicenseConsumerLicensees () override
	Overload of describeLicenseConsumerLicensees, which provides default values for optional parameters.
::tenduke::se::licensing::LicenseConsumerLicensesStatus	describeLicenseConsumerLicenses (const std::string &licenseeId, const std::string &licenseConsumerId, const ::tenduke::se::Paging &paging) override
	Returns Licenses of given Licensee, which the LicenseConsumer can access.
::tenduke::se::licensing::LicenseConsumerLicensesStatus	describeLicenseConsumerLicenses (const std::string &licenseeId) override
	Overload of describeLicenseConsumerLicenses, which provides default values for optional parameters.

Constructor & Destructor Documentation

DefaultLicenseConsumers()

tenduke::se::licensing::DefaultLicenseConsumers::DefaultLicenseConsumers	(	const std::shared_ptr< const ::tenduke::se::licensing::rest::ScaleConsumersApi > &	rest,
		const std::shared_ptr<::tenduke::oidc::OIDCSession > &	oidc
	)

Constructs new instance.

Parameters

rest	-
oidc	-

Member Function Documentation

describeLicenseConsumerClientBindings() [1/2]

LicenseConsumerClientBindingStatus tenduke::se::licensing::DefaultLicenseConsumers::describeLicenseConsumerClientBindings ( const std::string &  licenseeId )

overridevirtual

Overload of describeLicenseConsumerClientBindings, which provides default values for optional arguments.

Parameters

licenseeId

Identifier of the licensee that the license belongs to.

Returns

-

Implements tenduke::se::licensing::LicenseConsumers.

describeLicenseConsumerClientBindings() [2/2]

LicenseConsumerClientBindingStatus tenduke::se::licensing::DefaultLicenseConsumers::describeLicenseConsumerClientBindings ( const std::string &  licenseeId, const std::string &  licenseConsumerId, const ::tenduke::se::Paging &  paging, const ::tenduke::se::Filter &  filter  )

overridevirtual

Analyzes licenses that a license consumer is known to have a checkout for currently.

Parameters

licenseeId	Identifier of the licensee that the license belongs to.
licenseConsumerId	Identifier of the license consumer that the the information is scoped to. NOTE: When using OIDC-authorization, this value is not used: Pass empty string.
paging	-
filter	-

Returns

-

Implements tenduke::se::licensing::LicenseConsumers.

describeLicenseConsumerLicensees() [1/2]

std::vector<::Licensee > tenduke::se::licensing::DefaultLicenseConsumers::describeLicenseConsumerLicensees ( )

overridevirtual

Overload of describeLicenseConsumerLicensees, which provides default values for optional parameters.

Returns

-

Implements tenduke::se::licensing::LicenseConsumers.

describeLicenseConsumerLicensees() [2/2]

std::vector<::Licensee > tenduke::se::licensing::DefaultLicenseConsumers::describeLicenseConsumerLicensees ( const std::string &  licenseConsumerId, const ::tenduke::se::Paging &  paging  )

overridevirtual

Returns Licensees the LicenseConsumer is associated to.

Parameters

licenseConsumerId	id of the LicenseConsumer. NOTE: When using OIDC-authorization, this value is not used
paging	-

Returns

-

Implements tenduke::se::licensing::LicenseConsumers.

describeLicenseConsumerLicenses() [1/2]

LicenseConsumerLicensesStatus tenduke::se::licensing::DefaultLicenseConsumers::describeLicenseConsumerLicenses ( const std::string &  licenseeId )

overridevirtual

Overload of describeLicenseConsumerLicenses, which provides default values for optional parameters.

Parameters

licenseeId

id of the Licensee.

Returns

-

Implements tenduke::se::licensing::LicenseConsumers.

describeLicenseConsumerLicenses() [2/2]

LicenseConsumerLicensesStatus tenduke::se::licensing::DefaultLicenseConsumers::describeLicenseConsumerLicenses ( const std::string &  licenseeId, const std::string &  licenseConsumerId, const ::tenduke::se::Paging &  paging  )

overridevirtual

Returns Licenses of given Licensee, which the LicenseConsumer can access.

Parameters

licenseeId	id of the Licensee.
licenseConsumerId	id of the LicenseConsumer. NOTE: When using OIDC-authorization, this value is not used
paging	-

Returns

-

Implements tenduke::se::licensing::LicenseConsumers.

---

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

• api/src/licensing/impl/consumers/DefaultLicenseConsumers.h
• api/src/licensing/impl/consumers/DefaultLicenseConsumers.cpp