org.seasar.framework.env
クラス Env

java.lang.Object
  org.seasar.framework.env.Env

public class Env

extends java.lang.Object

環境名を保持するクラスです。

環境名とは、SMART deployの動作モード (HOT/COOL/WARM) 等を実行時に切り替えるために使われる名前です。 環境名は、環境名設定ファイルから読み込まれます。 デフォルトの環境名設定ファイルはenv.txtです。 環境名設定ファイルがクラスパス上に存在しない場合、環境名はproductに設定されます。

環境名には任意の名前を使用することができますが、Seasar2では標準的な環境名として以下の名前を使用することを推奨しています。

環境名	モード	用途
ut	WARM deploy	JUnit等を使用した単体テスト環境
ct	HOT deploy	IDEを使用した結合テスト環境
it	COOL deploy	本来の実行環境 (APサーバ) を使用した統合テスト環境
production	COOL deploy	運用環境

環境名設定ファイルのエンコードはUTF-8固定です。

作成者:

higa

フィールドの概要

static java.lang.String	CT 結合テスト環境を表す環境名です。
static java.lang.String	DEFAULT_FILE_PATH デフォルトの環境名設定ファイルのパスです。
static java.lang.String	IT 統合テスト環境を表す環境名です。
static java.lang.String	PRODUCT 運用環境を表す環境名です。
static java.lang.String	UT 単体テスト環境を表す環境名です。

メソッドの概要

static java.lang.String	adjustPath(java.lang.String path) パスから拡張子を除いて、環境名をサフィックスとして加えたパスを返します。
protected static void	calcValue() 値を計算します。
protected static void	calcValue(java.net.URL url) 値を計算します。
protected static void	clearValue() 値をクリアします。
static java.lang.String	getFilePath() 環境名設定ファイルのパスを返します。
static java.lang.String	getValue() 環境名を返します。
static void	initialize() デフォルトの環境名設定ファイルパスを使用するように初期化します。
static void	setFile(java.io.File fileObj) 環境名設定ファイルを設定します。
static void	setFilePath(java.lang.String filePath) 環境名設定ファイルのパスを設定します。
static boolean	setValueIfAbsent(java.lang.String newValue) 環境名が設定されていなければ、環境名を設定します。

クラス java.lang.Object から継承したメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

PRODUCT

public static final java.lang.String PRODUCT

運用環境を表す環境名です。

関連項目:

定数フィールド値

UT

public static final java.lang.String UT

単体テスト環境を表す環境名です。

関連項目:

定数フィールド値

CT

public static final java.lang.String CT

結合テスト環境を表す環境名です。

関連項目:

定数フィールド値

IT

public static final java.lang.String IT

統合テスト環境を表す環境名です。

関連項目:

定数フィールド値

DEFAULT_FILE_PATH

public static final java.lang.String DEFAULT_FILE_PATH

デフォルトの環境名設定ファイルのパスです。

関連項目:

定数フィールド値

メソッドの詳細

initialize

public static void initialize()

デフォルトの環境名設定ファイルパスを使用するように初期化します。

getValue

public static java.lang.String getValue()

環境名を返します。

環境名設定ファイルがクラスパス上に存在し、そのファイルを最後に読み込んだ後にファイルが更新されていれば、ファイルを再読込します。 環境名設定ファイルが存在せず、環境名が設定されていない場合は環境名として運用環境を返します。

戻り値:

環境名

setValueIfAbsent

public static boolean setValueIfAbsent(java.lang.String newValue)

環境名が設定されていなければ、環境名を設定します。

パラメータ:

newValue - 環境名

戻り値:

環境名を設定した場合はtrue、それ以外の場合はfalse

adjustPath

public static java.lang.String adjustPath(java.lang.String path)

パスから拡張子を除いて、環境名をサフィックスとして加えたパスを返します。

パラメータ:

path - パス

戻り値:

パスから拡張子を除いて、環境名をサフィックスとして加えたパス

getFilePath

public static java.lang.String getFilePath()

環境名設定ファイルのパスを返します。

戻り値:

環境名設定ファイルのパス

setFilePath

public static void setFilePath(java.lang.String filePath)

環境名設定ファイルのパスを設定します。

パラメータ:

filePath - 環境名設定ファイルのパス

例外:

EmptyRuntimeException - 環境名設定ファイルがnullあるいは空文字列の場合にスローされます

setFile

public static void setFile(java.io.File fileObj)
                    throws java.io.FileNotFoundException

環境名設定ファイルを設定します。

パラメータ:

fileObj - 環境設定ファイルを表す File オブジェクト

例外:

EmptyRuntimeException - fileObjがnullの場合にスローされます

java.io.FileNotFoundException - fileObjの示すファイルが存在しない場合にスローされます

calcValue

protected static void calcValue()

値を計算します。

calcValue

protected static void calcValue(java.net.URL url)

値を計算します。

パラメータ:

url - URL

clearValue

protected static void clearValue()

値をクリアします。