mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-01 06:35:42 +00:00
92 lines
3.5 KiB
C++
92 lines
3.5 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
* vim: ft=cpp tw=78 sw=4 et ts=4 sts=4 cin
|
|
* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is mozilla.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Mozilla Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 2007
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
* Dave Camp <dcamp@mozilla.com>
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
interface nsIChannel;
|
|
|
|
/**
|
|
* An nsIChannelClassifier object checks a channel's URI against the
|
|
* URI classifier service, and cancels the channel before OnStartRequest
|
|
* if it is found on a blacklist.
|
|
*/
|
|
[scriptable, uuid(1481c5b5-9f6e-4995-8fe3-2aad5c06440d)]
|
|
interface nsIChannelClassifier : nsISupports
|
|
{
|
|
/**
|
|
* Checks a channel against the URI classifier service (if it exists).
|
|
*
|
|
* The channel will be suspended while the classifier is checked. The
|
|
* channel may be cancelled with an error code determined by the classifier
|
|
* before it is resumed.
|
|
*
|
|
* If there is no URI classifier service, NS_ERROR_FACTORY_NOT_REGISTERED
|
|
* will be returned.
|
|
*
|
|
* This method must be called immediately after AsyncOpen() has been called
|
|
* on the channel.
|
|
*
|
|
* @param aChannel
|
|
* The channel to suspend.
|
|
* @param aInstallListener
|
|
* If true, the classifier will install notification
|
|
* callbacks to listen for redirects. The classifier will
|
|
* pass all notifications on to the channel's existing
|
|
* notification callbacks.
|
|
*/
|
|
void start(in nsIChannel aChannel, in boolean aInstallListener);
|
|
|
|
/**
|
|
* Notify the classifier that the channel was redirected. The new channel
|
|
* will be suspended pending a new classifier lookup.
|
|
*
|
|
* @param aOldChannel
|
|
* The channel that's being redirected.
|
|
* @param aNewChannel
|
|
* The new channel. This channel is not opened yet.
|
|
*/
|
|
void onRedirect(in nsIChannel aOldChannel, in nsIChannel aNewChannel);
|
|
|
|
/**
|
|
* Cancel an existing query. If a channel has been suspended, it will
|
|
* be resumed.
|
|
*/
|
|
void cancel();
|
|
};
|