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

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

public final class GlobalMessageResources
extends org.apache.struts.util.MessageResources

業務共通、システムのメッセージリソースを生成するクラス。

Strutsの仕様として、メッセージリソース定義ファイルを利用する場合、 その定義はモジュールごとに独立しているため、すべてのモジュールに共通する メッセージリソースを一元的に定義することができない。
TERASOLUNAではモジュールすべてに共通な、 業務共通メッセージや、システムメッセージを利用する方法を提供している。
このクラスは、システム(フレームワーク)のメッセージリソースと、 業務共通のメッセージリソースを保持し、TERASOLUNAフレームワークが提供する、 どのメッセージリソースクラスを用いても参照されるようになっている。

制限事項
  1. TERASOLUNAフレームワークで提供するMessageResourcesは、 全てこのクラスからシステム、業務共通のメッセージリソースを取得する 必要がある。
  2. ここで取得されたメッセージリソースは国際化対応されない。
業務共通のメッセージリソース設定

業務共通のメッセージリソースは、デフォルトで業務共通メッセージリソース定義 ファイルから取得する。 業務共通メッセージリソース定義ファイルのデフォルトのファイル名は application-messages.propertiesに設定されている。 ファイル名を変更する場合は、 システム設定プロパティファイル(system.properties) に以下のキーで設定を行なう。


 application.messages=sample1-messages
 
application.messagesに対応する文字列は、.propertiesを除いたファイル名である。 必ず.propertiesは除いて記述する。

業務共通メッセージリソース定義ファイルの応用
業務共通のメッセージは業務共通メッセージリソース定義ファイル (application-messages.properties) あるいは、システム設定プロパティファイル(system.properties) で定義したファイル名のファイルの中で、 下記のようにキー(add.message.file.x)を 使用して外部ファイルを指定することにより、 メッセージリソースを追加することができる。
 add.message.file.1=app1-message
 add.message.file.2=app2-message
 
プロパティキー末尾は1で始まる通番であり、途中で通番が途切れている場合は、 そこで外部ファイル読み込み終了となる。
システムのメッセージリソース設定
GlobalMessageResourcesでは、 デフォルトでsystem-message.propertiesをロードし、 ここからシステムのメッセージを取得している。 このシステムメッセージリソース定義ファイル名は、変更できない。

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

フィールドの概要
 
クラス org.apache.struts.util.MessageResources から継承されたフィールド
config, defaultFactory, defaultLocale, factory, formats, returnNull
 
メソッドの概要
static GlobalMessageResources getInstance()
          このクラスのシングルトンインスタンスを返却する。
 String getMessage(Locale locale, String key)
          メッセージを返却する。
 
クラス 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
 

メソッドの詳細

getInstance

public static GlobalMessageResources getInstance()
このクラスのシングルトンインスタンスを返却する。

戻り値:
GlobalMessageResources このクラスのシングルトンインスタンス

getMessage

public String getMessage(Locale locale,
                         String key)
メッセージを返却する。 メッセージ取得の優先順位は、
  1. 業務共通のメッセージリソース
  2. システムのメッセージリソース
の順となる。

定義:
クラス org.apache.struts.util.MessageResources 内の getMessage
パラメータ:
locale - ロケールオブジェクト
key - メッセージリソースキー
戻り値:
メッセージ


Copyright © 2012. All Rights Reserved.