ARC SDK
Public Member Functions | Data Fields | Protected Attributes
Arc::BaseConfig Class Reference

Configuration for client interface. More...

#include <arc/ArcConfig.h>

Public Member Functions

 BaseConfig ()
 Construct new BaseConfig. Plugin paths are determined automatically. More...
 
void AddPluginsPath (const std::string &path)
 Adds non-standard location of plugins. More...
 
void AddCredential (const std::string &cred)
 Add credential string. More...
 
void AddPrivateKey (const std::string &path)
 Add private key. More...
 
void AddCertificate (const std::string &path)
 Add certificate. More...
 
void AddProxy (const std::string &path)
 Add credentials proxy. More...
 
void AddCAFile (const std::string &path)
 Add CA file. More...
 
void AddCADir (const std::string &path)
 Add CA directory. More...
 
void AddOToken (const std::string &token)
 Add authentication token. More...
 
void AddOverlay (XMLNode cfg)
 Add configuration overlay. More...
 
void GetOverlay (std::string fname)
 Read overlay from file. More...
 
virtual XMLNode MakeConfig (XMLNode cfg) const
 Adds plugin configuration into common configuration tree supplied in 'cfg' argument. More...
 

Data Fields

std::string credential
 Credential stored as string. More...
 
std::string key
 Path to private key. More...
 
std::string cert
 Path to certificate. More...
 
std::string proxy
 Path to proxy certificate. More...
 
std::string cafile
 Path to CA certificate. More...
 
std::string cadir
 Path to directory of CA certificates. More...
 
std::string otoken
 Authentication token. More...
 
XMLNode overlay
 Configuration overlay. More...
 

Protected Attributes

std::list< std::string > plugin_paths
 List of file system paths to ARC plugin files. More...
 

Detailed Description

Configuration for client interface.

It contains information which can't be expressed in class constructor arguments. Most probably common things like software installation location, identity of user, etc.

Constructor & Destructor Documentation

◆ BaseConfig()

Arc::BaseConfig::BaseConfig ( )

Construct new BaseConfig. Plugin paths are determined automatically.

Member Function Documentation

◆ AddCADir()

void Arc::BaseConfig::AddCADir ( const std::string &  path)

Add CA directory.

◆ AddCAFile()

void Arc::BaseConfig::AddCAFile ( const std::string &  path)

Add CA file.

◆ AddCertificate()

void Arc::BaseConfig::AddCertificate ( const std::string &  path)

Add certificate.

◆ AddCredential()

void Arc::BaseConfig::AddCredential ( const std::string &  cred)

Add credential string.

Since
Added in 4.0.0.

◆ AddOToken()

void Arc::BaseConfig::AddOToken ( const std::string &  token)

Add authentication token.

◆ AddOverlay()

void Arc::BaseConfig::AddOverlay ( XMLNode  cfg)

Add configuration overlay.

◆ AddPluginsPath()

void Arc::BaseConfig::AddPluginsPath ( const std::string &  path)

Adds non-standard location of plugins.

◆ AddPrivateKey()

void Arc::BaseConfig::AddPrivateKey ( const std::string &  path)

Add private key.

◆ AddProxy()

void Arc::BaseConfig::AddProxy ( const std::string &  path)

Add credentials proxy.

◆ GetOverlay()

void Arc::BaseConfig::GetOverlay ( std::string  fname)

Read overlay from file.

◆ MakeConfig()

virtual XMLNode Arc::BaseConfig::MakeConfig ( XMLNode  cfg) const
virtual

Adds plugin configuration into common configuration tree supplied in 'cfg' argument.

Returns
reference to XML node representing configuration of ModuleManager

Field Documentation

◆ cadir

std::string Arc::BaseConfig::cadir

Path to directory of CA certificates.

◆ cafile

std::string Arc::BaseConfig::cafile

Path to CA certificate.

◆ cert

std::string Arc::BaseConfig::cert

Path to certificate.

◆ credential

std::string Arc::BaseConfig::credential

Credential stored as string.

Since
Added in 4.0.0.

◆ key

std::string Arc::BaseConfig::key

Path to private key.

◆ otoken

std::string Arc::BaseConfig::otoken

Authentication token.

◆ overlay

XMLNode Arc::BaseConfig::overlay

Configuration overlay.

◆ plugin_paths

std::list<std::string> Arc::BaseConfig::plugin_paths
protected

List of file system paths to ARC plugin files.

◆ proxy

std::string Arc::BaseConfig::proxy

Path to proxy certificate.


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