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