mcs/class/System.Web.Services/System.Web.Services.Protocols/SoapMessage.cs

   1 //
   2 // System.Web.Services.Protocols.SoapMessage.cs
   3 //
   4 // Author:
   5 //   Tim Coleman (tim@timcoleman.com)
   6 //   Lluis Sanchez Gual (lluis@ximian.com)
   7 //
   8 // Copyright (C) Tim Coleman, 2002
   9 //
  10
  11 //
  12 // Permission is hereby granted, free of charge, to any person obtaining
  13 // a copy of this software and associated documentation files (the
  14 // "Software"), to deal in the Software without restriction, including
  15 // without limitation the rights to use, copy, modify, merge, publish,
  16 // distribute, sublicense, and/or sell copies of the Software, and to
  17 // permit persons to whom the Software is furnished to do so, subject to
  18 // the following conditions:
  19 //
  20 // The above copyright notice and this permission notice shall be
  21 // included in all copies or substantial portions of the Software.
  22 //
  23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  27 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  28 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  29 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  30 //
  31
  32 using System.IO;
  33 using System.Web.Services;
  34
  35 namespace System.Web.Services.Protocols {
  36         public abstract class SoapMessage {
  37
  38                 #region Fields
  39
  40                 string content_type = "text/xml";
  41                 string content_encoding;
  42                 SoapException exception = null;
  43                 SoapHeaderCollection headers;
  44                 SoapMessageStage stage;
  45                 Stream stream;
  46                 object[] inParameters;
  47                 object[] outParameters;
  48
  49 #if NET_2_0
  50                 SoapProtocolVersion soapVersion;
  51 #endif
  52
  53                 #endregion // Fields
  54
  55                 #region Constructors
  56
  57                 internal SoapMessage ()
  58                 {
  59                         headers = new SoapHeaderCollection ();
  60                 }
  61
  62                 internal SoapMessage (Stream stream)
  63                 {
  64                         this.stream = stream;
  65                 }
  66
  67                 internal SoapMessage (Stream stream, SoapException exception)
  68                 {
  69                         this.exception = exception;
  70                         this.stream = stream;
  71                         headers = new SoapHeaderCollection ();
  72                 }
  73
  74                 #endregion
  75
  76                 #region Properties
  77
  78                 internal object[] InParameters
  79                 {
  80                         get { return inParameters; }
  81                         set { inParameters = value; }
  82                 }
  83
  84                 internal object[] OutParameters
  85                 {
  86                         get { return outParameters; }
  87                         set { outParameters = value; }
  88                 }
  89
  90                 public abstract string Action
  91                 {
  92                         get;
  93                 }
  94
  95                 public string ContentType {
  96                         get { return content_type; }
  97                         set { content_type = value; }
  98                 }
  99
 100                 public SoapException Exception {
 101                         get { return exception; }
 102 #if NET_2_0
 103                         set { exception = value; }
 104 #endif
 105                 }
 106
 107                 public SoapHeaderCollection Headers {
 108                         get { return headers; }
 109                 }
 110
 111                 public abstract LogicalMethodInfo MethodInfo {
 112                         get;
 113                 }
 114
 115                 public abstract bool OneWay {
 116                         get;
 117                 }
 118
 119                 public SoapMessageStage Stage {
 120                         get { return stage; }
 121                 }
 122
 123                 internal void SetStage (SoapMessageStage stage)
 124                 {
 125                         this.stage = stage;
 126                 }
 127
 128                 public Stream Stream {
 129                         get {
 130                                 return stream;
 131                         }
 132                 }
 133
 134                 public abstract string Url {
 135                         get;
 136                 }
 137
 138 #if NET_1_1
 139                 public string ContentEncoding
 140                 {
 141                         get { return content_encoding; }
 142                         set { content_encoding = value; }
 143                 }
 144 #else
 145                 internal string ContentEncoding
 146                 {
 147                         get { return content_encoding; }
 148                         set { content_encoding = value; }
 149                 }
 150 #endif
 151
 152 #if NET_2_0
 153                 [System.Runtime.InteropServices.ComVisible(false)]
 154                 public virtual SoapProtocolVersion SoapVersion {
 155                         get { return soapVersion; }
 156                 }
 157 #endif
 158
 159                 #endregion Properties
 160
 161                 #region Methods
 162
 163                 protected abstract void EnsureInStage ();
 164                 protected abstract void EnsureOutStage ();
 165
 166                 protected void EnsureStage (SoapMessageStage stage)
 167                 {
 168                         if ((((int) stage) & ((int) Stage)) == 0)
 169                                 throw new InvalidOperationException ("The current SoapMessageStage is not the asserted stage or stages.");
 170                 }
 171
 172                 public object GetInParameterValue (int index)
 173                 {
 174                         return inParameters [index];
 175                 }
 176
 177                 public object GetOutParameterValue (int index)
 178                 {
 179                         if (MethodInfo.IsVoid) return outParameters [index];
 180                         else return outParameters [index + 1];
 181                 }
 182
 183                 public object GetReturnValue ()
 184                 {
 185                         if (!MethodInfo.IsVoid && exception == null) return outParameters [0];
 186                         else return null;
 187                 }
 188
 189                 internal void SetHeaders (SoapHeaderCollection headers)
 190                 {
 191                         this.headers = headers;
 192                 }
 193
 194                 internal void SetException (SoapException ex)
 195                 {
 196                         exception = ex;
 197                 }
 198
 199                 internal void CollectHeaders (object target, HeaderInfo[] headers, SoapHeaderDirection direction)
 200                 {
 201                         Headers.Clear ();
 202                         foreach (HeaderInfo hi in headers)
 203                         {
 204                                 if ((hi.Direction & direction) != 0 && !hi.IsUnknownHeader)
 205                                 {
 206                                         SoapHeader headerVal = hi.GetHeaderValue (target) as SoapHeader;
 207                                         if (headerVal != null)
 208                                                 Headers.Add (headerVal);
 209                                 }
 210                         }
 211                 }
 212
 213                 internal void UpdateHeaderValues (object target, HeaderInfo[] headersInfo)
 214                 {
 215                         foreach (SoapHeader header in Headers)
 216                         {
 217                                 HeaderInfo hinfo = FindHeader (headersInfo, header.GetType ());
 218                                 if (hinfo != null) {
 219                                         hinfo.SetHeaderValue (target, header);
 220                                         header.DidUnderstand = !hinfo.IsUnknownHeader;
 221                                 }
 222                         }
 223                 }
 224
 225                 HeaderInfo FindHeader (HeaderInfo[] headersInfo, Type headerType)
 226                 {
 227                         HeaderInfo unknownHeaderInfo = null;
 228
 229                         foreach (HeaderInfo headerInfo in headersInfo) {
 230                                 if (headerInfo.HeaderType == headerType)
 231                                         return headerInfo;
 232                                 else if (headerInfo.IsUnknownHeader)
 233                                         unknownHeaderInfo = headerInfo;
 234                         }
 235                         return unknownHeaderInfo;
 236                 }
 237
 238                 #endregion // Methods
 239         }
 240 }