net/url_request/url_request_context_builder.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 // This class is useful for building a simple URLRequestContext. Most creators
   6 // of new URLRequestContexts should use this helper class to construct it. Call
   7 // any configuration params, and when done, invoke Build() to construct the
   8 // URLRequestContext. This URLRequestContext will own all its own storage.
   9 //
  10 // URLRequestContextBuilder and its associated params classes are initially
  11 // populated with "sane" default values. Read through the comments to figure out
  12 // what these are.
  13
  14 #ifndef NET_URL_REQUEST_URL_REQUEST_CONTEXT_BUILDER_H_
  15 #define NET_URL_REQUEST_URL_REQUEST_CONTEXT_BUILDER_H_
  16
  17 #include <string>
  18 #include <vector>
  19
  20 #include "base/basictypes.h"
  21 #include "base/files/file_path.h"
  22 #include "base/memory/ref_counted.h"
  23 #include "base/memory/scoped_ptr.h"
  24 #include "base/memory/scoped_vector.h"
  25 #include "build/build_config.h"
  26 #include "net/base/net_export.h"
  27 #include "net/base/network_delegate.h"
  28 #include "net/dns/host_resolver.h"
  29 #include "net/proxy/proxy_config_service.h"
  30 #include "net/proxy/proxy_service.h"
  31 #include "net/quic/quic_protocol.h"
  32 #include "net/socket/next_proto.h"
  33
  34 namespace base {
  35 class SingleThreadTaskRunner;
  36 }
  37
  38 namespace net {
  39
  40 class ChannelIDService;
  41 class CookieStore;
  42 class FtpTransactionFactory;
  43 class HostMappingRules;
  44 class HttpAuthHandlerFactory;
  45 class ProxyConfigService;
  46 class URLRequestContext;
  47 class URLRequestInterceptor;
  48
  49 class NET_EXPORT URLRequestContextBuilder {
  50  public:
  51   struct NET_EXPORT HttpCacheParams {
  52     enum Type {
  53       IN_MEMORY,
  54       DISK,
  55     };
  56
  57     HttpCacheParams();
  58     ~HttpCacheParams();
  59
  60     // The type of HTTP cache. Default is IN_MEMORY.
  61     Type type;
  62
  63     // The max size of the cache in bytes. Default is algorithmically determined
  64     // based off available disk space.
  65     int max_size;
  66
  67     // The cache path (when type is DISK).
  68     base::FilePath path;
  69   };
  70
  71   struct NET_EXPORT HttpNetworkSessionParams {
  72     HttpNetworkSessionParams();
  73     ~HttpNetworkSessionParams();
  74
  75     // These fields mirror those in HttpNetworkSession::Params;
  76     bool ignore_certificate_errors;
  77     HostMappingRules* host_mapping_rules;
  78     uint16 testing_fixed_http_port;
  79     uint16 testing_fixed_https_port;
  80     NextProtoVector next_protos;
  81     std::string trusted_spdy_proxy;
  82     bool use_alternate_protocols;
  83     bool enable_quic;
  84     QuicTagVector quic_connection_options;
  85   };
  86
  87   URLRequestContextBuilder();
  88   ~URLRequestContextBuilder();
  89
  90   // These functions are mutually exclusive.  The ProxyConfigService, if
  91   // set, will be used to construct a ProxyService.
  92   void set_proxy_config_service(ProxyConfigService* proxy_config_service) {
  93     proxy_config_service_.reset(proxy_config_service);
  94   }
  95   void set_proxy_service(ProxyService* proxy_service) {
  96     proxy_service_.reset(proxy_service);
  97   }
  98
  99   // Call these functions to specify hard-coded Accept-Language
 100   // or User-Agent header values for all requests that don't
 101   // have the headers already set.
 102   void set_accept_language(const std::string& accept_language) {
 103     accept_language_ = accept_language;
 104   }
 105   void set_user_agent(const std::string& user_agent) {
 106     user_agent_ = user_agent;
 107   }
 108
 109   // Control support for data:// requests. By default it's disabled.
 110   void set_data_enabled(bool enable) {
 111     data_enabled_ = enable;
 112   }
 113
 114 #if !defined(DISABLE_FILE_SUPPORT)
 115   // Control support for file:// requests. By default it's disabled.
 116   void set_file_enabled(bool enable) {
 117     file_enabled_ = enable;
 118   }
 119 #endif
 120
 121 #if !defined(DISABLE_FTP_SUPPORT)
 122   // Control support for ftp:// requests. By default it's disabled.
 123   void set_ftp_enabled(bool enable) {
 124     ftp_enabled_ = enable;
 125   }
 126 #endif
 127
 128   // TODO(mmenke):  Probably makes sense to get rid of this, and have consumers
 129   // set their own NetLog::Observers instead.
 130   void set_net_log(NetLog* net_log) {
 131     net_log_.reset(net_log);
 132   }
 133
 134   // By default host_resolver is constructed with CreateDefaultResolver.
 135   void set_host_resolver(HostResolver* host_resolver) {
 136     host_resolver_.reset(host_resolver);
 137   }
 138
 139   // Uses BasicNetworkDelegate by default. Note that calling Build will unset
 140   // any custom delegate in builder, so this must be called each time before
 141   // Build is called.
 142   void set_network_delegate(NetworkDelegate* delegate) {
 143     network_delegate_.reset(delegate);
 144   }
 145
 146   // Adds additional auth handler factories to be used in addition to what is
 147   // provided in the default |HttpAuthHandlerRegistryFactory|. The auth |scheme|
 148   // and |factory| are provided. The builder takes ownership of the factory and
 149   // Build() must be called after this method.
 150   void add_http_auth_handler_factory(const std::string& scheme,
 151                                      HttpAuthHandlerFactory* factory) {
 152     extra_http_auth_handlers_.push_back(SchemeFactory(scheme, factory));
 153   }
 154
 155   // By default HttpCache is enabled with a default constructed HttpCacheParams.
 156   void EnableHttpCache(const HttpCacheParams& params);
 157   void DisableHttpCache();
 158
 159   // Override default HttpNetworkSession::Params settings.
 160   void set_http_network_session_params(
 161       const HttpNetworkSessionParams& http_network_session_params) {
 162     http_network_session_params_ = http_network_session_params;
 163   }
 164
 165   void set_transport_security_persister_path(
 166       const base::FilePath& transport_security_persister_path) {
 167     transport_security_persister_path_ = transport_security_persister_path;
 168   }
 169
 170   // Adjust |http_network_session_params_.next_protos| to enable SPDY and QUIC.
 171   void SetSpdyAndQuicEnabled(bool spdy_enabled,
 172                              bool quic_enabled);
 173
 174   void set_quic_connection_options(
 175       const QuicTagVector& quic_connection_options) {
 176     http_network_session_params_.quic_connection_options =
 177         quic_connection_options;
 178   }
 179
 180   void set_throttling_enabled(bool throttling_enabled) {
 181     throttling_enabled_ = throttling_enabled;
 182   }
 183
 184   void SetInterceptors(
 185       ScopedVector<URLRequestInterceptor> url_request_interceptors);
 186
 187   // Override the default in-memory cookie store and channel id service.
 188   // |cookie_store| must not be NULL. |channel_id_service| may be NULL to
 189   // disable channel id for this context.
 190   // Note that a persistent cookie store should not be used with an in-memory
 191   // channel id service, and one cookie store should not be shared between
 192   // multiple channel-id stores (or used both with and without a channel id
 193   // store).
 194   void SetCookieAndChannelIdStores(
 195       const scoped_refptr<CookieStore>& cookie_store,
 196       scoped_ptr<ChannelIDService> channel_id_service);
 197
 198   // Sets the task runner used to perform file operations. If not set, one will
 199   // be created.
 200   void SetFileTaskRunner(
 201       const scoped_refptr<base::SingleThreadTaskRunner>& task_runner);
 202
 203   // Note that if SDCH is enabled without a policy object observing
 204   // the SDCH manager and handling at least Get-Dictionary events, the
 205   // result will be "Content-Encoding: sdch" advertisements, but no
 206   // dictionaries fetches and no specific dictionaries advertised.
 207   // SdchOwner in net/sdch/sdch_owner.h is a simple policy object.
 208   void set_sdch_enabled(bool enable) { sdch_enabled_ = enable; }
 209
 210   URLRequestContext* Build();
 211
 212  private:
 213   struct NET_EXPORT SchemeFactory {
 214     SchemeFactory(const std::string& scheme, HttpAuthHandlerFactory* factory);
 215     ~SchemeFactory();
 216
 217     std::string scheme;
 218     HttpAuthHandlerFactory* factory;
 219   };
 220
 221   std::string accept_language_;
 222   std::string user_agent_;
 223   // Include support for data:// requests.
 224   bool data_enabled_;
 225 #if !defined(DISABLE_FILE_SUPPORT)
 226   // Include support for file:// requests.
 227   bool file_enabled_;
 228 #endif
 229 #if !defined(DISABLE_FTP_SUPPORT)
 230   // Include support for ftp:// requests.
 231   bool ftp_enabled_;
 232 #endif
 233   bool http_cache_enabled_;
 234   bool throttling_enabled_;
 235   bool sdch_enabled_;
 236
 237   scoped_refptr<base::SingleThreadTaskRunner> file_task_runner_;
 238   HttpCacheParams http_cache_params_;
 239   HttpNetworkSessionParams http_network_session_params_;
 240   base::FilePath transport_security_persister_path_;
 241   scoped_ptr<NetLog> net_log_;
 242   scoped_ptr<HostResolver> host_resolver_;
 243   scoped_ptr<ChannelIDService> channel_id_service_;
 244   scoped_ptr<ProxyConfigService> proxy_config_service_;
 245   scoped_ptr<ProxyService> proxy_service_;
 246   scoped_ptr<NetworkDelegate> network_delegate_;
 247   scoped_refptr<CookieStore> cookie_store_;
 248   scoped_ptr<FtpTransactionFactory> ftp_transaction_factory_;
 249   std::vector<SchemeFactory> extra_http_auth_handlers_;
 250   ScopedVector<URLRequestInterceptor> url_request_interceptors_;
 251
 252   DISALLOW_COPY_AND_ASSIGN(URLRequestContextBuilder);
 253 };
 254
 255 }  // namespace net
 256
 257 #endif  // NET_URL_REQUEST_URL_REQUEST_CONTEXT_BUILDER_H_