davixConfigObject Class Reference

class for configuring one davix instance holds all options necessary for that More...

#include <davixCommon.h>

Collaboration diagram for davixConfigObject:

Public Member Functions
	davixConfigObject (const std::string &parPrefix)
void	apply (Davix::RequestParams &params)
bool	accessConfigured () const

Public Attributes
options::single< bool >	noAuth

Private Attributes
davixCfgEnum< const Davix::RequestProtocol::Protocol >	Protocol
davixCfgX509	X509Cert
davixCfgStrings< const std::string & >	CertificateAuthorityPath
davixCfgPar< bool >	SSLCAcheck
davixCfgPar< int >	OperationRetry
davixCfgPar< struct timespec * >	OperationTimeout
davixCfgPar< struct timespec * >	ConnectionTimeout
bool	accessConfigDone

Detailed Description

class for configuring one davix instance holds all options necessary for that

Definition at line 169 of file davixCommon.h.

Constructor & Destructor Documentation

davixConfigObject()

davixConfigObject::davixConfigObject

(

const std::string &

parPrefix

)

Definition at line 57 of file davixCommon.cpp.

                                                              :
    Protocol(parPrefix, "Protocol",
             "set the request protocol (ex : Webdav, Http, S3) ",
             &Davix::RequestParams::setProtocol, {
    {"Auto", Davix::RequestProtocol::Protocol::Auto},
    {"Http", Davix::RequestProtocol::Protocol::Http},
    {"Webdav", Davix::RequestProtocol::Protocol::Webdav},
    {"AwsS3", Davix::RequestProtocol::Protocol::AwsS3},
    #ifdef DAVIX_API_VERSION
    #if DAVIX_API_VERSION >= 20160621
    {"Azure", Davix::RequestProtocol::Protocol::Azure},
    {"Gcloud", Davix::RequestProtocol::Protocol::Gcloud},
    #endif
    #endif
}
        ),
        X509Cert(parPrefix),
        CertificateAuthorityPath(parPrefix, "CertificateAuthorityPath",
                                 "add to path list for CA directories",
                                 &Davix::RequestParams::addCertificateAuthorityPath),
        SSLCAcheck(parPrefix, "NoSSLCAcheck",
                   "disable the certificate authority validity check for the https request",
                   &Davix::RequestParams::setSSLCAcheck,
                   true),
        OperationRetry(parPrefix, "OperationRetry",
                       "set number of retries",
                       &Davix::RequestParams::setOperationRetry),
        OperationTimeout(parPrefix, "OperationTimeout",
                         "set the operation timeout",
                         &Davix::RequestParams::setOperationTimeout),
        ConnectionTimeout(parPrefix, "ConnectionTimeout",
                          "set the connection timeout",
                          &Davix::RequestParams::setConnectionTimeout),
    noAuth('\0',parPrefix + "NoAuth",parPrefix + " don't use authentification",false),
    accessConfigDone(false) {
}

Member Function Documentation

accessConfigured()

bool davixConfigObject::accessConfigured

(

)

const

Definition at line 103 of file davixCommon.cpp.

                                               {
    return accessConfigDone;
}

References accessConfigDone.

Referenced by davixCommon::davixCommon().

Here is the caller graph for this function:

apply()

void davixConfigObject::apply

(

Davix::RequestParams &

params

)

Definition at line 94 of file davixCommon.cpp.

                                                        {
    Protocol.applySingle(params);
    X509Cert.applySingle(params, accessConfigDone);
    CertificateAuthorityPath.applySingle(params);
    SSLCAcheck.applySingle(params);
    OperationRetry.applySingle(params);
    OperationTimeout.applySingle(params);
    ConnectionTimeout.applySingle(params);
}

References accessConfigDone, davixCfgPar< T >::applySingle(), davixCfgPar< struct timespec * >::applySingle(), davixCfgEnum< T >::applySingle(), davixCfgStrings< T >::applySingle(), davixCfgX509::applySingle(), CertificateAuthorityPath, ConnectionTimeout, OperationRetry, OperationTimeout, Protocol, SSLCAcheck, and X509Cert.

Referenced by davixCommon::davixCommon().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

accessConfigDone

bool davixConfigObject::accessConfigDone

private

Definition at line 182 of file davixCommon.h.

Referenced by accessConfigured(), and apply().

CertificateAuthorityPath

davixCfgStrings<const std::string&> davixConfigObject::CertificateAuthorityPath

private

Definition at line 174 of file davixCommon.h.

Referenced by apply().

ConnectionTimeout

davixCfgPar<struct timespec*> davixConfigObject::ConnectionTimeout

private

Definition at line 178 of file davixCommon.h.

Referenced by apply().

noAuth

options::single<bool> davixConfigObject::noAuth

Definition at line 180 of file davixCommon.h.

Referenced by davixCommon::davixCommon().

OperationRetry

davixCfgPar<int> davixConfigObject::OperationRetry

private

Definition at line 176 of file davixCommon.h.

Referenced by apply().

OperationTimeout

davixCfgPar<struct timespec*> davixConfigObject::OperationTimeout

private

Definition at line 177 of file davixCommon.h.

Referenced by apply().

Protocol

davixCfgEnum<const Davix::RequestProtocol::Protocol> davixConfigObject::Protocol

private

Definition at line 172 of file davixCommon.h.

Referenced by apply().

SSLCAcheck

davixCfgPar<bool> davixConfigObject::SSLCAcheck

private

Definition at line 175 of file davixCommon.h.

Referenced by apply().

X509Cert

davixCfgX509 davixConfigObject::X509Cert

private

Definition at line 173 of file davixCommon.h.

Referenced by apply().

---

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

• src/davixCommon.h (v0.19-24-g0617ca1 with changes)
• src/davixCommon.cpp (v0.19-24-g0617ca1 with changes)