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 Mozilla.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications.
19 * Portions created by the Initial Developer are Copyright (C) 2001
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 * Gagan Saksena <gagan@netscape.com> (original author)
24 * Darin Fisher <darin@netscape.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 interface nsIHttpChannel;
44 interface nsIURI;
45
46 /**
47 * nsIHttpEventSink
48 *
49 * Implement this interface to receive control over various HTTP events. The
50 * HTTP channel will try to get this interface from its notificationCallbacks
51 * attribute, and if it doesn't find it there it will look for it from its
52 * loadGroup's notificationCallbacks attribute.
53 *
54 * These methods are called before onStartRequest, and should be handled
55 * SYNCHRONOUSLY.
56 *
57 * @deprecated Newly written code should use nsIChannelEventSink instead of this
58 * interface.
59 */
60 [scriptable, uuid(9475a6af-6352-4251-90f9-d65b1cd2ea15)]
61 interface nsIHttpEventSink : nsISupports
62 {
63 /**
64 * Called when a redirect occurs due to a HTTP response like 302. The
65 * redirection may be to a non-http channel.
66 *
67 * @return failure cancels redirect
68 */
69 void onRedirect(in nsIHttpChannel httpChannel,
70 in nsIChannel newChannel);
71 };