XmlResolver.GetEntity メソッドとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

XmlResolver.GetEntity メソッド

派生クラスでオーバーライドされると、URI を実際のリソースを格納しているオブジェクトに割り当てます。

名前空間: System.Xml
アセンブリ: System.Xml (system.xml.dll 内)
構文

Visual Basic (宣言)

Public MustOverride Function
 GetEntity ( _
    absoluteUri As Uri, _
    role As String, _
    ofObjectToReturn As Type _
) As Object

Visual Basic (使用法)

Dim instance As XmlResolver
Dim absoluteUri As Uri
Dim role As String
Dim ofObjectToReturn As Type
Dim returnValue As Object

returnValue = instance.GetEntity(absoluteUri, role, ofObjectToReturn)

public abstract Object GetEntity (
    Uri absoluteUri,
    string role,
    Type ofObjectToReturn
)

C++

public:
virtual Object^ GetEntity (
    Uri^ absoluteUri, 
    String^ role, 
    Type^ ofObjectToReturn
) abstract

public abstract Object GetEntity (
    Uri absoluteUri, 
    String role, 
    Type ofObjectToReturn
)

JScript

public abstract function GetEntity (
    absoluteUri : Uri, 
    role : String, 
    ofObjectToReturn : Type
) : Object

パラメータ

absoluteUri: ResolveUri から返された URI。

role: 現在のバージョンでは、URI を解決するときにこのパラメータを使用しません。このパラメータは、将来の拡張のために提供されています。たとえば、このパラメータを xlink:role に割り当てて、他のシナリオで実装固有の引数として使用できます。

ofObjectToReturn: 返すオブジェクトの型。現在のバージョンでは、System.IO.Stream オブジェクトだけを返します。

戻り値
System.IO.Stream オブジェクト。ストリーム以外の型が指定された場合は null 参照 (Visual Basic では Nothing)。

例外

例外の種類	条件
XmlException	ofObjectToReturn が null 参照 (Visual Basic では Nothing) でも Stream 型でもありません。
UriFormatException	指定した URI が絶対 URI ではありません。
NullReferenceException	absoluteUri が null 参照 (Visual Basic では Nothing) です。
Exception	ランタイムエラー (サーバー接続の中断など) があります。

解説

このメソッドは、呼び出し元が、指定した URI が表す実際のリソースを格納しているオブジェクトにその URI を割り当てる場合に使用されます。返されるオブジェクトの型はネゴシエート可能ですが、実装は必ず System.IO.Stream をサポートしている必要があります。

セキュリティに関するメモ
GetEntity メソッドでは、メモリの飽和をねらった DoS 攻撃が懸念されます。ラッピング実装された IStream をアプリケーションで実装し、読み取るバイト数を制限することにより、このような脅威を緩和できます。これにより、膨大なバイトストリームを GetEntity メソッドに渡すような悪質なコードに備えることができます。