java.nio.file

インタフェース SecureDirectoryStream<T>

すべてのスーパーインタフェース:

AutoCloseable, Closeable, DirectoryStream<T>, Iterable<T>

public interface SecureDirectoryStream<T>
extends DirectoryStream<T>

開いたディレクトリから相対的な位置にあるファイルに対する操作を定義する DirectoryStream です。SecureDirectoryStream は、競合のない方法でファイルツリーをトラバースしたり、ディレクトリを操作したりする必要のある、洗練されたアプリケーションまたはセキュリティー重視のアプリケーションで使用することを想定しています。競合状態は、一連のファイル操作を単独で実行できない場合に発生することがあります。このインタフェースで定義されている各ファイル操作では、相対パスを指定します。ディレクトリが開いている間に攻撃者によって移動または置換されるかどうかに関係なく、ファイルへのアクセスはすべて、開いているディレクトリを基準に行われます。SecureDirectoryStream は、仮想作業ディレクトリとしても使用できます。

SecureDirectoryStream には、ベースとなるオペレーティングシステムからの対応するサポートが必要です。実装がこの機能をサポートしている場合、newDirectoryStream メソッドによって返される DirectoryStream は SecureDirectoryStream となり、このインタフェースで定義されているメソッドを呼び出すために、その型にキャストされる必要があります。

デフォルトプロバイダで、セキュリティーマネージャーが設定されている場合は、指定された相対パスをディレクトリの元のパスに基づいて解決することで得られるパスを使用してアクセス権チェックが行われます (そのディレクトリが開かれてから移動されたかどうかは関係ない)。

導入されたバージョン:

1.7

ネストされたクラスのサマリー

インタフェース java.nio.file.DirectoryStream から継承されたネストされたクラス/インタフェース

DirectoryStream.Filter<T>

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
void	deleteDirectory(T path) ディレクトリを削除します。
void	deleteFile(T path) ファイルを削除します。
<V extends FileAttributeView> V	getFileAttributeView(Class<V> type) このディレクトリのファイル属性にアクセスするための新しいファイル属性ビューを返します。
<V extends FileAttributeView> V	getFileAttributeView(T path, Class<V> type, LinkOption... options) このディレクトリ内のファイルのファイル属性にアクセスするための新しいファイル属性ビューを返します。
void	move(T srcpath, SecureDirectoryStream<T> targetdir, T targetpath) このディレクトリからほかのディレクトリにファイルを移動します。
SeekableByteChannel	newByteChannel(T path, Set<? extends OpenOption> options, FileAttribute<?>... attrs) このディレクトリ内のファイルを開くか作成し、そのファイルにアクセスするためのシーク可能なバイトチャネルを返します。
SecureDirectoryStream<T>	newDirectoryStream(T path, LinkOption... options) 指定されたパスによって識別されるディレクトリを開き、そのディレクトリ内のエントリを反復処理する SecureDirectoryStream を返します。

インタフェース java.nio.file.DirectoryStream から継承されたメソッド

iterator

インタフェース java.io.Closeable から継承されたメソッド

close

メソッドの詳細

newDirectoryStream

SecureDirectoryStream<T> newDirectoryStream(T path,
                                          LinkOption... options)
                                            throws IOException

指定されたパスによって識別されるディレクトリを開き、そのディレクトリ内のエントリを反復処理する SecureDirectoryStream を返します。

このメソッドは、path パラメータが絶対パスの場合は、newDirectoryStream メソッドによって指定されたとおりに機能します。パラメータが相対パスである場合、開くディレクトリはこの開いているディレクトリからの相対位置にあります。NOFOLLOW_LINKS オプションを使用すると、ファイルがシンボリックリンクである場合に必ずこのメソッドが失敗するようにできます。

新しいディレクトリストリームは、作成後、その作成に使用されたディレクトリストリームには依存しません。このディレクトリストリームを閉じても、新しく作成したディレクトリストリームには何の影響もありません。

パラメータ:

path - 開くディレクトリへのパス

options - シンボリックリンクの処理方法を示すオプション

戻り値:

新しく開かれた SecureDirectoryStream オブジェクト

