* Class supporting access to configuration settings. *
** コンフィギュレーションへのアクセスをサポートするクラス。 *
*/ public class Config { /* * I18N/Formatting actions related configuration data */ /** ** Name of configuration setting for application- (as opposed to browser-) * based preferred locale *
** アプリケーション・ベース（通常はブラウザ）のロケール(このロケールが優先されます）のコンフィギュレーション名 *
*/ public static final String FMT_LOCALE = "javax.servlet.jsp.jstl.fmt.locale"; /** ** Name of configuration setting for fallback locale *
** 代替ロケール（訳注 FMT_LOCALEが指定されていないときに使用するロケール）のコンフィギュレーション名 *
*/ public static final String FMT_FALLBACK_LOCALE = "javax.servlet.jsp.jstl.fmt.fallbackLocale"; /** ** Name of configuration setting for i18n localization context *
** 国際化対応(i18n)地域化コンテキストのためのコンフィギュレーション名 *
*/ public static final String FMT_LOCALIZATION_CONTEXT = "javax.servlet.jsp.jstl.fmt.localizationContext"; /** ** Name of localization setting for time zone *
** タイムゾーンのための地域化設定名 *
*/ public static final String FMT_TIME_ZONE = "javax.servlet.jsp.jstl.fmt.timeZone"; /* * SQL actions related configuration data */ /** ** Name of configuration setting for SQL data source *
** SQLデータソースのためのコンフィギュレーション名 *
*/ public static final String SQL_DATA_SOURCE = "javax.servlet.jsp.jstl.sql.dataSource"; /** ** Name of configuration setting for maximum number of rows to be included * in SQL query result *
** SQLクエリーの結果に含まれる行数の最大値を設定するためのコンフィギュレーション名 *
*/ public static final String SQL_MAX_ROWS = "javax.servlet.jsp.jstl.sql.maxRows"; /* * Private constants */ private static final String PAGE_SCOPE_SUFFIX = ".page"; private static final String REQUEST_SCOPE_SUFFIX = ".request"; private static final String SESSION_SCOPE_SUFFIX = ".session"; private static final String APPLICATION_SCOPE_SUFFIX = ".application"; /** * Looks up a configuration variable in the given scope. ** 与えられたスコープで有効なコンフィギュレーション変数を取得します。 * *
The lookup of configuration variables is performed as if each scope * had its own name space, that is, the same configuration variable name * in one scope does not replace one stored in a different scope. *
* コンフィギュレーション変数の取得は、それぞれのスコープが、
* それぞれの名前空間を持つかのように、実行されます。
* つまり、あるスコープの同じコンフィギュレーション変数名は、
* 他のスコープに保持されている変数を置き換えることはありません。
*
* @param pc Page context in which the configuration variable is to be
* looked up
*
取得対象のコンフィギュレーション変数を含むページコンテキスト
* @param name Configuration variable name
*
コンフィギュレーション変数名
* @param scope Scope in which the configuration variable is to be looked
* up
*
取得対象のコンフィギュレーション変数のスコープ
*
* @return The java.lang.Object associated with the configuration
* variable, or null if it is not defined.
* コンフィグレーション変数を指すjava.lang.Object、
* または、変数が定義されていない場合は null
*/
public static Object get(PageContext pc, String name, int scope) {
switch (scope) {
case PageContext.PAGE_SCOPE:
return pc.getAttribute(name + PAGE_SCOPE_SUFFIX, scope);
case PageContext.REQUEST_SCOPE:
return pc.getAttribute(name + REQUEST_SCOPE_SUFFIX, scope);
case PageContext.SESSION_SCOPE:
return get(pc.getSession(), name);
case PageContext.APPLICATION_SCOPE:
return pc.getAttribute(name + APPLICATION_SCOPE_SUFFIX, scope);
default:
throw new IllegalArgumentException("unknown scope");
}
}
/**
* Looks up a configuration variable in the "request" scope.
*
* "request" スコープのコンフィギュレーション変数を取得します。 * *
The lookup of configuration variables is performed as if each scope * had its own name space, that is, the same configuration variable name * in one scope does not replace one stored in a different scope. *
* コンフィギュレーション変数の取得は、それぞれのスコープが、
* それぞれの名前空間を持つかのように、実行されます。
* つまり、あるスコープの同じコンフィギュレーション変数名は、
* 他のスコープに保持されている変数を置き換えることはありません。
*
*
* @param request Request object in which the configuration variable is to
* be looked up
*
取得対象のコンフィギュレーション変数を含むRequestオブジェクト
*
* @param name Configuration variable name
*
コンフィギュレーション変数名
*
* @return The java.lang.Object associated with the configuration
* variable, or null if it is not defined.
* コンフィグレーション変数を指すjava.lang.Object、
* または、変数が定義されていない場合は null
*/
public static Object get(ServletRequest request, String name) {
return request.getAttribute(name + REQUEST_SCOPE_SUFFIX);
}
/**
* Looks up a configuration variable in the "session" scope.
*
* "session" スコープのコンフィギュレーション変数を取得します。 * *
The lookup of configuration variables is performed as if each scope * had its own name space, that is, the same configuration variable name * in one scope does not replace one stored in a different scope.
*
* コンフィギュレーション変数の取得は、それぞれのスコープが、
* それぞれの名前空間を持つかのように、実行されます。
* つまり、あるスコープの同じコンフィギュレーション変数名は、
* 他のスコープに保持されている変数を置き換えることはありません。
*
* @param session Session object in which the configuration variable is to
* be looked up
*
取得対象のコンフィギュレーション変数を含むSessionオブジェクト
* @param name Configuration variable name
*
コンフィギュレーション変数名
*
* @return The java.lang.Object associated with the configuration
* variable, or null if it is not defined, if session is null, or if the session
* is invalidated.
* コンフィグレーション変数を指すjava.lang.Object、
* 変数が未定義の場合やセッションがnullまたは無効である場合は null
*/
public static Object get(HttpSession session, String name) {
Object ret = null;
if (session != null) {
try {
ret = session.getAttribute(name + SESSION_SCOPE_SUFFIX);
} catch (IllegalStateException ex) {} // when session is invalidated
}
return ret;
}
/**
* Looks up a configuration variable in the "application" scope.
*
* "application" スコープのコンフィギュレーション変数を取得します。 * *
The lookup of configuration variables is performed as if each scope * had its own name space, that is, the same configuration variable name * in one scope does not replace one stored in a different scope. *
* コンフィギュレーション変数の取得は、それぞれのスコープが、
* それぞれの名前空間を持つかのように、実行されます。
* つまり、あるスコープの同じコンフィギュレーション変数名は、
* 他のスコープに保持されている変数を置き換えることはありません。
*
* @param context Servlet context in which the configuration variable is
* to be looked up
*
取得対象のコンフィギュレーション変数を含むサーブレットコンテキスト
* @param name Configuration variable name
*
コンフィギュレーション変数名
*
* @return The java.lang.Object associated with the configuration
* variable, or null if it is not defined.
* コンフィグレーション変数を指すjava.lang.Object、
* 変数が定義されていない場合は null
*/
public static Object get(ServletContext context, String name) {
return context.getAttribute(name + APPLICATION_SCOPE_SUFFIX);
}
/**
* Sets the value of a configuration variable in the given scope.
*
* 指定されたスコープのコンフィギュレーション変数の値を設定します。 * *
Setting the value of a configuration variable is performed as if * each scope had its own namespace, that is, the same configuration * variable name in one scope does not replace one stored in a different * scope. *
* コンフィギュレーション変数の設定は、それぞれのスコープが、
* それぞれの名前空間を持つかのように、実行されます。
* つまり、あるスコープの同じコンフィギュレーション変数名は、
* 他のスコープに保持されている変数を置き換えることはありません。
*
* @param pc Page context in which the configuration variable is to be set
*
設定をするコンフィギュレーション変数を含むPageコンテキスト
* @param name Configuration variable name
*
コンフィギュレーション変数名
* @param value Configuration variable value
*
コンフィギュレーション変数値
* @param scope Scope in which the configuration variable is to be set
*
設定をするコンフィギュレーション変数のスコープ
*/
public static void set(PageContext pc, String name, Object value,
int scope) {
switch (scope) {
case PageContext.PAGE_SCOPE:
pc.setAttribute(name + PAGE_SCOPE_SUFFIX, value, scope);
break;
case PageContext.REQUEST_SCOPE:
pc.setAttribute(name + REQUEST_SCOPE_SUFFIX, value, scope);
break;
case PageContext.SESSION_SCOPE:
pc.setAttribute(name + SESSION_SCOPE_SUFFIX, value, scope);
break;
case PageContext.APPLICATION_SCOPE:
pc.setAttribute(name + APPLICATION_SCOPE_SUFFIX, value, scope);
break;
default:
throw new IllegalArgumentException("unknown scope");
}
}
/**
* Sets the value of a configuration variable in the "request" scope.
*
* "request" スコープのコンフィギュレーション変数の値を設定します。 * *
Setting the value of a configuration variable is performed as if * each scope had its own namespace, that is, the same configuration * variable name in one scope does not replace one stored in a different * scope. *
* コンフィギュレーション変数の設定は、それぞれのスコープが、
* それぞれの名前空間を持つかのように、実行されます。
* つまり、あるスコープの同じコンフィギュレーション変数名は、
* 他のスコープに保持されている変数を置き換えることはありません。
*
* @param request Request object in which the configuration variable is to
* be set
*
設定をするコンフィギュレーション変数を含むRequestオブジェクト
* @param name Configuration variable name
*
コンフィギュレーション変数名
* @param value Configuration variable value
*
コンフィギュレーション変数値
*/
public static void set(ServletRequest request, String name, Object value) {
request.setAttribute(name + REQUEST_SCOPE_SUFFIX, value);
}
/**
* Sets the value of a configuration variable in the "session" scope.
*
* "session" スコープのコンフィギュレーション変数の値を設定します。 * *
Setting the value of a configuration variable is performed as if * each scope had its own namespace, that is, the same configuration * variable name in one scope does not replace one stored in a different * scope. *
* コンフィギュレーション変数の設定は、それぞれのスコープが、
* それぞれの名前空間を持つかのように、実行されます。
* つまり、あるスコープの同じコンフィギュレーション変数名は、
* 他のスコープに保持されている変数を置き換えることはありません。
*
* @param session Session object in which the configuration variable is to
* be set
*
設定をするコンフィギュレーション変数を含むSessionオブジェクト
* @param name Configuration variable name
*
コンフィギュレーション変数名
* @param value Configuration variable value
*
コンフィギュレーション変数値
*/
public static void set(HttpSession session, String name, Object value) {
session.setAttribute(name + SESSION_SCOPE_SUFFIX, value);
}
/**
* Sets the value of a configuration variable in the "application" scope.
*
* "application" スコープのコンフィギュレーション変数の値を設定します。 * *
Setting the value of a configuration variable is performed as if * each scope had its own namespace, that is, the same configuration * variable name in one scope does not replace one stored in a different * scope. *
* コンフィギュレーション変数の設定は、それぞれのスコープが、
* それぞれの名前空間を持つかのように、実行されます。
* つまり、あるスコープの同じコンフィギュレーション変数名は、
* 他のスコープに保持されている変数を置き換えることはありません。
*
* @param context Servlet context in which the configuration variable is to
* be set
*
設定をするコンフィギュレーション変数を含むサーブレットコンテキスト
* @param name Configuration variable name
*
コンフィギュレーション変数名
* @param value Configuration variable value
*
コンフィギュレーション変数値
*/
public static void set(ServletContext context, String name, Object value) {
context.setAttribute(name + APPLICATION_SCOPE_SUFFIX, value);
}
/**
* Removes a configuration variable from the given scope.
*
* 指定されたスコープからコンフィギュレーション変数を削除します。 * *
Removing a configuration variable is performed as if each scope had * its own namespace, that is, the same configuration variable name in one * scope does not impact one stored in a different scope. *
* コンフィギュレーション変数の削除は、それぞれのスコープが、
* それぞれの名前空間を持つかのように、実行されます。
* つまり、あるスコープの同じコンフィギュレーション変数名は、
* 他のスコープに保持されている変数を置き換えることはありません。
*
* @param pc Page context from which the configuration variable is to be
* removed
*
削除するコンフィギュレーション変数を含むPageコンテキスト
* @param name Configuration variable name
*
コンフィギュレーション変数名
* @param scope Scope from which the configuration variable is to be
* removed
*
削除するコンフィギュレーション変数のスコープ
*/
public static void remove(PageContext pc, String name, int scope) {
switch (scope) {
case PageContext.PAGE_SCOPE:
pc.removeAttribute(name + PAGE_SCOPE_SUFFIX, scope);
break;
case PageContext.REQUEST_SCOPE:
pc.removeAttribute(name + REQUEST_SCOPE_SUFFIX, scope);
break;
case PageContext.SESSION_SCOPE:
pc.removeAttribute(name + SESSION_SCOPE_SUFFIX, scope);
break;
case PageContext.APPLICATION_SCOPE:
pc.removeAttribute(name + APPLICATION_SCOPE_SUFFIX, scope);
break;
default:
throw new IllegalArgumentException("unknown scope");
}
}
/**
* Removes a configuration variable from the "request" scope.
*
* "request" スコープからコンフィギュレーション変数を削除します。 * *
Removing a configuration variable is performed as if each scope had * its own namespace, that is, the same configuration variable name in one * scope does not impact one stored in a different scope. *
* コンフィギュレーション変数の削除は、それぞれのスコープが、
* それぞれの名前空間を持つかのように、実行されます。
* つまり、あるスコープの同じコンフィギュレーション変数名は、
* 他のスコープに保持されている変数を置き換えることはありません。
*
* @param request Request object from which the configuration variable is
* to be removed
*
削除するコンフィギュレーション変数を含むRequestオブジェクト
* @param name Configuration variable name
*
コンフィギュレーション変数名
*/
public static void remove(ServletRequest request, String name) {
request.removeAttribute(name + REQUEST_SCOPE_SUFFIX);
}
/**
* Removes a configuration variable from the "session" scope.
*
* "session" スコープからコンフィギュレーション変数を削除します。 * *
Removing a configuration variable is performed as if each scope had * its own namespace, that is, the same configuration variable name in one * scope does not impact one stored in a different scope. *
* コンフィギュレーション変数の削除は、それぞれのスコープが、
* それぞれの名前空間を持つかのように、実行されます。
* つまり、あるスコープの同じコンフィギュレーション変数名は、
* 他のスコープに保持されている変数を置き換えることはありません。
*
* @param session Session object from which the configuration variable is
* to be removed
*
削除するコンフィギュレーション変数を含むSessionオブジェクト
* @param name Configuration variable name
*
コンフィギュレーション変数名
*/
public static void remove(HttpSession session, String name) {
session.removeAttribute(name + SESSION_SCOPE_SUFFIX);
}
/**
* Removes a configuration variable from the "application" scope.
*
* "application" スコープからコンフィギュレーション変数を削除します。 * *
Removing a configuration variable is performed as if each scope had * its own namespace, that is, the same configuration variable name in one * scope does not impact one stored in a different scope. *
* コンフィギュレーション変数の削除は、それぞれのスコープが、
* それぞれの名前空間を持つかのように、実行されます。
* つまり、あるスコープの同じコンフィギュレーション変数名は、
* 他のスコープに保持されている変数を置き換えることはありません。
*
* @param context Servlet context from which the configuration variable is
* to be removed
*
削除するコンフィギュレーション変数を含むサーブレットコンテキスト
* @param name Configuration variable name
*
コンフィギュレーション変数名
*/
public static void remove(ServletContext context, String name) {
context.removeAttribute(name + APPLICATION_SCOPE_SUFFIX);
}
/**
* Finds the value associated with a specific configuration setting
* identified by its context initialization parameter name.
*
* コンテキスト初期化パラメータ名によって識別される特別なコンフィギュレーション設定と関連した値を見つけます。 * *
For each of the JSP scopes (page, request, session, application), * get the value of the configuration variable identified by name * using method get(). Return as soon as a non-null value is * found. If no value is found, get the value of the context initialization * parameter identified by name. *
* JSP スコープ (page, request, session, application) それぞれについて、
* get()メソッドを用いて、名(name)によって識別されるコンフィギュレーション変数の値を取得します。
* nullでない値を発見した時点で値を返します。
* もし値を発見できなかった場合は名(name)によって識別されるコンテキスト初期化パラメータの値を取得します。
*
* @param pc Page context in which the configuration setting is to be
* searched
*
探索をするコンフィギュレーション設定を含むPageコンテキスト
* @param name Context initialization parameter name of the configuration
* setting
*
コンフィギュレーション設定のコンテキスト初期化パラメータ名
*
* @return The java.lang.Object associated with the configuration
* setting identified by name, or null if it is not defined.
*
名(name)によって識別されるコンフィグレーション設定を指すjava.lang.Object、
* または，変数が定義されていない場合は null
*/
public static Object find(PageContext pc, String name) {
Object ret = get(pc, name, PageContext.PAGE_SCOPE);
if (ret == null) {
ret = get(pc, name, PageContext.REQUEST_SCOPE);
if (ret == null) {
if (pc.getSession() != null) {
// check session only if a session is present
ret = get(pc, name, PageContext.SESSION_SCOPE);
}
if (ret == null) {
ret = get(pc, name, PageContext.APPLICATION_SCOPE);
if (ret == null) {
ret = pc.getServletContext().getInitParameter(name);
}
}
}
}
return ret;
}
}