Virtru SDK for C++  2.8.0
Virtru C++ SDK library - Create, Read, and Manage TDF3 Files
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
virtru::CredentialsAppId Class Reference

#include <virtru_credentials_appid.h>

Inheritance diagram for virtru::CredentialsAppId:
virtru::Credentials

Public Member Functions

 CredentialsAppId (const std::string &owner, const std::string &appId)
 
virtual std::unique_ptr
< Credentials
clone () const
 
virtual ~CredentialsAppId ()
 
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_owner
 
std::string m_appId
 

Constructor & Destructor Documentation

virtru::CredentialsAppId::CredentialsAppId ( const std::string &  owner,
const std::string &  appId 
)

Constructor

Parameters
owner- The owner email of the credentials
appId- The AppId the credentials
virtual virtru::CredentialsAppId::~CredentialsAppId ( )
virtual

Destructor.

Member Function Documentation

virtual std::unique_ptr<Credentials> virtru::CredentialsAppId::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::CredentialsAppId::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::CredentialsAppId::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::CredentialsAppId::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::CredentialsAppId::m_appId
private
std::string virtru::CredentialsAppId::m_owner
private
CredentialsType virtru::Credentials::m_type
protectedinherited

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