jp.terasoluna.fw.util
クラス FileUtil

java.lang.Object
  上位を拡張 jp.terasoluna.fw.util.FileUtil

public class FileUtil
extends java.lang.Object

ファイル操作関連のユーティリティクラス。

セッションIDに対応したディレクトリの作成、取得、削除を行う。 各セッションIDに対応したディレクトリは、 ApplicationRecoures ファイルの "session.dir.base" で示されたディレクトリの中に 作成される。
セッションに対応したディレクトリは、サーバ側で作成したPDFの帳票など セッションに紐付いた一時的なデータを格納する際に利用できる。
セッションに紐付いたディレクトリは、 HttpSession オブジェクトが無効化された際に、このユーティリティクラスのメソッドを 用いて削除する。
セッションの生成・破棄を監視する機能については、 HttpSessionListenerを参照。


フィールドの概要
private static java.lang.String SESSION_DIR_BASE_KEY
          セッションに対応付けされたディレクトリを作成する際に、各ディレクトリを 格納する親ディレクトリ名を ApplicationResource ファイルから取得するためのキー。
 
コンストラクタの概要
FileUtil()
           
 
メソッドの概要
static java.io.File getSessionDirectory(java.lang.String sessionId)
          指定されたセッションIDに対応するディレクトリを取得する。
static java.lang.String getSessionDirectoryName(java.lang.String sessionId)
          指定されたセッションIDに対応するディレクトリ名を取得する。
static boolean makeSessionDirectory(java.lang.String sessionId)
          指定されたセッションIDに対応するディレクトリを作成する。
static boolean removeSessionDirectory(java.lang.String sessionId)
          指定されたセッションIDに対応するディレクトリを削除する。
static boolean rmdirs(java.io.File dir)
          指定されたディレクトリを削除する。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

SESSION_DIR_BASE_KEY

private static final java.lang.String SESSION_DIR_BASE_KEY
セッションに対応付けされたディレクトリを作成する際に、各ディレクトリを 格納する親ディレクトリ名を ApplicationResource ファイルから取得するためのキー。

関連項目:
定数フィールド値
コンストラクタの詳細

FileUtil

public FileUtil()
メソッドの詳細

getSessionDirectoryName

public static java.lang.String getSessionDirectoryName(java.lang.String sessionId)
指定されたセッションIDに対応するディレクトリ名を取得する。

パラメータ:
sessionId - セッションID
戻り値:
セッションIDのハッシュ値として生成されたディレクトリ名

getSessionDirectory

public static java.io.File getSessionDirectory(java.lang.String sessionId)
指定されたセッションIDに対応するディレクトリを取得する。

プロパティキーの設定を行なわなかった場合、 もしくは空文字の場合は tempディレクトリを用いる。

パラメータ:
sessionId - セッションID
戻り値:
セッションIDに対応するディレクトリとなるファイルオブジェクト

makeSessionDirectory

public static boolean makeSessionDirectory(java.lang.String sessionId)
指定されたセッションIDに対応するディレクトリを作成する。

作成が成功した場合には、true を返す。

パラメータ:
sessionId - セッションID
戻り値:
ディレクトリの作成に成功すれば true

removeSessionDirectory

public static boolean removeSessionDirectory(java.lang.String sessionId)
指定されたセッションIDに対応するディレクトリを削除する。

削除が成功した場合には、true を返す。

パラメータ:
sessionId - セッションID
戻り値:
ディレクトリの削除に成功すれば true

rmdirs

public static boolean rmdirs(java.io.File dir)
指定されたディレクトリを削除する。

ディレクトリ内にファイル、ディレクトリが ある場合でも、再帰的に削除される。

パラメータ:
dir - 削除するディレクトリ
戻り値:
ディレクトリの削除に成功すれば true