SoapClientMessage Klasse

Definition

Namespace:
System.Web.Services.Protocols
Assembly:
System.Web.Services.dll

Stellt die Daten in einer SOAP-Anforderung dar, die von einem XML-Webdienstclient an einem bestimmten SoapMessageStageClient empfangen wurde. Diese Klasse kann nicht vererbt werden.

public ref class SoapClientMessage sealed : System::Web::Services::Protocols::SoapMessage
public sealed class SoapClientMessage : System.Web.Services.Protocols.SoapMessage
type SoapClientMessage = class
    inherit SoapMessage
Public NotInheritable Class SoapClientMessage
Inherits SoapMessage
Vererbung
Object
SoapMessage
SoapClientMessage

Beispiele

Das folgende Codefragment ist Teil einer SOAP-Erweiterung, die die SOAP-Nachrichten protokolliert, die von einem XML-Webdienstclient gesendet und empfangen werden. Dieses spezifische Fragment verarbeitet die SoapClientMessage an die SoapExtension.ProcessMessage Methode der SOAP-Erweiterung übergebene Datei durch Schreiben von Eigenschaften der SoapClientMessage Protokolldatei.

// Process the SOAP message received and write to a log file.
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 gcnew Exception( "invalid stage" );
   }
}

// Write the contents of the outgoing SOAP message to the log file.
void WriteOutput( SoapClientMessage^ message )
{
   newStream->Position = 0;
   FileStream^ myFileStream = gcnew FileStream( filename, FileMode::Append,
      FileAccess::Write );
   StreamWriter^ myStreamWriter = gcnew StreamWriter( myFileStream );
   myStreamWriter->WriteLine(
      "================================== Request at {0}", 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{0}", 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( typeid<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{0}", 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{0}", 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 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 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
 
 
 ' 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

Eigenschaften

Name Beschreibung
Action

Ruft das SOAPAction HTTP-Anforderungsheaderfeld für die SOAP-Anforderung oder SOAP-Antwort ab.
Client

Ruft eine Instanz der Clientproxyklasse ab, die von SoapHttpClientProtocol.
ContentEncoding

Dient zum Abrufen oder Festlegen des Inhalts des Content-Encoding HTTP-Headers.

(Geerbt von SoapMessage)
ContentType

Dient zum Abrufen oder Festlegen des HTTP Content-Type der SOAP-Anforderung oder SOAP-Antwort.

(Geerbt von SoapMessage)
Exception

Ruft den SoapException Aufruf der XML-Webdienstmethode ab.

(Geerbt von SoapMessage)
Headers

Eine Auflistung der SOAP-Header, die auf die aktuelle SOAP-Anforderung oder SOAP-Antwort angewendet werden.

(Geerbt von SoapMessage)
MethodInfo

Ruft eine Darstellung des Methodenprototyps der XML-Webdienstmethode ab, für die die SOAP-Anforderung vorgesehen ist.
OneWay

Ruft einen Wert ab, der angibt, ob der Client wartet, bis der Server die Verarbeitung einer XML-Webdienstmethode abgeschlossen hat.
SoapVersion

Ruft die Version des SOAP-Protokolls ab, das für die Kommunikation mit dem XML-Webdienst verwendet wird.
Stage

Ruft den SoapMessageStage der .SoapMessage

(Geerbt von SoapMessage)
Stream

Ruft die Daten ab, die die SOAP-Anforderung oder SOAP-Antwort in Form einer Stream.

(Geerbt von SoapMessage)
Url

Ruft die URL des XML-Webdiensts ab.

Methoden

Name Beschreibung
EnsureInStage()

Wenn eine abgeleitete Klasse außer Kraft gesetzt wird, wird bestätigt, dass es sich bei der aktuellen SoapMessageStage Phase um eine Phase handelt, in der parameter verfügbar sind.

(Geerbt von SoapMessage)
EnsureOutStage()

Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird bestätigt, dass die aktuelle SoapMessageStage Stufe eine Phase ist, in der Ausgabeparameter verfügbar sind.

(Geerbt von SoapMessage)
EnsureStage(SoapMessageStage)

Stellt sicher, dass der SoapMessageStage Aufruf der XML-Webdienstmethode die Phase oder Phasen ist, die übergeben werden. Wenn die aktuelle Verarbeitungsphase keine der übergebenen Phasen ist, wird eine Ausnahme ausgelöst.

(Geerbt von SoapMessage)
Equals(Object)

Bestimmt, ob das angegebene Objekt dem aktuellen Objekt entspricht.

(Geerbt von Object)
GetHashCode()

Dient als Standardhashfunktion.

(Geerbt von Object)
GetInParameterValue(Int32)

Ruft den Parameter ab, der an die XML-Webdienstmethode am angegebenen Index übergeben wird.

(Geerbt von SoapMessage)
GetOutParameterValue(Int32)

Ruft den out-Parameter ab, der an die XML-Webdienstmethode am angegebenen Index übergeben wird.

(Geerbt von SoapMessage)
GetReturnValue()

Ruft den Rückgabewert einer XML-Webdienstmethode ab.

(Geerbt von SoapMessage)
GetType()

Ruft die Type der aktuellen Instanz ab.

(Geerbt von Object)
MemberwiseClone()

Erstellt eine flache Kopie der aktuellen Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.

(Geerbt von Object)

Gilt für: