Back to index

lightning-sunbird  0.9+nobinonly
nsIHttpAuthenticator.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is Mozilla.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications.
00019  * Portions created by the Initial Developer are Copyright (C) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Darin Fisher <darin@netscape.com> (original author)
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsISupports.idl"
00040 
00041 interface nsIHttpChannel;
00042 
00054 [scriptable, uuid(0f331436-8bc8-4c68-a124-d0253a19d06f)]
00055 interface nsIHttpAuthenticator : nsISupports
00056 {
00081     void challengeReceived(in nsIHttpChannel aChannel,
00082                            in string         aChallenge,
00083                            in boolean        aProxyAuth,
00084                            inout nsISupports aSessionState,
00085                            inout nsISupports aContinuationState,
00086                            out boolean       aInvalidatesIdentity);
00087 
00122     string generateCredentials(in nsIHttpChannel aChannel,
00123                                in string         aChallenge,
00124                                in boolean        aProxyAuth,
00125                                in wstring        aDomain,
00126                                in wstring        aUser,
00127                                in wstring        aPassword,
00128                                inout nsISupports aSessionState,
00129                                inout nsISupports aContinuationState);
00130 
00134     readonly attribute unsigned long authFlags;
00135 
00142     const unsigned long REQUEST_BASED = (1<<0);
00143 
00151     const unsigned long CONNECTION_BASED = (1<<1);
00152 
00160     const unsigned long REUSABLE_CREDENTIALS = (1<<2);
00161 
00167     const unsigned long REUSABLE_CHALLENGE = (1<<3);
00168 
00173     const unsigned long IDENTITY_IGNORED = (1<<10);
00174 
00179     const unsigned long IDENTITY_INCLUDES_DOMAIN = (1<<11);
00180 };
00181 
00182 %{C++
00183 #define NS_HTTP_AUTHENTICATOR_CONTRACTID_PREFIX \
00184     "@mozilla.org/network/http-authenticator;1?scheme="
00185 %}