netwerk/base/public/nsINestedURI.idl

   1 /* -*- Mode: C++; tab-width: 2; 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 mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Mozilla Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2006
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *       Boris Zbarsky <bzbarsky@mit.edu>  (Original Author)
  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 nsIURI;
  42
  43 /**
  44  * nsINestedURI is an interface that must be implemented by any nsIURI
  45  * implementation which has an "inner" URI that it actually gets data
  46  * from.
  47  *
  48  * For example, if URIs for the scheme "sanitize" have the structure:
  49  *
  50  *   sanitize:http://example.com
  51  *
  52  * and opening a channel on such a sanitize: URI gets the data from
  53  * http://example.com, sanitizes it, and returns it, then the sanitize: URI
  54  * should implement nsINestedURI and return the http://example.com URI as its
  55  * inner URI.
  56  */
  57 [scriptable, uuid(6de2c874-796c-46bf-b57f-0d7bd7d6cab0)]
  58 interface nsINestedURI : nsISupports
  59 {
  60   /**
  61    * The inner URI for this nested URI.  This must not return null if the
  62    * getter succeeds; URIs that have no inner must not QI to this interface.
  63    * Dynamically changing whether there is an inner URI is not allowed.
  64    *
  65    * Modifying the returned URI must not in any way modify the nested URI; this
  66    * means the returned URI must be either immutable or a clone.
  67    */
  68   readonly attribute nsIURI innerURI;
  69
  70   /**
  71    * The innermost URI for this nested URI.  This must not return null if the
  72    * getter succeeds.  This is equivalent to repeatedly calling innerURI while
  73    * the returned URI QIs to nsINestedURI.
  74    *
  75    * Modifying the returned URI must not in any way modify the nested URI; this
  76    * means the returned URI must be either immutable or a clone.
  77    */
  78   readonly attribute nsIURI innermostURI;
  79 };