Export (0) Print
Expand All

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)

'Declaration
Public NotInheritable Class SoapClientMessage
	Inherits SoapMessage
'Usage
Dim instance As SoapClientMessage

public final class SoapClientMessage extends SoapMessage
public final class SoapClientMessage extends SoapMessage
Not applicable.

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 Overrides Sub ProcessMessage(message As SoapMessage)
    Select Case message.Stage
       Case SoapMessageStage.BeforeSerialize
       Case SoapMessageStage.AfterSerialize
          WriteOutput(CType(message, SoapClientMessage))
       Case SoapMessageStage.BeforeDeserialize
          WriteInput(CType(message, SoapClientMessage))
       Case SoapMessageStage.AfterDeserialize
       Case Else
             Throw New Exception("invalid stage")
    End Select
 End Sub 'ProcessMessage
 
 
 ' Write the contents of the outgoing SOAP message to the log file.
 Public Sub WriteOutput(message As SoapClientMessage)
    newStream.Position = 0
    Dim myFileStream As New FileStream(filename, FileMode.Append, _
       FileAccess.Write)
    Dim myStreamWriter As 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(ControlChars.Tab & 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(GetType(MathSvc)) Then
       myStreamWriter.WriteLine(ControlChars.Tab & "MathSvc")
    End If

   ' 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(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 method.
    myStreamWriter.WriteLine( _
       "The url of the XML Web service method that has been requested is: ")
    myStreamWriter.WriteLine(ControlChars.Tab & message.Url)
    myStreamWriter.WriteLine("The contents of the SOAP envelope are: ")
    myStreamWriter.Flush()

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

    ' Copy the contents of one stream to another. 
    Copy(newStream, oldStream)
End Sub 'WriteOutput

// Process the SOAP message received and write to a log file.
public void ProcessMessage(SoapMessage message) throws Exception
{
    switch (message.get_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");
    }
} //ProcessMessage

// Write the contents of the outgoing SOAP message to the log file.
public void WriteOutput(SoapClientMessage message)
{
    newStream.set_Position(0);
    FileStream myFileStream = new FileStream(fileName, FileMode.Append, 
        FileAccess.Write);
    StreamWriter myStreamWriter = new StreamWriter(myFileStream);
    myStreamWriter.WriteLine("================================== "
        + "Request at " + DateTime.get_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.get_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.get_Client().GetType().Equals(MathSvc.class.ToType())) {
        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.get_MethodInfo().get_Name());
    // Print to the log file if the method invoked is OneWay.
    if (message.get_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.get_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.set_Position(0);
    // Copy the contents of one stream to another. 
    Copy(newStream, oldStream);
} //WriteOutput

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 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft