modules/plugin/base/public/nsIJVMAuthTools.idl

   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  * Sun Microsystem.
  19  * Portions created by the Initial Developer are Copyright (C) 2003
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Joshua Xia <joshua.xia@sun.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 %{C++
  42
  43 #define NS_JVMAUTHTOOLS_CID                          \
  44 { /* d8e716f9-c96e-4e84-ab12-980f5567e2a4 */         \
  45     0xd8e716f9,                                      \
  46     0xc96e,                                          \
  47     0x4e84,                                          \
  48     {0xab, 0x12, 0x98, 0x0f, 0x55, 0x67, 0xe2, 0xa4} \
  49 }
  50
  51 %}
  52
  53 [ptr] native const_char_ptr(const char);
  54
  55 [noscript, uuid(078a1b99-6be2-4a57-a749-378f4a506097)]
  56 interface nsIAuthenticationInfo : nsISupports
  57 {
  58    /**
  59     * AuthenticationInfo (username/password pair)
  60     */
  61
  62    readonly attribute const_char_ptr  username;
  63    readonly attribute const_char_ptr  password;
  64 };
  65
  66 [noscript, uuid(82274a32-a196-42ee-8e3b-fcb73e339518)]
  67 interface nsIJVMAuthTools : nsISupports
  68 {
  69     /**
  70      * Export AuthenticationInfo interface to JPI.
  71      *
  72      * @param protocol               the protocol that support (http/https)
  73      * @param host                   host name
  74      * @param port                   port number
  75      * @param scheme                 scheme
  76      * @param realm                  realm
  77      * @param nsIAuthenticationInfo  the AuthenticationInfo interface
  78      *                               that export
  79      *
  80      * @return                       NS_OK if success, other if fail
  81      */
  82
  83     nsIAuthenticationInfo GetAuthenticationInfo(in string protocol,
  84                                                 in string host,
  85                                                 in PRInt32 port,
  86                                                 in string scheme,
  87                                                 in string realm);
  88
  89     /**
  90      * Import username/password pair from JPI.
  91      *
  92      * @param protocol  the protocol that support (http/https)
  93      * @param host      host name
  94      * @param port      port number
  95      * @param scheme    scheme
  96      * @param realm     realm
  97      * @param username  user name
  98      * @param password  password
  99      *
 100      * @return          NS_OK if success, other if fail
 101      */
 102
 103     void SetAuthenticationInfo(in string protocol,
 104                                in string host,
 105                                in PRInt32 port,
 106                                in string scheme,
 107                                in string realm,
 108                                in string username,
 109                                in string password);
 110
 111 };