modules/libjar/nsIJARURI.idl
author Alex Gaynor <agaynor@mozilla.com>
Thu, 30 Mar 2017 09:50:57 -0400
changeset 350487 7bd673cb48e49ba40c28818bec1a3318a2a2a15c
parent 258277 75ba313634f34e4b5e7fd9e5e6862680c1f69ddd
child 391997 cfe4b1e6be9bb8fe780209776f03fb0c834bafa0
permissions -rw-r--r--
Bug 1352055 - Remove reference to a legacy preference name for sandboxing. r=jimm MozReview-Commit-ID: 28UfBrHWfcb

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsIURL.idl"

/**
 * JAR URLs have the following syntax
 *
 * jar:<jar-file-uri>!/<jar-entry>
 *
 * EXAMPLE: jar:http://www.big.com/blue.jar!/ocean.html
 *
 * The nsIURL methods operate on the <jar-entry> part of the spec.
 */
[scriptable, uuid(646a508c-f786-4e14-be6d-8dda2a633c60)]
interface nsIJARURI : nsIURL {

    /**
     * Returns the root URI (the one for the actual JAR file) for this JAR
     * (e.g., http://www.big.com/blue.jar).
     */
    readonly attribute nsIURI JARFile;

    /**
     * Returns the entry specified for this JAR URI (e.g., "ocean.html").  This
     * value may contain %-escaped byte sequences.
     */
    attribute AUTF8String JAREntry;

    /**
     * Create a clone of the JAR URI with a new root URI (the URI for the
     * actual JAR file).
     */
    nsIJARURI cloneWithJARFile(in nsIURI jarFile);
};