libzypp  17.7.0
TransferSettings.h
Go to the documentation of this file.
1 
2 #ifndef TRANSFER_SETTINGS_H_
3 #define TRANSFER_SETTINGS_H_
4 
5 #include <string>
6 #include <vector>
7 #include "zypp/base/Flags.h"
8 #include "zypp/base/PtrTypes.h"
9 #include "zypp/Pathname.h"
10 #include "zypp/Url.h"
11 
12 namespace zypp
13 {
14 namespace media
15 {
16 
21 {
22 public:
27 
33  TransferSettings( const zypp::Url &url );
34 
35  typedef std::vector<std::string> Headers;
36 
40  void reset();
41 
45  void addHeader( const std::string &header );
46 
50  Headers::const_iterator headersBegin() const;
51 
55  Headers::const_iterator headersEnd() const;
56 
60  void setUserAgentString( const std::string &agent );
61 
65  std::string userAgentString() const;
66 
70  void setUsername( const std::string &username );
71 
75  std::string username() const;
76 
80  void setPassword( const std::string &password );
81 
85  std::string password() const;
86 
91  std::string userPassword() const;
92 
96  void setAnonymousAuth();
97 
101  void setProxyEnabled( bool enabled );
102 
106  bool proxyEnabled() const;
107 
111  void setProxy( const std::string &proxyhost );
112 
116  std::string proxy() const;
117 
121  void setProxyUsername( const std::string &proxyuser );
122 
126  std::string proxyUsername() const;
127 
131  void setProxyPassword( const std::string &proxypass );
132 
136  std::string proxyPassword() const;
137 
142  std::string proxyUserPassword() const;
143 
147  void setConnectTimeout( long t );
148 
152  long connectTimeout() const;
153 
157  void setTimeout( long t );
158 
162  long timeout() const;
163 
167  long maxConcurrentConnections() const;
168 
172  void setMaxConcurrentConnections(long v);
173 
178  long minDownloadSpeed() const;
179 
184  void setMinDownloadSpeed(long v);
185 
189  long maxDownloadSpeed() const;
190 
194  void setMaxDownloadSpeed(long v);
195 
199  long maxSilentTries() const;
200 
204  void setMaxSilentTries(long v);
205 
209  bool verifyHostEnabled() const;
210 
214  void setVerifyHostEnabled( bool enabled );
215 
219  bool verifyPeerEnabled() const;
220 
224  void setVerifyPeerEnabled( bool enabled );
225 
231 
235  void setCertificateAuthoritiesPath( const zypp::Pathname &path );
236 
240  void setAuthType( const std::string &authtype );
241 
245  std::string authType() const;
246 
250  void setHeadRequestsAllowed(bool allowed);
251 
255  bool headRequestsAllowed() const;
256 
261 
265  void setClientCertificatePath( const zypp::Pathname &path );
266 
270  Pathname clientKeyPath() const;
271 
275  void setClientKeyPath( const zypp::Pathname &path );
276 
277 protected:
278  class Impl;
280 };
281 
282 } // ns media
283 } // ns zypp
284 
285 #endif
zypp::media::TransferSettings::setClientKeyPath
void setClientKeyPath(const zypp::Pathname &path)
Sets the SSL client key file.
Definition: TransferSettings.cc:297
zypp::media::TransferSettings::verifyHostEnabled
bool verifyHostEnabled() const
Whether to verify host for ssl.
Definition: TransferSettings.cc:267
zypp::media::TransferSettings::setUsername
void setUsername(const std::string &username)
sets the auth username
Definition: TransferSettings.cc:122
zypp::media::TransferSettings::verifyPeerEnabled
bool verifyPeerEnabled() const
Whether to verify peer for ssl.
Definition: TransferSettings.cc:277
zypp::media::TransferSettings::addHeader
void addHeader(const std::string &header)
add a header, on the form "Foo: Bar"
Definition: TransferSettings.cc:96
zypp::media::TransferSettings::setConnectTimeout
void setConnectTimeout(long t)
set the connect timeout
Definition: TransferSettings.cc:217
zypp::media::TransferSettings::userPassword
std::string userPassword() const
returns the user and password as a user:pass string
Definition: TransferSettings.cc:149
zypp::media::TransferSettings::setAuthType
void setAuthType(const std::string &authtype)
set the allowed authentication types
Definition: TransferSettings.cc:318
zypp::media::TransferSettings::reset
void reset()
reset the settings to the defaults
Definition: TransferSettings.cc:91
zypp::media::TransferSettings::setClientCertificatePath
void setClientCertificatePath(const zypp::Pathname &path)
Sets the SSL client certificate file.
Definition: TransferSettings.cc:287
zypp::media::TransferSettings::proxyPassword
std::string proxyPassword() const
proxy auth password
Definition: TransferSettings.cc:193
zypp::media::TransferSettings::setTimeout
void setTimeout(long t)
set the transfer timeout
Definition: TransferSettings.cc:207
zypp::media::TransferSettings::setMaxSilentTries
void setMaxSilentTries(long v)
Set maximum silent retries.
Definition: TransferSettings.cc:262
zypp::media::TransferSettings::username
std::string username() const
auth username
Definition: TransferSettings.cc:127
zypp::media::TransferSettings::headersBegin
Headers::const_iterator headersBegin() const
begin iterators to additional headers
Definition: TransferSettings.cc:102
zypp::media::TransferSettings::minDownloadSpeed
long minDownloadSpeed() const
Minimum download speed (bytes per second) until the connection is dropped.
Definition: TransferSettings.cc:237
zypp::media::TransferSettings::certificateAuthoritiesPath
Pathname certificateAuthoritiesPath() const
SSL certificate authorities path ( default: /etc/ssl/certs )
Definition: TransferSettings.cc:308
zypp::media::TransferSettings::timeout
long timeout() const
transfer timeout
Definition: TransferSettings.cc:212
zypp::media::TransferSettings::setProxyPassword
void setProxyPassword(const std::string &proxypass)
sets the proxy password
Definition: TransferSettings.cc:188
zypp::media::TransferSettings::authType
std::string authType() const
get the allowed authentication types
Definition: TransferSettings.cc:323
zypp::media::TransferSettings::setMaxConcurrentConnections
void setMaxConcurrentConnections(long v)
Set maximum number of concurrent connections for a single transfer.
Definition: TransferSettings.cc:232
zypp::media::TransferSettings::maxConcurrentConnections
long maxConcurrentConnections() const
Maximum number of concurrent connections for a single transfer.
Definition: TransferSettings.cc:227
PtrTypes.h
Pathname.h
zypp::media::TransferSettings::proxyUserPassword
std::string proxyUserPassword() const
returns the proxy user and password as a user:pass string
Definition: TransferSettings.cc:198
zypp::media::TransferSettings::headRequestsAllowed
bool headRequestsAllowed() const
whether HEAD requests are allowed
Definition: TransferSettings.cc:333
zypp::media::TransferSettings::setVerifyHostEnabled
void setVerifyHostEnabled(bool enabled)
Sets whether to verify host for ssl.
Definition: TransferSettings.cc:272
zypp::media::TransferSettings::proxyEnabled
bool proxyEnabled() const
proxy is enabled
Definition: TransferSettings.cc:163
zypp::media::TransferSettings::setUserAgentString
void setUserAgentString(const std::string &agent)
sets the user agent ie: "Mozilla v3"
Definition: TransferSettings.cc:112
zypp::media::TransferSettings
Holds transfer setting.
Definition: TransferSettings.h:20
zypp::media::TransferSettings::setProxyEnabled
void setProxyEnabled(bool enabled)
whether the proxy is used or not
Definition: TransferSettings.cc:158
zypp::media::TransferSettings::setHeadRequestsAllowed
void setHeadRequestsAllowed(bool allowed)
set whether HEAD requests are allowed
Definition: TransferSettings.cc:328
Url.h
zypp::media::TransferSettings::maxSilentTries
long maxSilentTries() const
Maximum silent retries.
Definition: TransferSettings.cc:257
zypp::media::TransferSettings::proxyUsername
std::string proxyUsername() const
proxy auth username
Definition: TransferSettings.cc:183
zypp::media::TransferSettings::setProxy
void setProxy(const std::string &proxyhost)
proxy to use if it is enabled
Definition: TransferSettings.cc:168
zypp::media::TransferSettings::Impl
Definition: TransferSettings.cc:22
zypp
Easy-to use interface to the ZYPP dependency resolver.
Definition: CodePitfalls.doc:1
zypp::media::TransferSettings::userAgentString
std::string userAgentString() const
user agent string
Definition: TransferSettings.cc:117
zypp::media::TransferSettings::clientKeyPath
Pathname clientKeyPath() const
SSL client key file.
Definition: TransferSettings.cc:292
zypp::media::TransferSettings::clientCertificatePath
Pathname clientCertificatePath() const
SSL client certificate file.
Definition: TransferSettings.cc:282
zypp::media::TransferSettings::setVerifyPeerEnabled
void setVerifyPeerEnabled(bool enabled)
Sets whether to verify host for ssl.
Definition: TransferSettings.cc:303
zypp::media::TransferSettings::setMaxDownloadSpeed
void setMaxDownloadSpeed(long v)
Set max download speed (bytes per second)
Definition: TransferSettings.cc:252
zypp::media::TransferSettings::setCertificateAuthoritiesPath
void setCertificateAuthoritiesPath(const zypp::Pathname &path)
Sets the SSL certificate authorities path.
Definition: TransferSettings.cc:313
zypp::media::TransferSettings::TransferSettings
TransferSettings()
Constructs a transfer program cmd line access.
Definition: TransferSettings.cc:85
zypp::media::TransferSettings::setPassword
void setPassword(const std::string &password)
sets the auth password
Definition: TransferSettings.cc:132
zypp::media::TransferSettings::Headers
std::vector< std::string > Headers
Definition: TransferSettings.h:35
zypp::filesystem::Pathname
Pathname.
Definition: Pathname.h:43
zypp::media::TransferSettings::setProxyUsername
void setProxyUsername(const std::string &proxyuser)
sets the proxy user
Definition: TransferSettings.cc:178
zypp::media::TransferSettings::setMinDownloadSpeed
void setMinDownloadSpeed(long v)
Set minimum download speed (bytes per second) until the connection is dropped.
Definition: TransferSettings.cc:242
zypp::RWCOW_pointer< Impl >
zypp::media::TransferSettings::connectTimeout
long connectTimeout() const
connection timeout
Definition: TransferSettings.cc:222
Flags.h
zypp::media::TransferSettings::headersEnd
Headers::const_iterator headersEnd() const
end iterators to additional headers
Definition: TransferSettings.cc:107
zypp::media::TransferSettings::setAnonymousAuth
void setAnonymousAuth()
sets anonymous authentication (ie: for ftp)
Definition: TransferSettings.cc:137
url
Url url
Definition: MediaCurl.cc:199
zypp::Url
Url manipulation class.
Definition: Url.h:87
zypp::media::TransferSettings::proxy
std::string proxy() const
proxy host
Definition: TransferSettings.cc:173
zypp::media::TransferSettings::password
std::string password() const
auth password
Definition: TransferSettings.cc:144
zypp::media::TransferSettings::_impl
RWCOW_pointer< Impl > _impl
Definition: TransferSettings.h:278
zypp::media::TransferSettings::maxDownloadSpeed
long maxDownloadSpeed() const
Maximum download speed (bytes per second)
Definition: TransferSettings.cc:247