toolkit/components/url-classifier/public/nsIUrlClassifierStreamUpdater.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   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 Url Classifier code
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Google Inc.
  19  * Portions created by the Initial Developer are Copyright (C) 2006
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Tony Chang <tony@ponderer.org> (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 #include "nsIUrlClassifierDBService.idl"
  41
  42 /**
  43  * This is a class to manage large table updates from the server.  Rather than
  44  * downloading the whole update and then updating the sqlite database, we
  45  * update tables as the data is streaming in.
  46  */
  47 [scriptable, uuid(daf3038a-556c-47d3-a3d2-36caa9a762a0)]
  48 interface nsIUrlClassifierStreamUpdater : nsISupports
  49 {
  50   /**
  51    * The Url to download from.  Should be plain ascii text.
  52    */
  53   attribute ACString updateUrl;
  54
  55   /**
  56    * Try to download updates from updateUrl.  Only one instance of this
  57    * runs at a time, so we return false if another instance is already
  58    * running.
  59    * @param aRequestTables Comma-separated list of tables included in this
  60    *        update.
  61    * @param aRequestBody The body for the request.
  62    * @param aClientKey The client key for checking the update's MAC.
  63    * @param aSuccessCallback Called after a successful update.
  64    * @param aUpdateErrorCallback Called for problems applying the update
  65    * @param aDownloadErrorCallback Called if we get an http error or a
  66    *        connection refused error.
  67    */
  68   boolean downloadUpdates(in ACString aRequestTables,
  69                           in ACString aRequestBody,
  70                           in ACString aClientKey,
  71                           in nsIUrlClassifierCallback aSuccessCallback,
  72                           in nsIUrlClassifierCallback aUpdateErrorCallback,
  73                           in nsIUrlClassifierCallback aDownloadErrorCallback);
  74 };