tenduke::se::TendukeClientWithOIDCSession Class Reference

#include <TendukeClientWithOIDCSession.h>

Detailed Description

10Duke Scale client, which authorizes requests with OIDC/OAuth and maintains the OIDC session state automatically.

This client maintains the login state, that is, user session automatically. The application developer does not need to manually start login or refresh any state: First use of any API, which requires authentication, will automatically open a browser and require the user to log in. The client will automatically refresh the login session behind the scenes. If the login session expires, the client will open browser and require the user to log in.

You can register a listener for the session events (e.g. login starting or login complete). For details, see the factory functions below.

The client also maintains a local cache of the license leases checked out. See tenduke::se::licensing::LicensingClient for further details.

Because this client is stateful, you must keep the client alive for the duration of the application.

To create the client with browser-based login, use factory functions in createTendukeClientForBrowser.h.

• To create client with OIDC auto-discovery, use function tenduke::se::createTendukeClientForBrowserUsingAutodiscovery()
• To create client with manual configuration, use function tenduke::se::createTendukeClientForBrowser()

To create the client with OAuth/OIDC device flow (typically in platforms without browser, where authentication is done using a browser on another device), use factory functions in createTendukeClientForDevice.h

• To create client with OIDC auto-discovery, use function tenduke::se::createTendukeClientForDeviceClientUsingAutodiscovery()
• To create client with manual configuration, use function tenduke::se::createTendukeClientForDevice()

The client contains several services, some of which share common state. For details, see the following services:

• Licensing operations (e.g. checkout, release) are handled by tenduke::se::licensing::LicensingClient
• License leases are cached and can be inspected using tenduke::se::licensing::Leases
• You can query information about the licenses with tenduke::se::licensing::LicenseConsumers
• You can access the current user session state using tenduke::oidc::OIDCSession

Example of how to checkout license seat with the client:

tenduke::se::TendukeClientWithOIDCSession tendukeClient = tenduke::se::createTendukeClientForBrowserUsingAutodiscovery(...);
 
auto checkoutResponse = tendukeClient->licensing->checkoutLicenses()     // builds parameters fluently
    .version("1.0.0")       // version to checkout, applies to all following products if not overriden
    .seat("product-1")      // checkout one seat of "product-1"
    .execute();             // builds the parameters and executes checkout

Example of how to release the license leases checked out above:

auto releaseResponse = tendukeClient->licensing->releaseLicenses()
    .leases(checkoutResponse.leases)
    .execute();

Inheritance diagram for tenduke::se::TendukeClientWithOIDCSession:

Public Member Functions
	TendukeClientWithOIDCSession (const std::shared_ptr<::tenduke::se::licensing::LicensingClient > &licensingClient, const std::shared_ptr<::tenduke::se::licensing::Leases > &leases, const std::shared_ptr<::tenduke::se::licensing::LicenseConsumers > &licenseConsumers, const std::shared_ptr<::tenduke::oidc::OIDCSession > &oidcSession)
	Constructs new instance.
Public Member Functions inherited from tenduke::se::TendukeClient
	TendukeClient (const std::shared_ptr<::tenduke::se::licensing::LicensingClient > &licensingClient, const std::shared_ptr<::tenduke::se::licensing::Leases > &leases)
	Creates new client.
virtual std::string	serializeState ()=0
	Serializes the client state into a JSON.

Public Attributes
const std::shared_ptr<::tenduke::se::licensing::LicenseConsumers >	licenseConsumers
	Service for querying information about licenses.
const std::shared_ptr<::tenduke::oidc::OIDCSession >	oidcSession
	Service for maintaining the user login session.
Public Attributes inherited from tenduke::se::TendukeClient
const std::shared_ptr<::tenduke::se::licensing::LicensingClient >	licensing
	Licensing client.
const std::shared_ptr<::tenduke::se::licensing::Leases >	leases
	Lease-cache.

Constructor & Destructor Documentation

TendukeClientWithOIDCSession()

tenduke::se::TendukeClientWithOIDCSession::TendukeClientWithOIDCSession ( const std::shared_ptr<::tenduke::se::licensing::LicensingClient > &  licensingClient, const std::shared_ptr<::tenduke::se::licensing::Leases > &  leases, const std::shared_ptr<::tenduke::se::licensing::LicenseConsumers > &  licenseConsumers, const std::shared_ptr<::tenduke::oidc::OIDCSession > &  oidcSession  )

inline

Constructs new instance.

Parameters

licensingClient	-
leases	-
licenseConsumers	-
oidcSession	-

---

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

• api/src/TendukeClientWithOIDCSession.h