SoapServerMessage

.NET Framework クラス ライブラリ リファレンス

SoapServerMessage クラス

特定の SoapMessageStage で XML Web サービス メソッドが受信した SOAP 要求または送信した SOAP 応答のデータを表します。このクラスは継承できません。

名前空間: System.Web.Services.Protocols
アセンブリ: System.Web.Services (system.web.services.dll 内)
構文

Visual Basic (宣言)

Public NotInheritable Class
 SoapServerMessage
    Inherits SoapMessage

Visual Basic (使用法)

Dim instance As SoapServerMessage

C#

public sealed class SoapServerMessage : SoapMessage

C++

public ref class SoapServerMessage sealed :
 public SoapMessage

J#

public final class SoapServerMessage extends
 SoapMessage

JScript

public final class SoapServerMessage extends
 SoapMessage

使用例

次のコード片は、XML Web サービス メソッドによって送受信された SOAP メッセージを記録する SOAP 拡張機能の一部です。この特定のフラグメントは、SoapServerMessage のプロパティをログ ファイルに書き込むことにより、SOAP 拡張機能の SoapExtension.ProcessMessage メソッドに渡される SoapServerMessage を処理します。

Visual Basic

' 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

C#

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

// Write the contents of the incoming SOAP message to the log file.
public void WriteInputAfterDeserialize(SoapServerMessage
 message)
{
   FileStream myFileStream = 
      new FileStream(filename, FileMode.Append, FileAccess.Write);
   StreamWriter myStreamWriter = 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("\t" + 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(typeof(MathSvc)))
      myStreamWriter.WriteLine("\tMathSvc");
      
   // Print to the log file the name of the XML Web service method.
   myStreamWriter.WriteLine(
      "The method of the XML Web service method requested:");
   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 XML Web service method.
   myStreamWriter.WriteLine(
      "The URL of the requested XML Web service method: ");
   myStreamWriter.WriteLine("\t" + message.Url);
   myStreamWriter.Flush();
   myStreamWriter.Close();
   myFileStream.Close();
}

継承階層

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

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
SoapServerMessage メンバ
System.Web.Services.Protocols 名前空間

SoapServerMessage プロパティ

パブリック プロパティ

	名前	説明
	Action	オーバーライドされます。 SOAP 要求または SOAP 応答の SOAPAction HTTP 要求ヘッダー フィールドを取得します。
	ContentEncoding	Content-Encoding HTTP ヘッダーの内容を取得または設定します。 ( SoapMessage から継承されます。)
	ContentType	SOAP 要求または SOAP 応答の HTTP Content-Type を取得または設定します。 ( SoapMessage から継承されます。)
	Exception	XML Web サービス メソッドの呼び出しから SoapException を取得します。 ( SoapMessage から継承されます。)
	Headers	現在の SOAP 要求または SOAP 応答に適用される SOAP ヘッダーのコレクション。 ( SoapMessage から継承されます。)
	MethodInfo	オーバーライドされます。 SOAP 要求の対象となる XML Web サービス メソッドのメソッド プロトタイプの表示を取得します。
	OneWay	オーバーライドされます。 サーバーによる XML Web サービス メソッドの処理が完了するまでクライアントが待機するかどうかを示す値を取得します。
	Server	Web サーバーのメソッド呼び出しを処理しているクラスのインスタンスを取得します。
	SoapVersion	オーバーライドされます。 XML Web サービスとの通信に使用する SOAP プロトコルのバージョンを取得します。
	Stage	SoapMessage の SoapMessageStage を取得します。 ( SoapMessage から継承されます。)
	Stream	Stream の形式で SOAP 要求または SOAP 応答を表しているデータを取得します。 ( SoapMessage から継承されます。)
	Url	オーバーライドされます。 XML Web サービスのベース URL を取得します。

参照

関連項目

SoapServerMessage クラス
System.Web.Services.Protocols 名前空間

SoapServerMessage メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetInParameterValue	指定されたインデックスで XML Web サービス メソッドに渡すパラメータを取得します。 ( SoapMessage から継承されます。)
	GetOutParameterValue	指定したインデックスで XML Web サービス メソッドに渡す out パラメータを取得します。 ( SoapMessage から継承されます。)
	GetReturnValue	XML Web サービス メソッドの戻り値を取得します。 ( SoapMessage から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

SoapServerMessage クラス
System.Web.Services.Protocols 名前空間

SoapServerMessage メンバ

特定の SoapMessageStage で XML Web サービス メソッドが受信した SOAP 要求または送信した SOAP 応答のデータを表します。このクラスは継承できません。

SoapServerMessage データ型で公開されるメンバを以下の表に示します。

パブリック プロパティ

	名前	説明
	Action	オーバーライドされます。 SOAP 要求または SOAP 応答の SOAPAction HTTP 要求ヘッダー フィールドを取得します。
	ContentEncoding	Content-Encoding HTTP ヘッダーの内容を取得または設定します。(SoapMessage から継承されます。)
	ContentType	SOAP 要求または SOAP 応答の HTTP Content-Type を取得または設定します。(SoapMessage から継承されます。)
	Exception	XML Web サービス メソッドの呼び出しから SoapException を取得します。(SoapMessage から継承されます。)
	Headers	現在の SOAP 要求または SOAP 応答に適用される SOAP ヘッダーのコレクション。(SoapMessage から継承されます。)
	MethodInfo	オーバーライドされます。 SOAP 要求の対象となる XML Web サービス メソッドのメソッド プロトタイプの表示を取得します。
	OneWay	オーバーライドされます。 サーバーによる XML Web サービス メソッドの処理が完了するまでクライアントが待機するかどうかを示す値を取得します。
	Server	Web サーバーのメソッド呼び出しを処理しているクラスのインスタンスを取得します。
	SoapVersion	オーバーライドされます。 XML Web サービスとの通信に使用する SOAP プロトコルのバージョンを取得します。
	Stage	SoapMessage の SoapMessageStage を取得します。(SoapMessage から継承されます。)
	Stream	Stream の形式で SOAP 要求または SOAP 応答を表しているデータを取得します。(SoapMessage から継承されます。)
	Url	オーバーライドされます。 XML Web サービスのベース URL を取得します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetInParameterValue	指定されたインデックスで XML Web サービス メソッドに渡すパラメータを取得します。 (SoapMessage から継承されます。)
	GetOutParameterValue	指定したインデックスで XML Web サービス メソッドに渡す out パラメータを取得します。 (SoapMessage から継承されます。)
	GetReturnValue	XML Web サービス メソッドの戻り値を取得します。 (SoapMessage から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

SoapServerMessage クラス
System.Web.Services.Protocols 名前空間