tenduke::ee::BrowserBasedClientFactory Class Reference

#include <BrowserBasedClientFactory.h>

Detailed Description

Factory, which creates 10Duke Enterprise client, which authenticates user by opening default OS browser.

Inheritance diagram for tenduke::ee::BrowserBasedClientFactory:

Public Member Functions
	BrowserBasedClientFactory (const std::string &clientId, const ::tenduke::ServiceConfiguration &serviceConfiguration=::tenduke::ServiceConfiguration())
	Constructs new instance with default services.
	BrowserBasedClientFactory (const ::tenduke::TendukeServices &services)
	Constructs new instance with given services.
Public Member Functions inherited from tenduke::ee::AbstractClientFactory<::tenduke::oidc::osbrowser::BrowserAuthenticationConfig >
	AbstractClientFactory (const std::string &clientId, const ::tenduke::ServiceConfiguration &serviceConfiguration=::tenduke::ServiceConfiguration())
	Constructs new instance with default services.
	AbstractClientFactory (const ::tenduke::TendukeServices &services)
	Constructs new instance with given services.
virtual std::unique_ptr<::tenduke::ee::TendukeClient >	createClient (const ::tenduke::ee::ClientProperties &clientProperties, const std::string &serviceUrl, const ::tenduke::oauth::OAuthBackendConfiguration &oauthBackendConfiguration, const ::tenduke::oidc::OIDCConfiguration &oidcConfiguration, const ::tenduke::oidc::osbrowser::BrowserAuthenticationConfig &authenticationConfiguration, const std::string &initialStateAsJSON={}) const
	Creates client for 10Duke Enterprise from manually provided parameters.
std::unique_ptr<::tenduke::ee::TendukeClient >	createClientUsingAutodiscovery (const ::tenduke::ee::ClientProperties &clientProperties, const std::string &serviceUrl, const ::tenduke::oidc::osbrowser::BrowserAuthenticationConfig &authenticationConfiguration, const std::string &initialStateAsJSON={}) const
	Creates client for 10Duke Enterprise, using OIDC autodiscovery for OAuth and OIDC parameters.

Protected Member Functions
std::shared_ptr<::tenduke::oidc::OIDCLogin >	createOIDCLoginService (const std::shared_ptr< const ::tenduke::oauth::OAuthConfiguration > &oauthConfiguration, const std::shared_ptr< const ::tenduke::oidc::OIDCConfiguration > &oidcConfiguration, const ::tenduke::oidc::osbrowser::BrowserAuthenticationConfig &authenticationConfig) const override
	Creates the authentication-specific OIDC login service.
std::shared_ptr<::tenduke::oauth::OAuthConfiguration >	mkOAuthConfiguration (const ::tenduke::oauth::OAuthBackendConfiguration &oauthBackendConfiguration, const ::tenduke::oidc::osbrowser::BrowserAuthenticationConfig &authenticationConfig) const override
	Creates full OAuth-configuration.
Protected Member Functions inherited from tenduke::ee::AbstractClientFactory<::tenduke::oidc::osbrowser::BrowserAuthenticationConfig >
virtual std::shared_ptr<::tenduke::ee::licensing::LicensingConfiguration >	mkLicensingConfiguration (const std::string &serviceUrl, const ::tenduke::ee::ClientProperties &clientProperties, const ::tenduke::oidc::OIDCConfiguration &oidcConfig) const
	Creates licensing configuration from provided parameters.
virtual void	dumpAutodiscoveryResult (const ::tenduke::oidc::AutoDiscovery &service, const ::tenduke::oidc::AutoDiscoveryResult &result) const
	Dumps OIDC autodiscovery result to log, using DEBUG log level.

Additional Inherited Members
Protected Attributes inherited from tenduke::ee::AbstractClientFactory<::tenduke::oidc::osbrowser::BrowserAuthenticationConfig >
::tenduke::TendukeServices	services

Constructor & Destructor Documentation

BrowserBasedClientFactory() [1/2]

tenduke::ee::BrowserBasedClientFactory::BrowserBasedClientFactory	(	const std::string &	clientId,
		const ::tenduke::ServiceConfiguration &	serviceConfiguration = ::tenduke::ServiceConfiguration()
	)

Constructs new instance with default services.

Parameters

clientId	Identifier of the client. Used mainly as HTTP user-agent. This value is very useful when analysing or troubleshooting activity from access logs. We recommend that value is relatively short and contains short application identifier, version and platform identifier. Use "HTTP-friendly"-characters, e.g. [0-9A-Z a-z .-_~/]. Example: the-app/1.0.0/win11
serviceConfiguration	Configuration for the underlying services. Optional.

BrowserBasedClientFactory() [2/2]

tenduke::ee::BrowserBasedClientFactory::BrowserBasedClientFactory ( const ::tenduke::TendukeServices &  services )

explicit

Constructs new instance with given services.

This allows constructing the factory with custom services.

Parameters

services

-

Member Function Documentation

createOIDCLoginService()

std::shared_ptr<::OIDCLogin > tenduke::ee::BrowserBasedClientFactory::createOIDCLoginService ( const std::shared_ptr< const ::tenduke::oauth::OAuthConfiguration > &  oauthConfig, const std::shared_ptr< const ::tenduke::oidc::OIDCConfiguration > &  oidcConfig, const ::tenduke::oidc::osbrowser::BrowserAuthenticationConfig &  authenticationConfig  ) const

overrideprotectedvirtual

Creates the authentication-specific OIDC login service.

Parameters

oauthConfig	-
oidcConfig	-
authenticationConfig	-

Returns

-

Implements tenduke::ee::AbstractClientFactory<::tenduke::oidc::osbrowser::BrowserAuthenticationConfig >.

mkOAuthConfiguration()

std::shared_ptr<::OAuthConfiguration > tenduke::ee::BrowserBasedClientFactory::mkOAuthConfiguration ( const ::tenduke::oauth::OAuthBackendConfiguration &  oauthBackendConfig, const ::tenduke::oidc::osbrowser::BrowserAuthenticationConfig &  authenticationConfig  ) const

overrideprotectedvirtual

Creates full OAuth-configuration.

Parameters

oauthBackendConfig	-
authenticationConfig	-

Returns

-

Implements tenduke::ee::AbstractClientFactory<::tenduke::oidc::osbrowser::BrowserAuthenticationConfig >.

---

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

• client/enterprise/bundle/src/BrowserBasedClientFactory.h
• client/enterprise/bundle/src/BrowserBasedClientFactory.cpp