doc/manager-api.txt

   1 Manager hierarchy
   2 =================
   3
   4 Service         org.pacrunner
   5 Interface       org.pacrunner.Manager
   6 Object path     /org/pacrunner/manager
   7
   8 Methods         object CreateProxyConfiguration(dict settings)
   9
  10                         This method allows system daemons handling Internet
  11                         connections and that also use Web Proxy Autodiscovery
  12                         Protocol (WPAD) to configure PAC URLs.
  13
  14                         Valid settings for configuration are these:
  15
  16                         string Method [mandatory]
  17
  18                                 The method of proxy configuration. Valid
  19                                 values are "direct", "manual" and "auto".
  20
  21                                 For "direct" no proxy is used. Using this
  22                                 value just allows for reference configuration
  23                                 since it makes no difference compared to not
  24                                 having any proxy settings at all.
  25
  26                                 The "auto" configuration requires to have
  27                                 the URL setting filled in and be valud.
  28
  29                         string URL [optional]
  30
  31                                 URL for the PAC file. The URL must be
  32                                 fully qualified.
  33
  34                                 Example: "http://wpad.connman.net/wpad.dat"
  35
  36                         string Script [optional]
  37
  38                                 PAC script as text string. The script must
  39                                 be valid Javascript with FindProxyForURL()
  40                                 function.
  41
  42                                 Example:
  43
  44                                 function FindProxyForURL(url, host)
  45                                 {
  46                                         return "DIRECT";
  47                                 }
  48
  49                         array{string} Servers [optional]
  50
  51                                 List of proxy servers. This value is only
  52                                 valid when method is set to "manual".
  53
  54                         array{string} Excludes [optional]
  55
  56                                 List of hosts to exclude from proxy lookup.
  57
  58                         string Interface [optional]
  59
  60                                 Interface name like "wlan0" etc. to provide
  61                                 consistent results for myIpAddress function.
  62
  63                         array{string} Domains [optional]
  64
  65                                 Domain names for which the URL is valid.
  66
  67                         array{string} Nameservers [optional]
  68
  69                                 List of nameservers for this configuration.
  70
  71                                 This value is needed for dnsResolve function
  72                                 in PAC files.
  73
  74                         On successful configuration of this method returns
  75                         an object path that uniquely identifies this specific
  76                         configuration.
  77
  78                 void DestroyProxyConfiguration(object config)
  79
  80                         This method allows to remove a previously configured
  81                         proxy configuration. The object path to use is the
  82                         one returned from CreateProxyConfiguration.
  83
  84                         A proxy configuration is only valid for the lifetime
  85                         of the application creating it. In case it disconnects
  86                         from the bus, the configuration will be automatically
  87                         removed.