dom/public/nsIScriptChannel.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   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) 2007
  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 /**
  42  * An interface representing a channel which will have to execute some sort of
  43  * program provided via its URI to compute the data it should return.
  44  *
  45  * If a channel implements this interface, the execution of the program in
  46  * question will be restricted in the following ways:
  47  *
  48  * - If the channel does not have an owner principal, the program will not be
  49  *   executed at all, no matter what.  This is necessary because in this
  50  *   circumstance we have no way to tell whether script execution is allowed at
  51  *   all for the originating security context of this channel.
  52  * - If the channel has an owner principal, how it is executed is controlled by
  53  *   this interface.  However if the owner principal does not subsume the
  54  *   principal of the environment in which the program is to be executed the
  55  *   execution will be forced to happen in a sandbox.
  56  */
  57 [scriptable, uuid(33234b99-9588-4c7d-9da6-86b8b7cba565)]
  58 interface nsIScriptChannel : nsISupports
  59 {
  60   /**
  61    * Possible ways of executing the program.
  62    */
  63
  64   /**
  65    * Don't execute at all.
  66    */
  67   const unsigned long NO_EXECUTION = 0;
  68
  69   /**
  70    * Execute in a sandbox, no matter how the various principals involved are
  71    * related to each other.
  72    */
  73   const unsigned long EXECUTE_IN_SANDBOX = 1;
  74
  75   /**
  76    * Execute against the target environment if the principals allow it.
  77    */
  78   const unsigned long EXECUTE_NORMAL = 2;
  79
  80   /**
  81    * Whether and how the program represented by this channel is to be executed.
  82    * The default value if this property has never been set on this channel MUST
  83    * be either EXECUTE_IN_SANDBOX or NO_EXECUTION.
  84    *
  85    * @throws NS_ERROR_INVALID_ARG when set to an unrecognized value.
  86    */
  87   attribute unsigned long executionPolicy;
  88
  89   /**
  90    * Control whether the program should be executed synchronosly when
  91    * the channel's AsyncOpen method is called or whether it should be
  92    * executed asynchronously.  In both cases, any data that the
  93    * channel returns will be returned asynchronously; the only thing
  94    * this property affects is when the program executes.
  95    *
  96    * The default value of this property is TRUE.
  97    *
  98    * Setting this property after asyncOpen has been called on the
  99    * channel has no effect.
 100    */
 101   attribute boolean executeAsync;
 102 };