jp.terasoluna.fw.web.struts.action
クラス PropertyMessageResourcesEx

java.lang.Object
  上位を拡張 org.apache.struts.util.MessageResources
      上位を拡張 org.apache.struts.util.PropertyMessageResources
          上位を拡張 jp.terasoluna.fw.web.struts.action.PropertyMessageResourcesEx
すべての実装されたインタフェース:
java.io.Serializable

public class PropertyMessageResourcesEx
extends org.apache.struts.util.PropertyMessageResources

システム(フレームワーク)と業務共通のメッセージリソースを表示可能にする プロパティファイルメッセージリソース。

Strutsの仕様として、メッセージリソース定義ファイルを利用する場合、 その定義はモジュールごとに独立しているため、 すべてのモジュールに共通するメッセージリソースは一元的に定義できない。
TERASOLUNAではモジュールすべてに共通な、 業務共通メッセージや、システムメッセージを利用するための方法を 提供している。
このクラスは、StrutsのPropertyMessageResourcesを拡張し、 各業務のメッセージリソース定義ファイルだけでなく、業務共通メッセージと、 システムのメッセージを利用可能にする。
業務共通・システムのメッセージリソースの定義内容については、 GlobalMessageResourcesを参照のこと。

使用方法
このクラスを利用するには、struts-config.xml中の <message-resource>要素で を指定する。下記はstruts-config.xmlの設定例である。

 <struts-config>
   …
   <message-resources parameter="MessageResources"
                      factory="jp.terasoluna.fw.web.struts.action.PropertyMessageResourcesExFactory"
   />
  …
 </struts-config>
 
制限事項
  1. システムのメッセージリソースは国際化対応されない。
  2. 業務共通のメッセージリソースは国際化対応されない。
同一キーで取得されるメッセージリソースの優先順位は下記の通りとなる。
  1. メッセージリソース定義ファイルのメッセージリソース
  2. 業務共通メッセージリソース定義ファイル (application-messages.properties)のメッセージリソース
  3. システムメッセージリソース定義ファイル(system-messages.properties)の メッセージリソース

関連項目:
PropertyMessageResourcesExFactory, DBMessageResources, GlobalMessageResources, 直列化された形式

フィールドの概要
private static long serialVersionUID
          シリアルバージョンID
 
クラス org.apache.struts.util.PropertyMessageResources から継承されたフィールド
locales, log, messages
 
クラス org.apache.struts.util.MessageResources から継承されたフィールド
config, defaultFactory, defaultLocale, factory, formats, returnNull
 
コンストラクタの概要
PropertyMessageResourcesEx(org.apache.struts.util.MessageResourcesFactory factory, java.lang.String config)
          コンストラクタ。
PropertyMessageResourcesEx(org.apache.struts.util.MessageResourcesFactory factory, java.lang.String config, boolean returnNull)
          コンストラクタ。
 
メソッドの概要
 java.lang.String getMessage(java.util.Locale locale, java.lang.String key)
          メッセージを取得する。
 
クラス org.apache.struts.util.PropertyMessageResources から継承されたメソッド
loadLocale
 
クラス org.apache.struts.util.MessageResources から継承されたメソッド
escape, getConfig, getFactory, getMessage, getMessage, getMessage, getMessage, getMessage, getMessage, getMessage, getMessage, getMessage, getMessage, getMessage, getMessageResources, getReturnNull, isEscape, isPresent, isPresent, localeKey, log, log, messageKey, messageKey, setEscape, setReturnNull
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

serialVersionUID

private static final long serialVersionUID
シリアルバージョンID

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

PropertyMessageResourcesEx

public PropertyMessageResourcesEx(org.apache.struts.util.MessageResourcesFactory factory,
                                  java.lang.String config)
コンストラクタ。

パラメータ:
factory - このクラスのファクトリオブジェクト
config - メッセージリソースファイル名

PropertyMessageResourcesEx

public PropertyMessageResourcesEx(org.apache.struts.util.MessageResourcesFactory factory,
                                  java.lang.String config,
                                  boolean returnNull)
コンストラクタ。

パラメータ:
factory - このクラスのファクトリオブジェクト
config - メッセージリソースファイル名
returnNull - メッセージリソースキーが登録されていない場合、nullを 返すかどうか
メソッドの詳細

getMessage

public java.lang.String getMessage(java.util.Locale locale,
                                   java.lang.String key)
メッセージを取得する。 メッセージ取得の優先順位は下記のようになる。
  1. (各モジュールで定義された)メッセージリソース ファイル内のメッセージ
  2. 業務共通のメッセージ
  3. システムのメッセージ

オーバーライド:
クラス org.apache.struts.util.PropertyMessageResources 内の getMessage
パラメータ:
locale - リクエストから取得されたロケール
key - メッセージリソースキー
戻り値:
メッセージ