transfersettings.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#ifndef ZYPP_CURL_TRANSFER_SETTINGS_H_INCLUDED
#define ZYPP_CURL_TRANSFER_SETTINGS_H_INCLUDED
 
#include <string>
#include <vector>
#include <zypp-core/base/Flags.h>
#include <zypp-core/base/PtrTypes.h>
#include <zypp-core/Pathname.h>
#include <zypp-core/Url.h>
namespace zypp
{
  namespace media
  {

    //  strings are discarded.
    class TransferSettings
    {
    public:
      static std::ostream & logUserPass( std::ostream & str, const std::string & user_r, const std::string & pass_r );
 
    public:
      TransferSettings();
 
      using Headers = std::vector<std::string>;

      void reset();

      void addHeader( std::string && val_r );
      void addHeader( const std::string & val_r );

      const Headers &headers() const;

      void setUserAgentString( std::string && val_r );
      void setUserAgentString( const std::string &val_r );

      const std::string &userAgentString() const;
 

      bool hasCredentials() const;

      std::ostream & logCredentials( std::ostream & str ) const
      { return logUserPass( str, username(), password() ); }

      void setUsername( const std::string &val_r );
      void setUsername( std::string && val_r );

      const std::string &username() const;

      void setPassword( const std::string & val_r );
      void setPassword( std::string && val_r );

      const std::string &password() const;

      void setAnonymousAuth();
 

      void setProxyEnabled( bool enabled );

      bool proxyEnabled() const;
 

      void setProxy( const std::string &val_r );
      void setProxy( std::string && val_r );

      const std::string &proxy() const;
 

      bool hasProxyCredentials() const;

      std::ostream & logProxyCredentials( std::ostream & str ) const
      { return logUserPass( str, proxyUsername(), proxyPassword() ); }

      void setProxyUsername( const std::string &val_r );
      void setProxyUsername( std::string && val_r );

      const std::string &proxyUsername() const;

      void setProxyPassword( const std::string &val_r );
      void setProxyPassword( std::string && val_r );

      const std::string &proxyPassword() const;

      std::string proxyUserPassword() const;
 

      void setConnectTimeout( long t );

      long connectTimeout() const;
 

      void setTimeout( long t );

      long timeout() const;
 

      void setMaxConcurrentConnections(long v);

      long maxConcurrentConnections() const;
 

      void setMinDownloadSpeed(long v);

      long minDownloadSpeed() const;
 

      void setMaxDownloadSpeed(long v);

      long maxDownloadSpeed() const;
 

      void setMaxSilentTries(long v);

      long maxSilentTries() const;
 

      void setVerifyHostEnabled( bool enabled );

      bool verifyHostEnabled() const;
 

      void setVerifyPeerEnabled( bool enabled );

      bool verifyPeerEnabled() const;
 

      void setCertificateAuthoritiesPath( const Pathname &val_r );
      void setCertificateAuthoritiesPath( Pathname && val_r );

      const Pathname &certificateAuthoritiesPath() const;
 

      void setAuthType( const std::string &val_r );
      void setAuthType( std::string && val_r );

      const std::string &authType() const;
 

      void setHeadRequestsAllowed(bool allowed);

      bool headRequestsAllowed() const;
 

      void setClientCertificatePath( const Pathname &val_r );
      void setClientCertificatePath( Pathname && val_r );

      const Pathname &clientCertificatePath() const;
 

      void setClientKeyPath( const Pathname &val_r );
      void setClientKeyPath( Pathname && val_r );

      const Pathname &clientKeyPath() const;

      void setEnableCookieFile( bool enable = true );
      bool cookieFileEnabled() const;
 
    protected:
      class Impl;
      RWCOW_pointer<Impl> _impl;
    };

    std::ostream & dumpOn( std::ostream & str, const TransferSettings & obj );
 
  } // namespace media
} // namespece zypp
 
#endif // ZYPP_CURL_TRANSFER_SETTINGS_H_INCLUDED