Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

SoapClientMessage Class

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

Namespace:  System.Web.Services.Protocols
Assembly:  System.Web.Services (in System.Web.Services.dll)
public sealed class SoapClientMessage : SoapMessage

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

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

// Write the contents of the outgoing SOAP message to the log file. 
public void WriteOutput(SoapClientMessage message)
{
   newStream.Position = 0;
   FileStream myFileStream = new FileStream(filename, FileMode.Append,
      FileAccess.Write);
   StreamWriter myStreamWriter = new StreamWriter(myFileStream);
   myStreamWriter.WriteLine(
      "================================== Request at "
      + DateTime.Now);

   // Print to the log file the request header field for SoapAction header.
   myStreamWriter.WriteLine("The SoapAction Http request header field is: ");
   myStreamWriter.WriteLine("\t" + message.Action);

   // Print to the log file the type of the client that invoked  
   // the XML Web service method.
   myStreamWriter.WriteLine("The type of the client is: ");
   if((message.Client.GetType()).Equals(typeof(MathSvc)))
      myStreamWriter.WriteLine("\tMathSvc");

   // Print to the log file the method invoked by the client.
   myStreamWriter.WriteLine(
      "The method that has been invoked by the client is:");
   myStreamWriter.WriteLine("\t" + message.MethodInfo.Name);

   // Print to the log file if the method invoked is OneWay. 
   if(message.OneWay)
      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");

   // Print to the log file the URL of the site that provides  
   // implementation of the method.
   myStreamWriter.WriteLine(
      "The URL of the XML Web service method that has been requested is: ");
   myStreamWriter.WriteLine("\t" + message.Url);
   myStreamWriter.WriteLine("The contents of the SOAP envelope are: ");
   myStreamWriter.Flush();

   // Copy the contents of one stream to another. 
   Copy(newStream, myFileStream);
   myFileStream.Close();
   newStream.Position = 0;

   // Copy the contents of one stream to another. 
   Copy(newStream, oldStream);
}
   // Process the SOAP message received and write to a log file.
public:
   void ProcessMessage(SoapMessage* message) 
   {
      switch (message->Stage) 
      {
      case SoapMessageStage::BeforeSerialize:
         break;
      case SoapMessageStage::AfterSerialize:
         WriteOutput(dynamic_cast<SoapClientMessage*>(message));
         break;
      case SoapMessageStage::BeforeDeserialize:
         WriteInput(dynamic_cast<SoapClientMessage*>(message));
         break;
      case SoapMessageStage::AfterDeserialize:
         break;
      default:
         throw new Exception(S"invalid stage");
      }
   }

   // Write the contents of the outgoing SOAP message to the log file.
   void WriteOutput(SoapClientMessage* message)
   {
      newStream->Position = 0;
      FileStream* myFileStream = new FileStream(filename, FileMode::Append,
         FileAccess::Write);
      StreamWriter* myStreamWriter = new StreamWriter(myFileStream);
      myStreamWriter->WriteLine(
         S"================================== Request at {0}",__box(DateTime::Now));

      // Print to the log file the request header field for SoapAction header.
      myStreamWriter->WriteLine(S"The SoapAction Http request header field is: ");
      myStreamWriter->WriteLine(S"\t{0}", message->Action);

      // Print to the log file the type of the client that invoked 
      // the XML Web service method.
      myStreamWriter->WriteLine(S"The type of the client is: ");
      if((message->Client->GetType())->Equals(__typeof(MathSvc)))
         myStreamWriter->WriteLine(S"\tMathSvc");

      // Print to the log file the method invoked by the client.
      myStreamWriter->WriteLine(
         S"The method that has been invoked by the client is:");
      myStreamWriter->WriteLine(S"\t{0}", message->MethodInfo->Name);

      // Print to the log file if the method invoked is OneWay.
      if(message->OneWay)
         myStreamWriter->WriteLine(
         S"The client doesn't wait for the server to finish processing");
      else
         myStreamWriter->WriteLine(
         S"The client waits for the server to finish processing");

      // Print to the log file the URL of the site that provides 
      // implementation of the method.
      myStreamWriter->WriteLine(
         S"The URL of the XML Web service method that has been requested is: ");
      myStreamWriter->WriteLine(S"\t{0}", message->Url);
      myStreamWriter->WriteLine(S"The contents of the SOAP envelope are: ");
      myStreamWriter->Flush();

      // Copy the contents of one stream to another. 
      Copy(newStream, myFileStream);
      myFileStream->Close();
      newStream->Position = 0;

      // Copy the contents of one stream to another. 
      Copy(newStream, oldStream);
   }
System.Object
  System.Web.Services.Protocols.SoapMessage
    System.Web.Services.Protocols.SoapClientMessage
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, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft. All rights reserved.