例外:

ClosedDirectoryStreamException - ディレクトリストリームが閉じられている場合

NotDirectoryException - ファイルがディレクトリではないために開けなかった場合 (オプションの固有例外)

IOException - 入出力エラーが発生した場合

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、checkRead メソッドが呼び出されてディレクトリへの読み取りアクセスがチェックされます。

newByteChannel

SeekableByteChannel newByteChannel(T path,
                                 Set<? extends OpenOption> options,
                                 FileAttribute<?>... attrs)
                                   throws IOException

このディレクトリ内のファイルを開くか作成し、そのファイルにアクセスするためのシーク可能なバイトチャネルを返します。

このメソッドは、path パラメータが絶対パスの場合は、Files.newByteChannel メソッドによって指定されたとおりに機能します。パラメータが相対パスである場合、開くまたは作成するファイルはこの開いているディレクトリからの相対位置にあります。Files.newByteChannel メソッドで定義されているオプションのほかに、NOFOLLOW_LINKS オプションを使用して、ファイルがシンボリックリンクである場合に必ずこのメソッドが失敗するようにすることもできます。

チャネルは、作成後、その作成に使用されたディレクトリストリームには依存しません。このディレクトリストリームを閉じても、チャネルには何の影響もありません。

パラメータ:

path - 開くまたは作成するファイルのパス

options - ファイルを開く方法を指定するオプション

attrs - ファイルの作成時に原子的に設定される属性のオプションのリスト

例外:

ClosedDirectoryStreamException - ディレクトリストリームが閉じられている場合

IllegalArgumentException - セットにオプションの無効な組み合わせが含まれる場合

UnsupportedOperationException - 未サポートのオープンオプションが指定された場合またはファイルの作成時に原子的に設定できない属性が配列に含まれる場合

FileAlreadyExistsException - その名前のファイルがすでに存在する場合、および CREATE_NEW オプションが指定された場合 (オプションの固有例外)

IOException - 入出力エラーが発生した場合

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、ファイルが読み取り用に開かれると checkRead メソッドが呼び出されてパスへの読み取りアクセスがチェックされます。ファイルが書き込み用に開かれた場合は、checkWrite メソッドが呼び出されてパスへの書き込みアクセスがチェックされます。

deleteFile

void deleteFile(T path)
                throws IOException

ファイルを削除します。

delete() メソッドとは異なり、このメソッドはファイルがディレクトリかどうかを判断するために最初にファイルを検査しません。このメソッドによってディレクトリが削除されるかどうかはシステムに依存しているため、未指定です。ファイルがシンボリックリンクである場合、そのリンクの最終ターゲットではなく、そのリンク自体が削除されます。パラメータが相対パスである場合、削除するファイルはこの開いているディレクトリからの相対位置にあります。

パラメータ:

path - 削除するファイルのパス

例外:

ClosedDirectoryStreamException - ディレクトリストリームが閉じられている場合

NoSuchFileException - ファイルが存在しない場合 (オプションの固有例外)

IOException - 入出力エラーが発生した場合

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、checkDelete メソッドが呼び出されてファイルへの削除アクセスがチェックされます。

deleteDirectory

void deleteDirectory(T path)
                     throws IOException

ディレクトリを削除します。

delete() メソッドとは異なり、このメソッドはファイルがディレクトリかどうかを判断するために最初にファイルを検査しません。このメソッドによってディレクトリ以外のものが削除されるかどうかはシステムに依存しているため、未指定です。パラメータが相対パスである場合、削除するディレクトリはこの開いているディレクトリからの相対位置にあります。

パラメータ:

path - 削除するディレクトリのパス

例外:

ClosedDirectoryStreamException - ディレクトリストリームが閉じられている場合

NoSuchFileException - ディレクトリが存在しない場合 (オプションの固有例外)

DirectoryNotEmptyException - ディレクトリが空でないために削除できなかった場合 (オプションの固有例外)

IOException - 入出力エラーが発生した場合

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、checkDelete メソッドが呼び出されてディレクトリへの削除アクセスがチェックされます。

move

