gecko/netwerk/base/public/nsINestedURI.idl

80 lines
3.2 KiB
Plaintext

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Mozilla Corporation.
* Portions created by the Initial Developer are Copyright (C) 2006
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Boris Zbarsky <bzbarsky@mit.edu> (Original Author)
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
interface nsIURI;
/**
* nsINestedURI is an interface that must be implemented by any nsIURI
* implementation which has an "inner" URI that it actually gets data
* from.
*
* For example, if URIs for the scheme "sanitize" have the structure:
*
* sanitize:http://example.com
*
* and opening a channel on such a sanitize: URI gets the data from
* http://example.com, sanitizes it, and returns it, then the sanitize: URI
* should implement nsINestedURI and return the http://example.com URI as its
* inner URI.
*/
[scriptable, uuid(6de2c874-796c-46bf-b57f-0d7bd7d6cab0)]
interface nsINestedURI : nsISupports
{
/**
* The inner URI for this nested URI. This must not return null if the
* getter succeeds; URIs that have no inner must not QI to this interface.
* Dynamically changing whether there is an inner URI is not allowed.
*
* Modifying the returned URI must not in any way modify the nested URI; this
* means the returned URI must be either immutable or a clone.
*/
readonly attribute nsIURI innerURI;
/**
* The innermost URI for this nested URI. This must not return null if the
* getter succeeds. This is equivalent to repeatedly calling innerURI while
* the returned URI QIs to nsINestedURI.
*
* Modifying the returned URI must not in any way modify the nested URI; this
* means the returned URI must be either immutable or a clone.
*/
readonly attribute nsIURI innermostURI;
};