10Duke Scale C++ Client
|
Classes, functions and globals of 10Duke Scale C++ Client.
This namespace contains classes, functions and globals related to 10Duke Scale.
Namespaces | |
namespace | http |
10Duke Scale C++ Client -specific HTTP implementation. | |
namespace | licensing |
Licensing operations for 10Duke Scale. | |
Classes | |
class | APIRequest |
Interface for 10Duke Scale API-requests. More... | |
class | BackendConfiguration |
Configuration for the 10Duke Scale backend to bootstrap the client. More... | |
class | ClientProperties |
Properties of the client ("Client application claims") More... | |
class | ClientPropertiesBuilder |
For building the client properties fluently. More... | |
struct | ClientState |
Container for client state. More... | |
class | DeserializeStateFromJSON |
Service for deserializing client state from JSON. More... | |
class | Filter |
Filter-definition for the REST-API. More... | |
class | Paging |
Paging-ocnfiguration for the REST-API. More... | |
class | SerializeStateToJSON |
Serializes client state to JSON. More... | |
class | StatefulAPIRequest |
A tenduke::se::APIRequest , which uses tenduke::oidc::OIDCSession to maintain request authorization. More... | |
class | TendukeClient |
Base 10Duke Scale client, usable standalone for licensekey-based operations without user login. More... | |
class | TendukeClientWithOIDCSession |
10Duke Scale client, which authorizes requests with OIDC/OAuth and maintains the OIDC session state automatically. More... | |
class | TendukeClientWithOIDCSessionImpl |
Implementation of tenduke::se::TendukeClientWithOIDCSession . More... | |
Functions | |
std::unique_ptr<::tenduke::se::TendukeClientWithOIDCSession > | createClient (const ::tenduke::TendukeServices &services, const ::tenduke::se::ClientProperties &clientProperties, const ::tenduke::se::BackendConfiguration &backendConfiguration, const std::shared_ptr< const ::tenduke::oauth::OAuthConfiguration > &oauthConfiguration, const std::shared_ptr< const ::tenduke::oidc::OIDCConfiguration > &oidcConfiguration, const ::tenduke::se::ClientState &initialState, const std::shared_ptr<::tenduke::oidc::OIDCSession > &oidcSession) |
Creates the 10Duke Scale client with given parameters. | |
std::unique_ptr<::tenduke::se::TendukeClientWithOIDCSession > | createTendukeClientForBrowser (const std::string &clientIdentifier, const ::tenduke::se::BackendConfiguration &backendConfiguration, const ::tenduke::se::ClientProperties &clientProperties, const ::tenduke::oauth::OAuthBackendConfiguration &oauthBackendConfiguration, const ::tenduke::oidc::OIDCConfiguration &oidcConfiguration, const ::tenduke::oidc::osbrowser::BrowserAuthenticationConfig &authenticationConfig, const std::string &initialStateAsJSON="", const ::tenduke::ServiceConfiguration &serviceConfiguration=::tenduke::ServiceConfiguration()) |
Creates stateful client, which authenticates user with default OS-browser, using provided configuration. | |
std::unique_ptr<::tenduke::se::TendukeClientWithOIDCSession > | createTendukeClientForBrowserUsingAutodiscovery (const std::string &clientIdentifier, const ::tenduke::se::BackendConfiguration &backendConfiguration, const ::tenduke::se::ClientProperties &clientProperties, const std::string &oidcAutodiscoveryURL, const ::tenduke::oidc::osbrowser::BrowserAuthenticationConfig &authenticationConfig, const std::string &initialStateAsJSON="", const ::tenduke::ServiceConfiguration &serviceConfiguration=::tenduke::ServiceConfiguration()) |
Creates stateful client, which authenticates user with default OS-browser, using OIDC auto-discovery. | |
std::unique_ptr<::tenduke::se::TendukeClientWithOIDCSession > | createTendukeClientForDevice (const std::string &clientIdentifier, const ::tenduke::se::BackendConfiguration &backendConfiguration, const ::tenduke::se::ClientProperties &clientProperties, const ::tenduke::oauth::OAuthBackendConfiguration &oauthBackendConfiguration, const ::tenduke::oidc::OIDCConfiguration &oidcConfiguration, const ::tenduke::oidc::device::DeviceAuthenticationConfig &authenticationConfig, const std::string &initialStateAsJSON="", const ::tenduke::ServiceConfiguration &serviceConfiguration=::tenduke::ServiceConfiguration()) |
Creates stateful client, which authenticates user with OAuth Device Flow, using provided configuration. | |
std::unique_ptr<::tenduke::se::TendukeClientWithOIDCSession > | createTendukeClientForDeviceClientUsingAutodiscovery (const std::string &clientIdentifier, const ::tenduke::se::BackendConfiguration &backendConfiguration, const ::tenduke::se::ClientProperties &clientProperties, const std::string &oidcAutodiscoveryURL, const ::tenduke::oidc::device::DeviceAuthenticationConfig &authenticationConfig, const std::string &initialStateAsJSON="", const ::tenduke::ServiceConfiguration &serviceConfiguration=::tenduke::ServiceConfiguration()) |
Creates stateful client, which authenticates user with OAuth Device Flow, using OIDC auto-discovery. | |
std::unique_ptr<::tenduke::se::TendukeClient > | createTendukeClientForLicenseKeyUsage (const std::string &clientIdentifier, const ::tenduke::se::BackendConfiguration &backendConfiguration, const ::tenduke::se::ClientProperties &clientProperties, const std::string &initialStateAsJson="", const ::tenduke::ServiceConfiguration &serviceConfiguration=::tenduke::ServiceConfiguration()) |
Creates a client for using license-key -operations only. | |
std::unique_ptr<::tenduke::se::TendukeClientWithOIDCSession > tenduke::se::createClient | ( | const ::tenduke::TendukeServices & | services, |
const ::tenduke::se::ClientProperties & | clientProperties, | ||
const ::tenduke::se::BackendConfiguration & | backendConfiguration, | ||
const std::shared_ptr< const ::tenduke::oauth::OAuthConfiguration > & | oauthConfiguration, | ||
const std::shared_ptr< const ::tenduke::oidc::OIDCConfiguration > & | oidcConfiguration, | ||
const ::tenduke::se::ClientState & | initialState, | ||
const std::shared_ptr<::tenduke::oidc::OIDCSession > & | oidcSession ) |
Creates the 10Duke Scale client with given parameters.
This factory function is mostly for internal use.
services | - |
clientProperties | - |
backendConfiguration | - |
oauthConfiguration | - |
oidcConfiguration | - |
initialState | - |
oidcSession | - |
std::unique_ptr<::tenduke::se::TendukeClientWithOIDCSession > tenduke::se::createTendukeClientForBrowser | ( | const std::string & | clientIdentifier, |
const ::tenduke::se::BackendConfiguration & | backendConfiguration, | ||
const ::tenduke::se::ClientProperties & | clientProperties, | ||
const ::tenduke::oauth::OAuthBackendConfiguration & | oauthBackendConfiguration, | ||
const ::tenduke::oidc::OIDCConfiguration & | oidcConfiguration, | ||
const ::tenduke::oidc::osbrowser::BrowserAuthenticationConfig & | authenticationConfig, | ||
const std::string & | initialStateAsJSON = "", | ||
const ::tenduke::ServiceConfiguration & | serviceConfiguration = ::tenduke::ServiceConfiguration() ) |
Creates stateful client, which authenticates user with default OS-browser, using provided configuration.
clientIdentifier | identifies the client, used as User-Agent in HTTP-requests |
backendConfiguration | configuration of 10Duke Scale backend |
clientProperties | client properties, see the class for details |
oauthBackendConfiguration | OAuth backend configuration (for user authentication) |
oidcConfiguration | OIDC configuration (for user authentication) |
authenticationConfig | configuration for browser-based OIDC authentication |
initialStateAsJSON | initial client state as JSON. Optional. |
serviceConfiguration | generic service configuration. Optional. |
std::unique_ptr<::tenduke::se::TendukeClientWithOIDCSession > tenduke::se::createTendukeClientForBrowserUsingAutodiscovery | ( | const std::string & | clientIdentifier, |
const ::tenduke::se::BackendConfiguration & | backendConfiguration, | ||
const ::tenduke::se::ClientProperties & | clientProperties, | ||
const std::string & | oidcAutodiscoveryURL, | ||
const ::tenduke::oidc::osbrowser::BrowserAuthenticationConfig & | authenticationConfig, | ||
const std::string & | initialStateAsJSON = "", | ||
const ::tenduke::ServiceConfiguration & | serviceConfiguration = ::tenduke::ServiceConfiguration() ) |
Creates stateful client, which authenticates user with default OS-browser, using OIDC auto-discovery.
clientIdentifier | identifies the client, used as User-Agent in HTTP-requests |
backendConfiguration | 10Duke Scale backend configuration |
clientProperties | Client properties |
oidcAutodiscoveryURL | URL to OIDC-autodiscovery document |
authenticationConfig | configuration for browser-based OIDC authentication |
initialStateAsJSON | initial client state as JSON. Optional. |
serviceConfiguration | generic service configuration. Optional. |
std::unique_ptr<::tenduke::se::TendukeClientWithOIDCSession > tenduke::se::createTendukeClientForDevice | ( | const std::string & | clientIdentifier, |
const ::tenduke::se::BackendConfiguration & | backendConfiguration, | ||
const ::tenduke::se::ClientProperties & | clientProperties, | ||
const ::tenduke::oauth::OAuthBackendConfiguration & | oauthBackendConfiguration, | ||
const ::tenduke::oidc::OIDCConfiguration & | oidcConfiguration, | ||
const ::tenduke::oidc::device::DeviceAuthenticationConfig & | authenticationConfig, | ||
const std::string & | initialStateAsJSON = "", | ||
const ::tenduke::ServiceConfiguration & | serviceConfiguration = ::tenduke::ServiceConfiguration() ) |
Creates stateful client, which authenticates user with OAuth Device Flow, using provided configuration.
clientIdentifier | identifies the client, used as User-Agent in HTTP-requests |
oauthBackendConfiguration | OAuth backend configuration (for user authentication) |
oidcConfiguration | OIDC configuration (for user authentication) |
backendConfiguration | 10Duke Scale backend configuration |
clientProperties | Client properties |
authenticationConfig | - |
initialStateAsJSON | Initial client state as JSON. |
serviceConfiguration | - |
std::unique_ptr<::TendukeClientWithOIDCSession > tenduke::se::createTendukeClientForDeviceClientUsingAutodiscovery | ( | const std::string & | clientIdentifier, |
const ::tenduke::se::BackendConfiguration & | backendConfiguration, | ||
const ::tenduke::se::ClientProperties & | clientProperties, | ||
const std::string & | oidcAutodiscoveryURL, | ||
const ::tenduke::oidc::device::DeviceAuthenticationConfig & | authenticationConfig, | ||
const std::string & | initialStateAsJSON = "", | ||
const ::tenduke::ServiceConfiguration & | serviceConfiguration = ::tenduke::ServiceConfiguration() ) |
Creates stateful client, which authenticates user with OAuth Device Flow, using OIDC auto-discovery.
clientIdentifier | identifies the client, used as User-Agent in HTTP-requests |
backendConfiguration | 10Duke Scale backend configuration |
clientProperties | Client properties |
oidcAutodiscoveryURL | URL to OIDC discovery document |
authenticationConfig | - |
initialStateAsJSON | Initial client state as JSON. |
serviceConfiguration | - |
std::unique_ptr<::TendukeClient > tenduke::se::createTendukeClientForLicenseKeyUsage | ( | const std::string & | clientIdentifier, |
const ::tenduke::se::BackendConfiguration & | backendConfiguration, | ||
const ::tenduke::se::ClientProperties & | clientProperties, | ||
const std::string & | initialStateAsJson = "", | ||
const ::tenduke::ServiceConfiguration & | serviceConfiguration = ::tenduke::ServiceConfiguration() ) |
Creates a client for using license-key -operations only.
This client does not maintain or do any logins and is really useful only for license-key operations (checkouts, heartbeats and releases or metered use with license key).
Calling any other endpoints of LicensingClient will cause errors.
clientIdentifier | identifies the client, used as User-Agent in HTTP-requests |
backendConfiguration | 10Duke Scale backend configuration |
clientProperties | Client properties |
initialStateAsJson | Initial client state as JSON. |
serviceConfiguration | Generic service configuration |