カスタムファイルシステムプロバイダの開発
はじめに
Java SE 7 リリースで導入された NIO.2 API は、ファイルシステムオブジェクトを管理するために使用できるカスタムファイルシステムプロバイダを開発する機能を提供します。ファイルシステムは、基本的にファイルシステムオブジェクトと呼ばれる組織化された同種の要素を含むコンテナです。ファイルシステムは、ファイルシステムオブジェクトへのアクセスを提供します。ファイルシステムオブジェクトは、ファイルストア、ファイル、またはディレクトリです。ファイルストアは、ファイルが格納されるボリュームまたはパーティションです。たとえば、Windows プラットフォーム上などのネイティブファイルシステムでは、よく知られている c: や d: などのドライブがファイルストアです。Solaris オペレーティングシステムでは、/ (ルート) およびマウントされたディレクトリがファイルストアと見なされます。
java.nio.file.spi.FileSystemProvider クラスを使用すると、カスタムファイルシステムプロバイダを開発できます。カスタムファイルシステムプロバイダは、次のような状況で使用できます。
- メモリーベースまたは Zip ファイルベースのファイルシステムの開発
- 障害許容性を備えた分散ファイルシステムの開発
- デフォルトのファイルシステムプロバイダの置き換えまたは補完。カスタムプロバイダは、特定の操作 (すべてのシステム操作のロギングなど) を実行し、その他の定常操作をデフォルトプロバイダに委譲することで、デフォルトプロバイダを拡張できます。
java.nio.file.spi.FileSystemProvider クラスの概要
カスタムファイルシステムプロバイダは、java.nio.file.spi.FileSystemProvider クラスを実装する必要があります。ファイルシステムプロバイダは、file、jar、memory、cd などの URI スキームによって識別されます。
java.nio.file.spi.FileSystemProvider クラスの実装は、java.nio.file.FileSystem クラスのインスタンスのファクトリです。ファイルシステムの URI には、それを作成したファイルシステムプロバイダの URI スキームと一致する URI スキームが含まれています。
ファイルシステムを作成するには newFileSystem メソッドを使用し、既存のファイルシステムへの参照を取得するには getFileSystem メソッドを使用します。
カスタムファイルシステムプロバイダの実装
ここでは、java.nio.file.spi.FileSystemProvider API を使ってカスタムファイルシステムプロバイダを作成するために必要な大まかな手順について説明します。JDK インストールの demo/nio/zipfs に含まれている ZipFileSystemProvider クラスは、カスタムファイルシステムプロバイダの例です。Zip ファイルシステムプロバイダについては、「リソース」を参照してください。
カスタムファイルシステムプロバイダクラスの実装
カスタムファイルシステムプロバイダクラスを実装するには、次の操作を実行します。
java.nio.file.spi.FileSystemProviderクラスを拡張するカスタムファイルシステムプロバイダクラス (MyFileSystemProviderなど) を作成します。- ファイルシステムプロバイダの URI スキーム (
jarなど) を定義します。getSchemeメソッドは、このプロバイダの URI スキームを返します。 - このプロバイダによって作成されたファイルシステムを追跡するための内部キャッシュを作成します。
newFileSystemメソッドを実装します。このメソッドは、指定されたパスで新しいカスタムファイルシステムを作成し、そのファイルシステムをキャッシュに追加します。指定されたパスにファイルシステムがすでに存在する場合、このメソッドはjava.nio.file.FileSystemAlreadyExistsException例外をスローします。getFileSystemメソッドを実装します。このメソッドはキャッシュを検索し、指定された URI に対応するファイルシステムの以前に作成されたインスタンスを返します。- ファイルシステムプロバイダの要件に応じて、
newFileChannelメソッドまたはnewAsynchronousFileChannelメソッドを実装します。このメソッドは、ファイルシステムでのファイルの読み書きを可能にするFileChannelオブジェクトを返します。
カスタムファイルシステムクラスの実装
カスタムファイルシステムクラスを実装するには、次の操作を実行します。
java.nio.file.FileSystemクラスを拡張するクラス (MyFileSystemなど) を作成します。- 目的のファイルシステムの特性に応じて、ファイルシステムクラスのメソッドを実装します。ファイルシステムのいくつかの特性を次に示します。
- ルートの数 – ファイルシステムは、ルートを 1 つ持つ単一のファイル階層か、または複数の階層を持つことができます。
- 読み取りおよび書き込みアクセス – ファイルシステムは、読み取り専用または読み取り/書き込み可能にすることができます。
- ファイルストア – ファイルシステムには、基盤となるファイルストアが必要です。ファイルに設定できる属性は、基盤となるファイルストアによって異なります。