netwerk/base/public/nsIProtocolProxyFilter.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim:set ts=2 sw=2 sts=2 et cindent: */
   3 /* ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is mozilla.org code.
  17  *
  18  * The Initial Developer of the Original Code is Google Inc.
  19  * Portions created by the Initial Developer are Copyright (C) 2005
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *  Darin Fisher <darin@meer.net>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 interface nsIProtocolProxyService;
  42 interface nsIProxyInfo;
  43 interface nsIURI;
  44
  45 /**
  46  * This interface is used to apply filters to the proxies selected for a given
  47  * URI.  Use nsIProtocolProxyService::registerFilter to hook up instances of
  48  * this interface.
  49  *
  50  * @status UNDER_REVIEW
  51  */
  52 [scriptable, uuid(f424abd3-32b4-456c-9f45-b7e3376cb0d1)]
  53 interface nsIProtocolProxyFilter : nsISupports
  54 {
  55   /**
  56    * This method is called to apply proxy filter rules for the given URI
  57    * and proxy object (or list of proxy objects).
  58    *
  59    * @param aProxyService
  60    *        A reference to the Protocol Proxy Service.  This is passed so that
  61    *        implementations may easily access methods such as newProxyInfo.
  62    * @param aURI
  63    *        The URI for which these proxy settings apply.
  64    * @param aProxy
  65    *        The proxy (or list of proxies) that would be used by default for
  66    *        the given URI.  This may be null.
  67    *
  68    * @return The proxy (or list of proxies) that should be used in place of
  69    *         aProxy.  This can be just be aProxy if the filter chooses not to
  70    *         modify the proxy.  It can also be null to indicate that a direct
  71    *         connection should be used.  Use aProxyService.newProxyInfo to
  72    *         construct nsIProxyInfo objects.
  73    */
  74   nsIProxyInfo applyFilter(in nsIProtocolProxyService aProxyService,
  75                            in nsIURI aURI, in nsIProxyInfo aProxy);
  76 };