extensions/webservices/public/nsISOAPService.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   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.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2001
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 interface nsISOAPMessage;
  41 interface nsISOAPResponseListener;
  42
  43 /**
  44  * This interface describes a service which may be
  45  *   applied to incoming messages.  The service is
  46  *   responsible for determining whether the message
  47  *   is one that it should process and rejecting it
  48  *   if it is not.  Services may be chained.
  49  */
  50 [scriptable, uuid(9927fa40-1dd1-11b2-a8d1-857ad21b872c)]
  51 interface nsISOAPService : nsISupports {
  52   /**
  53    * Configuration object that may contain more info on the service
  54    */
  55   attribute nsISupports configuration;
  56
  57   /**
  58    * Process an incoming message.
  59    *
  60    * @param aMessage message to be processed
  61    *
  62    * @param aListener listener to which to report results
  63    *
  64    * @return True if the message will be handled, false if
  65    *   it should be given to some other service or fail.
  66    *   In case of failure, a more detailed status will be
  67    *   recorded in the message.
  68    */
  69   boolean process(in nsISOAPMessage aMessage,
  70                   in nsISOAPResponseListener aListener);
  71 };
  72
  73 %{C++
  74 #define NS_SOAPJSSERVICE_CID                            \
  75 { /* 26a41df2-1dd2-11b2-9f29-909e637afa0e */        \
  76   0x26a41df2, 0x1dd2, 0x11b2,                       \
  77  {0x9f, 0x29, 0x90, 0x9e, 0x63, 0x7a, 0xfa, 0x0e} }
  78 #define NS_SOAPJSSERVICE_CONTRACTID \
  79 "@mozilla.org/xmlextras/soap/jsservice;1"
  80 %}