SoapMessage Class

Represents the data in a SOAP request or SOAP response at a specific SoapMessageStage.

Namespace:  System.Web.Services.Protocols
Assembly:  System.Web.Services (in System.Web.Services.dll)

[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
public abstract class SoapMessage

The SoapMessage type exposes the following members.

  NameDescription
Public propertyActionWhen overridden in a derived class, gets the SOAPAction HTTP request header field for the SOAP request or SOAP response.
Public propertyContentEncodingGets or sets the contents of the Content-Encoding HTTP header.
Public propertyContentTypeGets or sets the HTTP Content-Type of the SOAP request or SOAP response.
Public propertyExceptionGets the SoapException from the call to the XML Web service method.
Public propertyHeadersA collection of the SOAP headers applied to the current SOAP request or SOAP response.
Public propertyMethodInfoWhen overridden in a derived class, gets a representation of the method prototype for the XML Web service method for which the SOAP request is intended.
Public propertyOneWayGets a value indicating the SoapDocumentMethodAttribute.OneWay property of either the SoapDocumentMethodAttribute or the SoapRpcMethodAttribute attribute applied to the XML Web service method.
Public propertySoapVersionGets the version of the SOAP protocol used to communicate with the XML Web service.
Public propertyStageGets the SoapMessageStage of the SoapMessage.
Public propertyStreamGets the data representing the SOAP request or SOAP response in the form of a Stream.
Public propertyUrlWhen overridden in a derived class, gets the base URL of the XML Web service.
Top

  NameDescription
Protected methodEnsureInStageWhen overridden in a derived class, asserts that the current SoapMessageStage is a stage where in parameters are available.
Protected methodEnsureOutStageWhen overridden in a derived class, asserts that the current SoapMessageStage stage is a stage where out parameters are available.
Protected methodEnsureStageEnsures that the SoapMessageStage of the call to the XML Web service method is the stage or stages passed in. If the current processing stage is not one of the stages passed in, an exception is thrown.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetInParameterValueGets the parameter passed into the XML Web service method at the specified index.
Public methodGetOutParameterValueGets the out parameter passed into the XML Web service method at the specified index.
Public methodGetReturnValueGets the return value of an XML Web service method.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The primary use of the SoapMessage class is for SOAP extensions, representing the data in a SOAP request or SOAP response. When the ProcessMessage method is called, a SoapExtension receives a SoapMessage at each SoapMessageStage. It is up to the particular SOAP extension to choose how to process the SoapMessage. Common SOAP extensions include encryption and compression.

SOAP extensions can be applied to either or both an XML Web service method created using ASP.NET or an XML Web service client. When a SOAP extension is applied to an XML Web service method, the ProcessMessage method receives an instance of SoapServerMessage, which derives from SoapMessage. Likewise, when a SOAP extension is applied to an XML Web service client, ProcessMessage receives an instance of SoapClientMessage.

   // Process the SOAP message received and write to log file. 
   public override void ProcessMessage(SoapMessage message) 
   {
      switch (message.Stage) 
      {
         case SoapMessageStage.BeforeSerialize:
            WriteOutputBeforeSerialize(message);
            break;
         case SoapMessageStage.AfterSerialize:
            WriteOutputAfterSerialize(message);
            break;
         case SoapMessageStage.BeforeDeserialize:
            WriteInputBeforeDeserialize(message);
            break;
         case SoapMessageStage.AfterDeserialize:
            WriteInputAfterDeserialize(message);
            break;
         default:
            throw new Exception("invalid stage");
      }
   }

   // Write the contents of the outgoing SOAP message to the log file. 
   public void WriteOutputBeforeSerialize(SoapMessage message)
   {
      FileStream myFileStream = 
         new FileStream(filename, FileMode.Append, FileAccess.Write);
      StreamWriter myStreamWriter = new StreamWriter(myFileStream);
      myStreamWriter.WriteLine("================================== Request at "
         + DateTime.Now);
      myStreamWriter.WriteLine("The method that has been invoked is: ");
      myStreamWriter.WriteLine("\t" + message.MethodInfo);
      myStreamWriter.WriteLine(
         "The contents of the SOAPAction HTTP header is:");
      myStreamWriter.WriteLine("\t" + message.Action);
      myStreamWriter.WriteLine("The contents of HTTP Content-type header is:");
      myStreamWriter.WriteLine("\t" + message.ContentType);
      if(message.OneWay)
         myStreamWriter.WriteLine(
            "The method invoked on the client shall not wait"
            + " till the server finishes");
      else
         myStreamWriter.WriteLine(
            "The method invoked on the client shall wait"
            + " till the server finishes");
      myStreamWriter.WriteLine(
         "The site where the XML Web service is available is:");
      myStreamWriter.WriteLine("\t" + message.Url);
      myStreamWriter.WriteLine("The values of the in parameters are:");
      myStreamWriter.WriteLine("Value of first in parameter: {0}",
         message.GetInParameterValue(0));
      myStreamWriter.WriteLine("Value of second in parameter: {0}",
         message.GetInParameterValue(1));
      myStreamWriter.WriteLine();
      myStreamWriter.Flush();
      myStreamWriter.Close();
      myFileStream.Close();
   }

   // Write the contents of the incoming SOAP message to the log file. 
   public void WriteInputAfterDeserialize(SoapMessage message)
   {
      FileStream myFileStream = 
         new FileStream(filename, FileMode.Append, FileAccess.Write);
      StreamWriter myStreamWriter = new StreamWriter(myFileStream);
      myStreamWriter.WriteLine();
      myStreamWriter.WriteLine("The values of the out parameter are:");
      myStreamWriter.WriteLine("The value of the out parameter is: {0}",
         message.GetOutParameterValue(0));
      myStreamWriter.WriteLine("The values of the return parameter are:");
      myStreamWriter.WriteLine("The value of the return parameter is: {0}",
         message.GetReturnValue());
      myStreamWriter.Flush();
      myStreamWriter.Close();
      myFileStream.Close();
   }

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft