bes Updated for version 3.21.1
The Backend Server (BES) is the lower two tiers of the Hyrax data server
http::AccessCredentials Class Reference
Collaboration diagram for http::AccessCredentials:
Collaboration graph

Public Member Functions

 AccessCredentials (const AccessCredentials &ac)=default
 
 AccessCredentials (std::string config_name)
 
virtual void add (const std::string &key, const std::string &value)
 Add the key and value pair.
 
virtual std::string get (const std::string &key)
 
virtual bool is_s3_cred ()
 Do the URL, ID, Key amd Region items make up an S3 Credential?
 
std::string name () const
 
void name (const std::string &name)
 
std::string to_json () const
 

Static Public Attributes

static const char * ID_KEY = "id"
 
static const char * KEY_KEY = "key"
 
static const char * REGION_KEY = "region"
 
static const char * URL_KEY = "url"
 

Detailed Description

Definition at line 13 of file AccessCredentials.h.

Constructor & Destructor Documentation

◆ AccessCredentials()

http::AccessCredentials::AccessCredentials ( std::string config_name)
inlineexplicit

Definition at line 31 of file AccessCredentials.h.

Member Function Documentation

◆ add()

void http::AccessCredentials::add ( const std::string & key,
const std::string & value )
virtual

Add the key and value pair.

Parameters
key
value

Definition at line 65 of file AccessCredentials.cc.

◆ get()

string http::AccessCredentials::get ( const std::string & key)
virtual

Retrieves the value of key

Parameters
keyThe key value to retrieve
Returns
The value of the key, empty string if the key does not exist.

Definition at line 50 of file AccessCredentials.cc.

◆ is_s3_cred()

bool http::AccessCredentials::is_s3_cred ( )
virtual

Do the URL, ID, Key amd Region items make up an S3 Credential?

Returns
True

Definition at line 73 of file AccessCredentials.cc.

◆ name() [1/2]

std::string http::AccessCredentials::name ( ) const
inline

Definition at line 45 of file AccessCredentials.h.

◆ name() [2/2]

void http::AccessCredentials::name ( const std::string & name)
inline

Definition at line 47 of file AccessCredentials.h.

◆ to_json()

string http::AccessCredentials::to_json ( ) const

Definition at line 81 of file AccessCredentials.cc.

Member Data Documentation

◆ ID_KEY

const char * http::AccessCredentials::ID_KEY = "id"
static

Definition at line 17 of file AccessCredentials.h.

◆ KEY_KEY

const char * http::AccessCredentials::KEY_KEY = "key"
static

Definition at line 18 of file AccessCredentials.h.

◆ REGION_KEY

const char * http::AccessCredentials::REGION_KEY = "region"
static

Definition at line 19 of file AccessCredentials.h.

◆ URL_KEY

const char * http::AccessCredentials::URL_KEY = "url"
static

Definition at line 20 of file AccessCredentials.h.


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