void move(T srcpath,
        SecureDirectoryStream<T> targetdir,
        T targetpath)
          throws IOException

このディレクトリからほかのディレクトリにファイルを移動します。

ATOMIC_MOVE オプションが指定されている場合、このメソッドは move メソッドと同様の動作をします。つまり、このメソッドは原子的なファイルシステム操作としてファイルを移動します。srcpath パラメータが絶対パスである場合は、ソースファイルが検出されます。パラメータが相対パスである場合、それはこの開いているディレクトリからの相対位置にあります。targetpath パラメータが絶対である場合は、ターゲットファイル (targetdir パラメータは無視される) が検出されます。パラメータが相対パスである場合、それは targetdir パラメータで識別される開いているディレクトリからの相対位置にあります。いずれにしても、ターゲットファイルが存在する場合、それが置換されるか、このメソッドが失敗するかは実装に固有です。

パラメータ:

srcpath - 移動するファイルの名前

targetdir - 宛先ディレクトリ

targetpath - 宛先ディレクトリ内で、そのファイルに指定する名前

例外:

ClosedDirectoryStreamException - このディレクトリストリームまたはターゲットディレクトリストリームが閉じている場合

FileAlreadyExistsException - ファイルがターゲットディレクトリにすでに存在していて、置き換えられない場合 (オプションの固有例外)

AtomicMoveNotSupportedException - 原子的なファイルシステム操作としてファイルを移動できない場合

IOException - 入出力エラーが発生した場合

SecurityException - デフォルトプロバイダで、セキュリティーマネージャーがインストールされている場合は、checkWrite メソッドが呼び出されてソースおよびターゲットファイルの両方への書き込みアクセスがチェックされます。

getFileAttributeView

<V extends FileAttributeView> V getFileAttributeView(Class<V> type)

このディレクトリのファイル属性にアクセスするための新しいファイル属性ビューを返します。

結果となるファイル属性ビューを使用すると、この (開いている) ディレクトリの属性を読み取ったり更新したりできます。type パラメータは属性ビューの型を指定し、メソッドはサポートされている場合はその型のインスタンスを返します。このメソッドを呼び出して BasicFileAttributeView を取得すると、必ずこの開いているディレクトリにバインドされた、そのクラスのインスタンスが返されます。

結果のファイル属性ビューの状態は、このディレクトリストリームと密接な関係にあります。ディレクトリストリームがいったん閉じられると、属性を読み取ったり更新したりするメソッドはすべて ClosedDirectoryStreamException をスローします。

パラメータ:

type - ファイル属性ビューに対応する Class オブジェクト

戻り値:

このディレクトリストリームにバインドされた、指定された型の新しいファイル属性ビュー。その属性ビュー型が利用できない場合は null

getFileAttributeView

<V extends FileAttributeView> V getFileAttributeView(T path,
                                                   Class<V> type,
                                                   LinkOption... options)

このディレクトリ内のファイルのファイル属性にアクセスするための新しいファイル属性ビューを返します。

結果となるファイル属性ビューを使用すると、このディレクトリ内のファイルの属性を読み取ったり更新したりできます。type パラメータは属性ビューの型を指定し、メソッドはサポートされている場合はその型のインスタンスを返します。このメソッドを呼び出して BasicFileAttributeView を取得すると、必ずそのディレクトリ内のファイルにバインドされた、そのクラスのインスタンスが返されます。

結果のファイル属性ビューの状態は、このディレクトリストリームと密接な関係にあります。ディレクトリストリームがいったん閉じられると、属性を読み取ったり更新したりするメソッドはすべて ClosedDirectoryStreamException をスローします。ファイル属性ビューの作成時にファイルが存在していなくてもかまいませんが、ファイルの属性を読み取ったり更新したりするメソッドは、それが呼び出されたときにファイルが存在しないと失敗します。

パラメータ:

path - ファイルのパス

type - ファイル属性ビューに対応する Class オブジェクト

options - シンボリックリンクの処理方法を示すオプション

戻り値:

このディレクトリストリームにバインドされた、指定された型の新しいファイル属性ビュー。その属性ビュー型が利用できない場合は null