Back to index

lightning-sunbird  0.9+nobinonly
nsISOAPEncoding.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
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.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsISupports.idl"
00039 
00040 interface nsISchemaType;
00041 interface nsIDOMElement;
00042 interface nsISOAPEncoder;
00043 interface nsISOAPDecoder;
00044 interface nsISOAPMessage;
00045 interface nsIVariant;
00046 interface nsISOAPAttachments;
00047 interface nsISchemaCollection;
00048 interface nsISOAPEncoding;
00049 
00054 [scriptable, uuid(9fe91a61-3048-40e3-99ef-e39ab946ae0b)]
00055 interface nsISOAPEncodingRegistry : nsISupports {
00073   nsISOAPEncoding getAssociatedEncoding(in AString aStyleURI,
00074                                         in boolean aCreateIf);
00075 
00080   attribute nsISchemaCollection schemaCollection;
00081 };
00082 
00083 
00099 [scriptable, uuid(9ae49600-1dd1-11b2-877f-e62f620c5e92)]
00100 interface nsISOAPEncoding : nsISupports {
00101 
00105   readonly attribute AString styleURI;
00106 
00124   nsISOAPEncoding getAssociatedEncoding(in AString aStyleURI,
00125                                         in boolean aCreateIf);
00126 
00135   void setEncoder(in AString aKey, in nsISOAPEncoder aEncoder);
00136 
00144   nsISOAPEncoder getEncoder(in AString aKey);
00145 
00154   void setDecoder(in AString aKey, in nsISOAPDecoder aDecoder);
00155 
00163   nsISOAPDecoder getDecoder(in AString aKey);
00164 
00171   attribute nsISOAPEncoder defaultEncoder;
00172 
00179   attribute nsISOAPDecoder defaultDecoder;
00180 
00184   attribute nsISchemaCollection schemaCollection;
00185 
00207   nsIDOMElement encode(in nsIVariant aSource,
00208                        in AString aNamespaceURI,
00209                        in AString aName,
00210                        in nsISchemaType aSchemaType,
00211                        in nsISOAPAttachments aAttachments,
00212                        in nsIDOMElement aDestination);
00213 
00230   nsIVariant decode(in nsIDOMElement aSource,
00231                     in nsISchemaType aSchemaType,
00232                     in nsISOAPAttachments aAttachments);
00251   boolean mapSchemaURI(in AString aExternalURI,
00252                     in AString aInternalURI,
00253                     in boolean aOutput);
00254 
00264   boolean unmapSchemaURI(in AString aExternalURI);
00265 
00275   AString getInternalSchemaURI(in AString aExternalURI);
00276 
00286   AString getExternalSchemaURI(in AString aInternalURI);
00287 
00288 };
00289 
00290 %{C++
00291 #define NS_SOAPENCODING_CID                            \
00292 { /* db612ec6-1dd1-11b2-a8bc-e6777bf70a30 */        \
00293   0xdb612ec6, 0x1dd1, 0x11b2,                       \
00294  {0xa8, 0xbc, 0xe6, 0x77, 0x7b, 0xf7, 0x0a, 0x30} }
00295 #define NS_SOAPENCODING_CONTRACTID \
00296 "@mozilla.org/xmlextras/soap/encoding;1"
00297 #define NS_SOAPENCODING_CONTRACTID_PREFIX \
00298 NS_SOAPENCODING_CONTRACTID "?uri="
00299 #define NS_DEFAULTSOAPENCODING_1_1_CID                            \
00300 { /* 06fb035c-1dd2-11b2-bc30-f6d8e314d6b9 */        \
00301   0x06fb035c, 0x1dd2, 0x11b2,                       \
00302  {0xbc, 0x30, 0xf6, 0xd8, 0xe3, 0x14, 0xd6, 0xb9} }
00303 #define NS_DEFAULTSOAPENCODING_1_1_CONTRACTID \
00304 NS_SOAPENCODING_CONTRACTID_PREFIX "http://schemas.xmlsoap.org/soap/encoding/"
00305 #define NS_DEFAULTSOAPENCODING_1_2_CID                            \
00306 { /* e0ee4044-1dd1-11b2-9d7e-8899d4d89648 */        \
00307   0xe0ee4044, 0x1dd1, 0x11b2,                       \
00308  {0x9d, 0x7e, 0x88, 0x99, 0xd4, 0xd8, 0x96, 0x48} }
00309 #define NS_DEFAULTSOAPENCODING_1_2_CONTRACTID \
00310 NS_SOAPENCODING_CONTRACTID_PREFIX "http://www.w3.org/2001/09/soap-encoding"
00311 %}