toolkit/components/url-classifier/public/nsIUrlListManager.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
  41 /**
  42  * Interface for a class that manages updates of the url classifier database.
  43  */
  44
  45 // Interface for JS function callbacks
  46 [scriptable, function, uuid(fa4caf12-d057-4e7e-81e9-ce066ceee90b)]
  47 interface nsIUrlListManagerCallback : nsISupports {
  48   void handleEvent(in ACString value);
  49 };
  50
  51
  52 [scriptable, uuid(9c5598ec-9986-40cf-af40-b5e0d817a3a0)]
  53 interface nsIUrlListManager : nsISupports
  54 {
  55     /**
  56      * Set the URL we check for updates.
  57      */
  58     void setUpdateUrl(in ACString url);
  59
  60     /**
  61      * Set the URL we use to get keys used to decrypt URLs in
  62      * enchash tables.
  63      */
  64     void setKeyUrl(in ACString url);
  65
  66     /**
  67      * Set the URL that we will query for complete hashes after a partial
  68      * hash match.
  69      */
  70     void setGethashUrl(in ACString url);
  71
  72     /**
  73      * Add a table to the list of tables we are managing.  The name is a
  74      * string of the format provider_name-semantic_type-table_type.  For
  75      * example, goog-white-enchash or goog-black-url.
  76      */
  77     boolean registerTable(in ACString tableName,
  78                           in boolean requireMac);
  79
  80     /**
  81      * Turn on update checking for a table.  I.e., during the next server
  82      * check, download updates for this table.
  83      */
  84     void enableUpdate(in ACString tableName);
  85
  86     /**
  87      * Turn off update checking for a table.
  88      */
  89     void disableUpdate(in ACString tableName);
  90
  91     /**
  92      * Lookup a key.  Should not raise exceptions.  Calls the callback
  93      * function with a comma-separated list of tables to which the key
  94      * belongs.
  95      */
  96     void safeLookup(in ACString key,
  97                     in nsIUrlListManagerCallback cb);
  98
  99     void checkForUpdates();
 100 };