modules/libjar/nsIJARURI.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  *
   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
  19  * Netscape Communications Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 1998
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  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 "nsIURL.idl"
  40
  41 /**
  42  * JAR URLs have the following syntax
  43  *
  44  * jar:<jar-file-uri>!/<jar-entry>
  45  *
  46  * EXAMPLE: jar:http://www.big.com/blue.jar!/ocean.html
  47  *
  48  * The nsIURL methods operate on the <jar-entry> part of the spec.
  49  */
  50 [scriptable, uuid(b0922a89-f87b-4cb5-8612-305a285fcca7)]
  51 interface nsIJARURI : nsIURL {
  52
  53     /**
  54      * Returns the root URI (the one for the actual JAR file) for this JAR
  55      * (e.g., http://www.big.com/blue.jar).
  56      */
  57     readonly attribute nsIURI JARFile;
  58
  59     /**
  60      * Returns the entry specified for this JAR URI (e.g., "ocean.html").  This
  61      * value may contain %-escaped byte sequences.
  62      */
  63     attribute AUTF8String JAREntry;
  64
  65     /**
  66      * Create a clone of the JAR URI with a new root URI (the URI for the
  67      * actual JAR file).
  68      */
  69     nsIJARURI cloneWithJARFile(in nsIURI jarFile);
  70 };