virtru::CredentialsHmac Class Reference

#include <virtru_credentials_hmac.h>

Inheritance diagram for virtru::CredentialsHmac:

Public Member Functions
	CredentialsHmac (const std::string &userId, const std::string &apiKey, const std::string &apiSecret)
virtual std::unique_ptr < Credentials >	clone () const
virtual	~CredentialsHmac ()
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
virtual std::string	str () const
CredentialsType	getType () const
std::string	getTypeStr () const

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

Protected Attributes
CredentialsType	m_type

Private Attributes
std::string	m_userId
std::string	m_apiKey
std::string	m_apiSecret

Constructor & Destructor Documentation

virtru::CredentialsHmac::CredentialsHmac	(	const std::string &	userId,
		const std::string &	apiKey,
		const std::string &	apiSecret
	)

Constructor

Parameters

userId	- The userId of the credentials
apiKey	- The apiKey of the credentials
apiSecret	- The API secret of the credentials

virtual virtru::CredentialsHmac::~CredentialsHmac ( )

virtual

Destructor.

Member Function Documentation

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

virtual

Create a new instance of this object

Returns

- The new instance

Reimplemented from virtru::Credentials.

virtual std::map<std::string, std::string> virtru::CredentialsHmac::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 from virtru::Credentials.

CredentialsType virtru::Credentials::getType ( ) const

inherited

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

inherited

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::CredentialsHmac::getUserId ( ) const

virtual

Get the userId associated with these credentials.

Reimplemented from virtru::Credentials.

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

protectedinherited

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

virtual

Get a debug-friendly string describing this credentials object

Returns

- The type of this credentials instance as a string

Reimplemented from virtru::Credentials.

Member Data Documentation

std::string virtru::CredentialsHmac::m_apiKey

private

std::string virtru::CredentialsHmac::m_apiSecret

private

CredentialsType virtru::Credentials::m_type

protectedinherited

std::string virtru::CredentialsHmac::m_userId

private

---

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

• virtru_credentials_hmac.h