1 /* ***** BEGIN LICENSE BLOCK *****
2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3 *
4 * The contents of this file are subject to the Mozilla Public License Version
5 * 1.1 (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
7 * http://www.mozilla.org/MPL/
8 *
9 * Software distributed under the License is distributed on an "AS IS" basis,
10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11 * for the specific language governing rights and limitations under the
12 * License.
13 *
14 * The Original Code is mozilla.org code.
15 *
16 * The Initial Developer of the Original Code is
17 * Mozilla Corporation.
18 * Portions created by the Initial Developer are Copyright (C) 2007
19 * the Initial Developer. All Rights Reserved.
20 *
21 * Contributor(s):
22 * Dave Camp <dcamp@mozilla.com>
23 *
24 * Alternatively, the contents of this file may be used under the terms of
25 * either the GNU General Public License Version 2 or later (the "GPL"), or
26 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 * in which case the provisions of the GPL or the LGPL are applicable instead
28 * of those above. If you wish to allow use of your version of this file only
29 * under the terms of either the GPL or the LGPL, and not to allow others to
30 * use your version of this file under the terms of the MPL, indicate your
31 * decision by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL or the LGPL. If you do not delete
33 * the provisions above, a recipient may use your version of this file under
34 * the terms of any one of the MPL, the GPL or the LGPL.
35 *
36 * ***** END LICENSE BLOCK ***** */
37
38 #include "nsISupports.idl"
39
40 interface nsIURI;
41 interface nsIChannel;
42
43 /**
44 * Callback function for nsIURIClassifier lookups.
45 */
46 [scriptable, function, uuid(8face46e-0c96-470f-af40-0037dcd797bd)]
47 interface nsIURIClassifierCallback : nsISupports
48 {
49 /**
50 * Called by the URI classifier service when it is done checking a URI.
51 *
52 * Clients are responsible for associating callback objects with classify()
53 * calls.
54 *
55 * @param aErrorCode
56 * The error code with which the channel should be cancelled, or
57 * NS_OK if the load should continue normally.
58 */
59 void onClassifyComplete(in nsresult aErrorCode);
60 };
61
62 /**
63 * The URI classifier service checks a URI against lists of phishing
64 * and malware sites.
65 */
66 [scriptable, uuid(2de5c563-1203-43dd-a212-f5d56d530b6f)]
67 interface nsIURIClassifier : nsISupports
68 {
69 /**
70 * Classify a URI.
71 *
72 * @param aURI
73 * The URI that should be checked by the URI classifier.
74 * @param aCallback
75 * The URI classifier will call this callback when the URI has been
76 * classified.
77 *
78 * @return <code>false</code> if classification is not necessary. The
79 * callback will not be called.
80 * <code>true</code> if classification will be performed. The
81 * callback will be called.
82 */
83 boolean classify(in nsIURI aURI,
84 in nsIURIClassifierCallback aCallback);
85 };