virtru::ClientConfig Class Reference

#include <virtru_client_config.h>

Public Member Functions
void	setKasUrl (const std::string &kasUrl)
std::string	getKasUrl () const
void	setOIDCUrl (const std::string &oidcUrl)
std::string	getOIDCUrl () const
void	setEasUrl (const std::string &easUrl)
std::string	getEasUrl () const
void	setAcmUrl (const std::string &acmUrl)
std::string	getAcmUrl () const
void	setRcaUrl (const std::string &rcaUrl)
std::string	getRcaUrl () const
void	setEncryptedStorageUrl (const std::string &encryptedStorageUrl)
std::string	getEncryptedStorageUrl () const
void	setSecureReaderUrl (const std::string &srUrl)
std::string	getSecureReaderUrl () const
void	setPlatform (const std::string &platform)
std::string	getPlatform () const
std::string	getVirtruClient () const
std::string	getBuildVersion () const

Static Public Member Functions
static ClientConfig &	getInstance ()

Protected Member Functions
	ClientConfig ()
	~ClientConfig ()=default

Private Attributes
std::string	m_kasUrl
std::string	m_oidcUrl
std::string	m_easUrl
std::string	m_acmUrl
std::string	m_rcaUrl
std::string	m_encryptedStorageUrl
std::string	m_secureReaderUrl
std::string	m_platform

Detailed Description

A virtru client configuration information class(singleton) hold all the endpoint addresses and other information like platform it's being used.

Constructor & Destructor Documentation

virtru::ClientConfig::ClientConfig ( )

protected

Constructs a new ClientConfig instance.

virtru::ClientConfig::~ClientConfig ( )

protecteddefault

Destructor.

Member Function Documentation

std::string virtru::ClientConfig::getAcmUrl

(

)

const

Return the base URL for ACM server communication

Returns

- The current ACM url value

std::string virtru::ClientConfig::getBuildVersion

(

)

const

Return virtru client build version

Returns

The virtru client build version

std::string virtru::ClientConfig::getEasUrl

(

)

const

DEPRECATED - EAS is not used in OIDC flows Return the base URL for EAS server communication

Returns

- The current EAS url value

std::string virtru::ClientConfig::getEncryptedStorageUrl

(

)

const

Return the base URL for encrypted storage server communication

Returns

- The current encrypted storage url value

static ClientConfig& virtru::ClientConfig::getInstance ( )

static

Returns the singleton instance of ClientConfig, if the instance is not yet created it will create one.

Returns

- Returns single instance of the ClientConfig.

std::string virtru::ClientConfig::getKasUrl

(

)

const

Return the base URL for KAS communication

Returns

- The current base KAS url value

std::string virtru::ClientConfig::getOIDCUrl

(

)

const

Return the base URL that client will authenticate against

Returns

oidcUrl - The base URL for the OIDC IdP

std::string virtru::ClientConfig::getPlatform

(

)

const

Return the current platform of this SDK.

Returns

platform - The current platform of the SDK

std::string virtru::ClientConfig::getRcaUrl

(

)

const

Return the base URL for RCA server communication

Returns

- The current RCA url value

std::string virtru::ClientConfig::getSecureReaderUrl

(

)

const

Return the secure reader url which will be used in html format TDF

Returns

- The secure reader url value

std::string virtru::ClientConfig::getVirtruClient

(

)

const

Return virtru client value which is passed as HTTP header value while communicating with Virtru servers

Returns

The virtru client value

void virtru::ClientConfig::setAcmUrl

(

const std::string &

acmUrl

)

Sets the base URL for ACM server communication

Parameters

acmUrl

- The base URL for ACM

void virtru::ClientConfig::setEasUrl

(

const std::string &

easUrl

)

DEPRECATED - EAS is not used in OIDC flows Sets the base URL for EAS server communication

Parameters

easUrl

- The base URL for EAS

void virtru::ClientConfig::setEncryptedStorageUrl

(

const std::string &

encryptedStorageUrl

)

Sets the base URL for encrypted storage server communication

Parameters

encryptedStorageUrl

- The base URL for encrypted storage

void virtru::ClientConfig::setKasUrl

(

const std::string &

kasUrl

)

Sets the base URL for KAS communication

Parameters

kasUrl

- The base URL for KAS

void virtru::ClientConfig::setOIDCUrl

(

const std::string &

oidcUrl

)

Sets the base URL that client will authenticate against

Parameters

oidcUrl

- The base URL for the OIDC IdP

void virtru::ClientConfig::setPlatform

(

const std::string &

platform

)

Set the current platform the SDK is being used (ex: cpp, python,...)

Parameters

platform

- The current platform of the SDK

void virtru::ClientConfig::setRcaUrl

(

const std::string &

rcaUrl

)

Sets the base URL for RCA server communication

Parameters

rcaUrl

- The base URL for RCA

void virtru::ClientConfig::setSecureReaderUrl

(

const std::string &

srUrl

)

Set the secure reader url which will be used in html format TDF. This is the URL that will be used on opening the .html TDF.

Parameters

srUrl

- The secure reader url

Member Data Documentation

std::string virtru::ClientConfig::m_acmUrl

private

std::string virtru::ClientConfig::m_easUrl

private

std::string virtru::ClientConfig::m_encryptedStorageUrl

private

std::string virtru::ClientConfig::m_kasUrl

private

std::string virtru::ClientConfig::m_oidcUrl

private

std::string virtru::ClientConfig::m_platform

private

std::string virtru::ClientConfig::m_rcaUrl

private

std::string virtru::ClientConfig::m_secureReaderUrl

private

---

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

• virtru_client_config.h