davix  0.2.8
Public Member Functions
Davix::RequestParams Class Reference

Main container for Davix request options. More...

#include <davixrequestparams.hpp>

Public Member Functions

 RequestParams ()
 default constructor
 
 RequestParams (const RequestParams &params)
 copy constructor More...
 
 RequestParams (const RequestParams *params)
 conveniencecopy constructor with NULL check More...
 
RequestParamsoperator= (const RequestParams &_p)
 assignment operator
 
void setSSLCAcheck (bool chk)
 disable the certificate authority validity check for the https request
 
bool getSSLCACheck () const
 return the SSL Certificate authority validity check
 
void setClientCertX509 (const X509Credential &cli_cert)
 
const X509CredentialgetClientCertX509 () const
 get the current client side credential
 
void setClientLoginPassword (const std::string &login, const std::string &password)
 set login/password for HTTP Authentication
 
const std::pair< std::string,
std::string > & 
getClientLoginPassword () const
 get login/password for HTTP Authentication
 
void setClientCertCallbackX509 (authCallbackClientCertX509 callback, void *userdata)
 
std::pair
< authCallbackClientCertX509,
void * > 
getClientCertCallbackX509 () const
 return the current client side callback for authentication with the associated user data
 
void setClientLoginPasswordCallback (authCallbackLoginPasswordBasic callback, void *userdata)
 
std::pair
< authCallbackLoginPasswordBasic,
void * > 
getClientLoginPasswordCallback () const
 return the current login/password callback and the associated user data
 
void setAwsAuthorizationKeys (const AwsSecretKey &secret_key, const AwsAccessKey &access_key)
 define a Amazon S3 private key and public key More...
 
const std::pair< AwsSecretKey,
AwsAccessKey > & 
getAwsAutorizationKeys () const
 get Amazon S3 authentication tokens More...
 
void addCertificateAuthorityPath (const std::string &path)
 add the CA certificate in the directory 'path' as trusted certificate
 
const std::vector< std::string > & listCertificateAuthorityPath () const
 get the list of the current user defined CA path
 
void setConnectionTimeout (struct timespec *conn_timeout)
 
struct timespec * getConnectionTimeout () const
 get the current connexion timeout
 
void setOperationTimeout (struct timespec *ops_timeout)
 
struct timespec * getOperationTimeout () const
 
void setTransparentRedirectionSupport (bool redirection)
 
bool getTransparentRedirectionSupport () const
 return true if the transparent redirection mode is enabled
 
void setUserAgent (const std::string &user_agent)
 set the user agent for the associated request
 
const std::string & getUserAgent () const
 get the current user agent string
 
void setProtocol (const RequestProtocol::Protocol proto)
 set the request protocol ( ex : Webdav, Http-only, S3 )
 
RequestProtocol::Protocol getProtocol () const
 get the current value of the request protocol
 
void setKeepAlive (const bool keep_alive_flag)
 set the keep alive value of the associated session
 
bool getKeepAlive () const
 get the keep alive value of this request params
 
void * getParmState () const
 internal usage
 

Detailed Description

Main container for Davix request options.

RequestParams hold the davix request options : authentification parameters, timeouts, user-agents,... A Requestparams object can be shared between several Request

Constructor & Destructor Documentation

Davix::RequestParams::RequestParams ( const RequestParams params)

copy constructor

Parameters
params
Davix::RequestParams::RequestParams ( const RequestParams params)

conveniencecopy constructor with NULL check

Parameters
params

Member Function Documentation

const std::pair<AwsSecretKey, AwsAccessKey>& Davix::RequestParams::getAwsAutorizationKeys ( ) const

get Amazon S3 authentication tokens

Returns
pair of secret key and public key
struct timespec* Davix::RequestParams::getOperationTimeout ( ) const

get the maximum execution time for a davix request DEFAULT : infinite

void Davix::RequestParams::setAwsAuthorizationKeys ( const AwsSecretKey &  secret_key,
const AwsAccessKey &  access_key 
)

define a Amazon S3 private key and public key

Parameters
secret_keysecret key
access_keypublic key
void Davix::RequestParams::setClientCertCallbackX509 ( authCallbackClientCertX509  callback,
void *  userdata 
)

set a callback for X509 client side dynamic authentication this function overwrite setClientCertX509

void Davix::RequestParams::setClientCertX509 ( const X509Credential cli_cert)

set a X509 credential for a simple client authentication this function overwrite setClientCertCallbackX509

void Davix::RequestParams::setClientLoginPasswordCallback ( authCallbackLoginPasswordBasic  callback,
void *  userdata 
)

set a callback for basic login/password http authentication this function overwrite setClientLoginPassword

void Davix::RequestParams::setConnectionTimeout ( struct timespec *  conn_timeout)

define the connexion timeout conn_timeout is a relative time DEFAULT : 180s

void Davix::RequestParams::setOperationTimeout ( struct timespec *  ops_timeout)

define the maximum execution time for a davix request ops_timeout is a relative time DEFAULT : infinite

void Davix::RequestParams::setTransparentRedirectionSupport ( bool  redirection)

enable or disable transparent redirection support In the transparent redirection mode, davix follows the HTTP redirection automatically DEFAULT : enabled


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