virtru::Credentials Class Reference

#include <virtru_credentials.h>

Inheritance diagram for virtru::Credentials:

Public Member Functions
	Credentials (CredentialsType type=CredentialsType::None)
virtual std::unique_ptr < Credentials >	clone () const
virtual	~Credentials ()
CredentialsType	getType () const
std::string	getTypeStr () const
virtual std::string	str () const
virtual std::map< std::string, std::string >	generateAuthHeaders (const std::string &url, const std::string &method, const std::string &body, const std::map< std::string, std::string > &headers, const std::string &date)
virtual std::string	getUserId () const

Protected Member Functions
std::map< std::string, std::string >	parseUrlTODO (const std::string &url) const

Protected Attributes
CredentialsType	m_type

Constructor & Destructor Documentation

virtru::Credentials::Credentials

(

CredentialsType

type = CredentialsType::None

)

Constructor

Parameters

type	- The type of this credentials object, as specified by a CredentialsType enum value

virtual virtru::Credentials::~Credentials ( )

virtual

Destructor.

Member Function Documentation

virtual std::unique_ptr<Credentials> virtru::Credentials::clone ( ) const

virtual

Create a new instance of this object

Returns

- The new instance

Reimplemented in virtru::CredentialsOidc, virtru::CredentialsAppId, and virtru::CredentialsHmac.

virtual std::map<std::string, std::string> virtru::Credentials::generateAuthHeaders ( const std::string &  url, const std::string &  method, const std::string &  body, const std::map< std::string, std::string > &  headers, const std::string &  date  )

virtual

Create the header key/value pairs that should be added to the request to establish authorization

Parameters

url	- The full url for the request, including protocol prefix and parameter information
method	- The method for the request, such as 'get' or 'post'
body	- The body for the request, can be an empty string if there is no body content
headers	- a set of http header key/value pairs that should be included in calculations
date	- the date string that should be used in calculations

Returns

- map of key/value http header pairs

Reimplemented in virtru::CredentialsOidc, virtru::CredentialsAppId, and virtru::CredentialsHmac.

CredentialsType virtru::Credentials::getType

(

)

const

Get the type of this credentials object, as specified by the CredentialsType enum value

Returns

- The type enum value of this credentials instance

std::string virtru::Credentials::getTypeStr

(

)

const

Get the type of this credentials object, as a string representation of the CredentialsType

Returns

- The type of this credentials instance as a string

virtual std::string virtru::Credentials::getUserId ( ) const

virtual

Get the userId associated with these credentials.

Reimplemented in virtru::CredentialsOidc, virtru::CredentialsAppId, and virtru::CredentialsHmac.

std::map<std::string, std::string> virtru::Credentials::parseUrlTODO ( const std::string &  url ) const

protected

virtual std::string virtru::Credentials::str ( ) const

virtual

Get a debug-friendly string describing this credentials object

Returns

- The type of this credentials instance as a string

Reimplemented in virtru::CredentialsOidc, virtru::CredentialsAppId, and virtru::CredentialsHmac.

Member Data Documentation

CredentialsType virtru::Credentials::m_type

protected

---

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

• virtru_credentials.h