nsIJARChannel.idl (1478B)
1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ 2 /* This Source Code Form is subject to the terms of the Mozilla Public 3 * License, v. 2.0. If a copy of the MPL was not distributed with this 4 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ 5 6 #include "nsIChannel.idl" 7 8 interface nsIFile; 9 interface nsIZipEntry; 10 11 [scriptable, builtinclass, uuid(e72b179b-d5df-4d87-b5de-fd73a65c60f6)] 12 interface nsIJARChannel : nsIChannel 13 { 14 /** 15 * Returns the JAR file. May be null if the jar is remote. 16 * Setting the JAR file is optional and overrides the JAR 17 * file used for local file JARs. Setting the JAR file after 18 * the channel has been opened is not permitted. 19 */ 20 attribute nsIFile jarFile; 21 22 /** 23 * Returns the zip entry if the file is synchronously accessible. 24 * This will work even without opening the channel. 25 */ 26 readonly attribute nsIZipEntry zipEntry; 27 28 /** 29 * If the JAR file is cached in the JAR cache, returns true and 30 * holds a reference to the cached zip reader to be used when 31 * the channel is read from, ensuring the cached reader will be used. 32 * For a successful read from the cached reader, close() should not 33 * be called on the reader--per nsIZipReader::getZip() documentation. 34 * Returns false if the JAR file is not cached. Calling this method 35 * after the channel has been opened is not permitted. 36 */ 37 boolean ensureCached(); 38 };