1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 * vim: ft=cpp tw=78 sw=4 et ts=4 sts=4 cin
3 * ***** BEGIN LICENSE BLOCK *****
4 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
5 *
6 * The contents of this file are subject to the Mozilla Public License Version
7 * 1.1 (the "License"); you may not use this file except in compliance with
8 * the License. You may obtain a copy of the License at
9 * http://www.mozilla.org/MPL/
10 *
11 * Software distributed under the License is distributed on an "AS IS" basis,
12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 * for the specific language governing rights and limitations under the
14 * License.
15 *
16 * The Original Code is mozilla.org code.
17 *
18 * The Initial Developer of the Original Code is
19 * Mozilla Corporation.
20 * Portions created by the Initial Developer are Copyright (C) 2007
21 * the Initial Developer. All Rights Reserved.
22 *
23 * Contributor(s):
24 * Dave Camp <dcamp@mozilla.com>
25 *
26 * Alternatively, the contents of this file may be used under the terms of
27 * either the GNU General Public License Version 2 or later (the "GPL"), or
28 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
29 * in which case the provisions of the GPL or the LGPL are applicable instead
30 * of those above. If you wish to allow use of your version of this file only
31 * under the terms of either the GPL or the LGPL, and not to allow others to
32 * use your version of this file under the terms of the MPL, indicate your
33 * decision by deleting the provisions above and replace them with the notice
34 * and other provisions required by the GPL or the LGPL. If you do not delete
35 * the provisions above, a recipient may use your version of this file under
36 * the terms of any one of the MPL, the GPL or the LGPL.
37 *
38 * ***** END LICENSE BLOCK ***** */
39
40 #include "nsISupports.idl"
41
42 interface nsIChannel;
43
44 /**
45 * An nsIChannelClassifier object checks a channel's URI against the
46 * URI classifier service, and cancels the channel before OnStartRequest
47 * if it is found on a blacklist.
48 */
49 [scriptable, uuid(d17f8f74-d403-4dea-b124-3ace5dbe44dc)]
50 interface nsIChannelClassifier : nsISupports
51 {
52 /**
53 * Checks a channel against the URI classifier service (if it exists).
54 *
55 * The channel will be suspended while the classifier is checked. The
56 * channel may be cancelled with an error code determined by the classifier
57 * before it is resumed.
58 *
59 * If there is no URI classifier service, NS_ERROR_FACTORY_NOT_REGISTERED
60 * will be returned.
61 *
62 * @param aChannel
63 * The channel to suspend.
64 */
65 void start(in nsIChannel aChannel);
66
67 /**
68 * Notify the classifier that the channel was redirected. The new channel
69 * will be suspended pending a new classifier lookup.
70 *
71 * @param aOldChannel
72 * The channel that's being redirected.
73 * @param aNewChannel
74 * The new channel. This channel is not opened yet.
75 */
76 void onRedirect(in nsIChannel aOldChannel, in nsIChannel aNewChannel);
77
78 /**
79 * Cancel an existing query. If a channel has been suspended, it will
80 * be resumed.
81 */
82 void cancel();
83 };