netwerk/base/public/nsISystemProxySettings.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Novell code.
  16  *
  17  * The Initial Developer of the Original Code is Novell.
  18  * Portions created by the Initial Developer are Copyright (C) 2005
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *    Robert O'Callahan (robert@ocallahan.org)
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39 #include "nsIURI.idl"
  40
  41 /**
  42  * This interface allows the proxy code to use platform-specific proxy
  43  * settings when the proxy preference is set to "automatic discovery". This service
  44  * acts like a PAC parser to netwerk, but it will actually read the system settings and
  45  * either return the proper proxy data from the autoconfig URL specified in the system proxy,
  46  * or generate proxy data based on the system's manual proxy settings.
  47  */
  48 [scriptable, uuid(a9f3ae38-b769-4e0b-9317-578388e326c9)]
  49 interface nsISystemProxySettings : nsISupports
  50 {
  51     /**
  52      * If non-empty, use this PAC file. If empty, call getProxyForURI instead.
  53      */
  54     readonly attribute AUTF8String PACURI;
  55
  56     /**
  57      * See nsIProxyAutoConfig::getProxyForURI; this function behaves exactly
  58      * the same way.
  59      */
  60     AUTF8String getProxyForURI(in nsIURI aURI);
  61 };