This documentation is archived and is not being maintained.

SoapServerMessage Class

Represents the data in a SOAP request received or a SOAP response sent by an XML Web service method at a specific SoapMessageStage. This class cannot be inherited.

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

'Declaration
Public NotInheritable Class SoapServerMessage _
	Inherits SoapMessage
'Usage
Dim instance As SoapServerMessage

The following code fragment is part of a SOAP extension that logs the SOAP messages sent and received by an XML Web service method. This specific fragment processes the SoapServerMessage passed into the SoapExtension.ProcessMessage method of the SOAP extension by writing properties of the SoapServerMessage to the log file.

' Process the SOAP message received and write it to a log file. 
Public Overrides Sub ProcessMessage(message As SoapMessage)
   Select Case message.Stage
      Case SoapMessageStage.BeforeSerialize
      Case SoapMessageStage.AfterSerialize
         WriteOutput(CType(message, SoapServerMessage))
      Case SoapMessageStage.BeforeDeserialize
         WriteInputBeforeDeserialize(CType(message, SoapServerMessage))
      Case SoapMessageStage.AfterDeserialize
         WriteInputAfterDeserialize(CType(message, SoapServerMessage))
      Case Else 
            Throw New Exception("invalid stage")
   End Select 
End Sub 'ProcessMessage


' Write the contents of the incoming SOAP message to the log file. 
Public Sub WriteInputAfterDeserialize(message As SoapServerMessage)
   Dim myFileStream As New FileStream(filename, FileMode.Append, FileAccess.Write)
   Dim myStreamWriter As New StreamWriter(myFileStream)

   ' Print to the log file the request header field for SoapAction header.
   myStreamWriter.WriteLine("The SoapAction Http request header field is: ")
   myStreamWriter.WriteLine((ControlChars.Tab + message.Action))

   ' Print to the log file the type of the XML Web service.
   myStreamWriter.WriteLine("The type of the XML Web service is: ")
   If message.Server.GetType().Equals(GetType(MathSvc)) Then
      myStreamWriter.WriteLine(ControlChars.Tab + "MathSvc")
   End If 

   ' Print to the log file the name of the XML Web service method.
   myStreamWriter.WriteLine("The name of the XML Web service method requested:")
   myStreamWriter.WriteLine((ControlChars.Tab + message.MethodInfo.Name))

   ' Print to the log file if the method invoked is OneWay. 
   If message.OneWay Then
      myStreamWriter.WriteLine( _
         "The client doesn't wait for the server to finish processing")
   Else
      myStreamWriter.WriteLine( _
         "The client waits for the server to finish processing")
   End If  

   ' Print to the log file the URL of the site that provides  
   ' implementation of the XML Web service method.
   myStreamWriter.WriteLine( _
      "The url of the XML Web service method requested: ")
   myStreamWriter.WriteLine((ControlChars.Tab + message.Url))
   myStreamWriter.Flush()
   myStreamWriter.Close()
   myFileStream.Close()
End Sub 'WriteInputAfterDeserialize

System.Object
  System.Web.Services.Protocols.SoapMessage
    System.Web.Services.Protocols.SoapServerMessage

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: