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

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

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

XmlUrlResolver.GetEntity メソッド

URI を実際のリソースを含むオブジェクトに割り当てます。

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

Visual Basic (宣言)

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

Visual Basic (使用法)

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

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

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

C++

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

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

JScript

public override 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 を割り当てるとき、このメソッドが使用されます。

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

セキュリティに関するメモ

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

使用例

GetEntity メソッドと ResolveUri メソッドの例を次に示します。

Visual Basic

Imports System
Imports System.IO
Imports System.Xml

Public Class Sample
    
  Public Shared Sub Main()

     Dim resolver As New
 XmlUrlResolver()
     Dim baseUri As New
 Uri("http://servername/tmp/test.xsl")
     Dim fulluri As Uri = resolver.ResolveUri(baseUri,
 "includefile.xsl")
            
     ' Get a stream object containing the XSL file
     Dim s As Stream = CType(resolver.GetEntity(fulluri,
 Nothing, GetType(Stream)), Stream)
            
     ' Read the stream object displaying the contents of the XSL file
     Dim reader As New XmlTextReader(s)
     While reader.Read()
        Console.WriteLine(reader.ReadOuterXml())
     End While
        
  End Sub 'New 
End Class 'Sample

using System;
using System.IO;
using System.Xml;
 
 public class Sample
 {
          
   public static void Main()
   {
       XmlUrlResolver resolver = new XmlUrlResolver();
 
       Uri baseUri = new Uri ("http://servername/tmp/test.xsl");
 
       Uri fulluri=resolver.ResolveUri(baseUri, "includefile.xsl");
 
       // Get a stream object containing the XSL file
       Stream s=(Stream)resolver.GetEntity(fulluri, null, typeof(Stream));
 
       // Read the stream object displaying the contents of the XSL
 file
       XmlTextReader reader = new XmlTextReader(s);
       while (reader.Read()) 
       {
          Console.WriteLine(reader.ReadOuterXml());
       } 
   }
}

C++

#using <System.dll>
#using <System.Xml.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml;

int main()
{
   XmlUrlResolver^ resolver = gcnew XmlUrlResolver;
   Uri^ baseUri = gcnew Uri( "http://servername/tmp/test.xsl"
 );
   Uri^ fulluri = resolver->ResolveUri( baseUri, "includefile.xsl" );

   // Get a stream object containing the XSL file
   Stream^ s = dynamic_cast<Stream^>(resolver->GetEntity( fulluri, nullptr,
 Stream::typeid ));

   // Read the stream object displaying the contents of the XSL file
   XmlTextReader^ reader = gcnew XmlTextReader( s );
   while ( reader->Read() )
   {
      Console::WriteLine( reader->ReadOuterXml() );
   }
}

import System.*;
import System.IO.*;
import System.Xml.*;

public class Sample
{    
    public static void main(String[]
 args)
    {
        XmlUrlResolver resolver =  new XmlUrlResolver();
        Uri baseUri =  new Uri("http://servername/tmp/test.xsl");
        Uri fullUri = resolver.ResolveUri(baseUri, "includefile.xsl");

        // Get a stream object containing the XSL file
        Stream s = ((Stream)(resolver.GetEntity(fullUri, null
,
            Stream.class.ToType())));

        // Read the stream object displaying the contents of the XSL
 file
        XmlTextReader reader =  new XmlTextReader(s);
        while(reader.Read()) {
            Console.WriteLine(reader.ReadOuterXml());
        }
    } //main
} //Sample