intra-mart(R) 6.0.13

jp.co.intra_mart.framework.base.service
クラス XmlServicePropertyHandler

java.lang.Object
  拡張jp.co.intra_mart.framework.base.service.XmlServicePropertyHandler
すべての実装インタフェース:
PropertyHandler, ServicePropertyHandler

public class XmlServicePropertyHandler
extends Object
implements ServicePropertyHandler

サービスの設定情報に接続するプロパティハンドラです。
XML形式で記述されたプロパティ情報を読み取ります。XMLファイルはアプリケーション毎に分割されます。この場合のファイル名は「 プレフィックス _ アプリケーションID .xml」です。また、アプリケーションに依存しない「 プレフィックス .xml」があります。
XMLファイルのプレフィックスは PropertyManager.getPropertyHandlerParams(String) でキーに ServiceManager.SERVICE_PROPERTY_HANDLER_KEY を指定したときに取得されるパラメータのうち DEFAULT_BUNDLE_NAMEで取得されるものとなります。 指定しなかった場合のプロパティファイルのプレフィックスは DEFAULT_BUNDLE_NAME_PARAMで示されるものです。
プロパティの検索順は、アプリケーションごとのプロパティファイル「 プレフィックス _ アプリケーションID .xml」が優先されます。該当するプロパティが見つからない場合、引き続いて「 プレフィックス .xml」を検索します。

導入されたバージョン:
5.0

フィールドの概要
static String DEFAULT_BUNDLE_NAME
          デフォルトのリソースバンドル名のプレフィックス
static String DEFAULT_BUNDLE_NAME_PARAM
          リソースバンドル名のパラメータ名
static String PARAM_DYNAMIC
          プロパティファイルの再読み込み可能のパラメータ名
 
インタフェース jp.co.intra_mart.framework.base.service.ServicePropertyHandler から継承したフィールド
DEFAULT_APPLICATION_PARAMETER, DEFAULT_ENCODING_ATTRIBUTE, DEFAULT_EXCEPTION_ATTRIBUTE, DEFAULT_LOCALE_ATTRIBUTE, DEFAULT_SERVICE_PARAMETER
 
コンストラクタの概要
XmlServicePropertyHandler()
          XmlServicePropertyHandlerを新規に生成します。
 
メソッドの概要
 String getApplicationParamName()
          推奨されていません。 この実装は廃止されました。
 String getClientEncoding()
          クライアントのエンコードを取得します。
 Locale getClientLocale()
          クライアントのエンコードを取得します。
 String getContextPath()
          推奨されていません。 このメソッドではなく、javax.servlet.http.HttpRequestのgetContextPathを使用するようにしてください。
 String getEncodingAttributeName()
          ログインユーザが使用するエンコードを保存しておくときの属性名を取得します。
 String getExceptionAttributeName()
          例外ページに遷移するときにjavax.servlet.http.HttpServletRequestに例外情報を属性として追加する場合の属性名を取得します。
 String getInputErrorPagePath()
          推奨されていません。 このメソッドではなく getInputErrorPagePath(Locale)を使用してください。
 String getInputErrorPagePath(Locale locale)
          入力例外時のページのパスを取得します。
 String getInputErrorPagePath(String application)
          推奨されていません。 このメソッドではなく getInputErrorPagePath(String, Locale) を使用してください。
 String getInputErrorPagePath(String application, Locale locale)
          入力例外時のページのパスを取得します。
 String getInputErrorPagePath(String application, String service)
          推奨されていません。 このメソッドではなく getInputErrorPagePath(String, String, Locale) を使用してください。
 String getInputErrorPagePath(String application, String service, Locale locale)
          入力例外時のページのパスを取得します。
 String getInputErrorPagePath(String application, String service, String key)
          推奨されていません。 このメソッドではなく getInputErrorPagePath(String, String, String, Locale) を使用してください。
 String getInputErrorPagePath(String application, String service, String key, Locale locale)
          入力例外時のページのパスを取得します。
 String getLocaleAttributeName()
          ログインユーザが使用するロケールを保存しておくときの属性名を取得します。
 String getNextPagePath(String application, String service)
          推奨されていません。 このメソッドではなく getNextPagePath(String, String, Locale) を使用してください。
 String getNextPagePath(String application, String service, Locale locale)
          遷移先のページのパスを取得します。
 String getNextPagePath(String application, String service, String key)
          推奨されていません。 このメソッドではなく getNextPagePath(String, String, String, Locale) を使用してください。
 String getNextPagePath(String application, String service, String key, Locale locale)
          遷移先のページのパスを取得します。
 String getServiceControllerName(String application, String service)
          推奨されていません。 このメソッドではなく getServiceControllerName(String, String, Locale) を使用してください。
 String getServiceControllerName(String application, String service, Locale locale)
          サービスコントローラのクラス名を取得します。
 String getServiceErrorPagePath()
          推奨されていません。 このメソッドではなく getServiceErrorPagePath(Locale) を使用してください。
 String getServiceErrorPagePath(Locale locale)
          処理例外時のページのパスを取得します。
 String getServiceErrorPagePath(String application)
          推奨されていません。 このメソッドではなく getServiceErrorPagePath(String, Locale) を使用してください。
 String getServiceErrorPagePath(String application, Locale locale)
          処理例外時のページのパスを取得します。
 String getServiceErrorPagePath(String application, String service)
          推奨されていません。 このメソッドではなく getServiceErrorPagePath(String, String, Locale) を使用してください。
 String getServiceErrorPagePath(String application, String service, Locale locale)
          処理例外時のページのパスを取得します。
 String getServiceErrorPagePath(String application, String service, String key)
          推奨されていません。 このメソッドではなく getServiceErrorPagePath(String, String, String, Locale) を使用してください。
 String getServiceErrorPagePath(String application, String service, String key, Locale locale)
          処理例外時のページのパスを取得します。
 String getServiceParamName()
          推奨されていません。 この実装は廃止されました。
 String getServiceServletPath()
          サービスサーブレットのパスを取得します。
 String getSystemErrorPagePath()
          推奨されていません。 このメソッドではなく getSystemErrorPagePath(Locale)を使用してください。
 String getSystemErrorPagePath(Locale locale)
          システム例外時のページのパスを取得します。
 String getSystemErrorPagePath(String application)
          推奨されていません。 このメソッドではなく getSystemErrorPagePath(String, Locale) を使用してください。
 String getSystemErrorPagePath(String application, Locale locale)
          システム例外時のページのパスを取得します。
 String getSystemErrorPagePath(String application, String service)
          推奨されていません。 このメソッドではなく getSystemErrorPagePath(String, String, Locale) を使用してください。
 String getSystemErrorPagePath(String application, String service, Locale locale)
          システム例外時のページのパスを取得します。
 String getSystemErrorPagePath(String application, String service, String key)
          推奨されていません。 このメソッドではなく getSystemErrorPagePath(String, String, String, Locale) を使用してください。
 String getSystemErrorPagePath(String application, String service, String key, Locale locale)
          システム例外時のページのパスを取得します。
 String getTransitionName(String application, String service)
          推奨されていません。 このメソッドではなく getTransitionName(String, String, Locale) を使用してください。
 String getTransitionName(String application, String service, Locale locale)
          トランジションのクラス名を取得します。
 void init(PropertyParam[] params)
          プロパティハンドラを初期化します。
 boolean isDynamic()
          プロパティの動的読み込みが可能かどうか調べます。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

DEFAULT_BUNDLE_NAME

public static final String DEFAULT_BUNDLE_NAME
デフォルトのリソースバンドル名のプレフィックス

関連項目:
定数フィールド値

DEFAULT_BUNDLE_NAME_PARAM

public static final String DEFAULT_BUNDLE_NAME_PARAM
リソースバンドル名のパラメータ名

関連項目:
定数フィールド値

PARAM_DYNAMIC

public static final String PARAM_DYNAMIC
プロパティファイルの再読み込み可能のパラメータ名

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

XmlServicePropertyHandler

public XmlServicePropertyHandler()
XmlServicePropertyHandlerを新規に生成します。

メソッドの詳細

init

public void init(PropertyParam[] params)
          throws PropertyHandlerException
プロパティハンドラを初期化します。

定義:
インタフェース PropertyHandler 内の init
パラメータ:
params - 初期パラメータ
例外:
PropertyHandlerException - プロパティハンドラの初期化時に例外が発生

isDynamic

public boolean isDynamic()
                  throws ServicePropertyException
プロパティの動的読み込みが可能かどうか調べます。 このクラスではこのメソッドは常にfalseを返します。

定義:
インタフェース ServicePropertyHandler 内の isDynamic
戻り値:
常にfalse
例外:
ServicePropertyException - チェック時に例外が発生

getClientEncoding

public String getClientEncoding()
                         throws ServicePropertyException
クライアントのエンコードを取得します。

定義:
インタフェース ServicePropertyHandler 内の getClientEncoding
戻り値:
クライアントのエンコーディング
例外:
ServicePropertyException - クライアントのエンコードの取得時に例外が発生

getClientLocale

public Locale getClientLocale()
                       throws ServicePropertyException
クライアントのエンコードを取得します。

定義:
インタフェース ServicePropertyHandler 内の getClientLocale
戻り値:
クライアントのエンコーディング
例外:
ServicePropertyException - クライアントのエンコードの取得時に例外が発生

getInputErrorPagePath

public String getInputErrorPagePath(String application,
                                    String service,
                                    String key)
                             throws ServicePropertyException
推奨されていません。 このメソッドではなく getInputErrorPagePath(String, String, String, Locale) を使用してください。

入力例外時のページのパスを取得します。 該当するページのパスが取得できない場合、 getInputErrorPagePath(String, String)で取得されるページを返します。 このメソッドは getInputErrorPagePath(application, service, key, (java.util.Locale)null) を呼んだときと同じ結果になります。

定義:
インタフェース ServicePropertyHandler 内の getInputErrorPagePath
パラメータ:
application - アプリケーションID
service - サービスID
key - 遷移先のキー
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getInputErrorPagePath

public String getInputErrorPagePath(String application,
                                    String service,
                                    String key,
                                    Locale locale)
                             throws ServicePropertyException
入力例外時のページのパスを取得します。 該当するページのパスが取得できない場合、 getInputErrorPagePath(String, String)で取得されるページを返します。

定義:
インタフェース ServicePropertyHandler 内の getInputErrorPagePath
パラメータ:
application - アプリケーションID
service - サービスID
key - 遷移先のキー
locale - ロケール
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getInputErrorPagePath

public String getInputErrorPagePath(String application,
                                    String service)
                             throws ServicePropertyException
推奨されていません。 このメソッドではなく getInputErrorPagePath(String, String, Locale) を使用してください。

入力例外時のページのパスを取得します。 該当するページのパスが取得できない場合、 getInputErrorPagePath(String)で取得されるページを返します。 このメソッドは getInputErrorPagePath(application, service, (java.util.Locale)null) を呼んだときと同じ結果になります。

定義:
インタフェース ServicePropertyHandler 内の getInputErrorPagePath
パラメータ:
application - アプリケーションID
service - サービスID
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getInputErrorPagePath

public String getInputErrorPagePath(String application,
                                    String service,
                                    Locale locale)
                             throws ServicePropertyException
入力例外時のページのパスを取得します。 該当するページのパスが取得できない場合、 getInputErrorPagePath(String)で取得されるページを返します。

定義:
インタフェース ServicePropertyHandler 内の getInputErrorPagePath
パラメータ:
application - アプリケーションID
service - サービスID
locale - ロケール
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getInputErrorPagePath

public String getInputErrorPagePath(String application)
                             throws ServicePropertyException
推奨されていません。 このメソッドではなく getInputErrorPagePath(String, Locale) を使用してください。

入力例外時のページのパスを取得します。 該当するページのパスが取得できない場合、 getInputErrorPagePath() で取得されるページを返します。 このメソッドは getInputErrorPagePath(application, (java.util.Locale)null) を呼んだときと同じ結果になります。

定義:
インタフェース ServicePropertyHandler 内の getInputErrorPagePath
パラメータ:
application - アプリケーションID
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getInputErrorPagePath

public String getInputErrorPagePath(String application,
                                    Locale locale)
                             throws ServicePropertyException
入力例外時のページのパスを取得します。 該当するページのパスが取得できない場合、 getInputErrorPagePath() で取得されるページを返します。

定義:
インタフェース ServicePropertyHandler 内の getInputErrorPagePath
パラメータ:
application - アプリケーションID
locale - ロケール
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getInputErrorPagePath

public String getInputErrorPagePath()
                             throws ServicePropertyException
推奨されていません。 このメソッドではなく getInputErrorPagePath(Locale)を使用してください。

入力例外時のページのパスを取得します。 このメソッドは getInputErrorPagePath((java.util.Locale)null) を呼んだときと同じ結果になります。

定義:
インタフェース ServicePropertyHandler 内の getInputErrorPagePath
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getInputErrorPagePath

public String getInputErrorPagePath(Locale locale)
                             throws ServicePropertyException
入力例外時のページのパスを取得します。

定義:
インタフェース ServicePropertyHandler 内の getInputErrorPagePath
パラメータ:
locale - ロケール
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getNextPagePath

public String getNextPagePath(String application,
                              String service)
                       throws ServicePropertyException
推奨されていません。 このメソッドではなく getNextPagePath(String, String, Locale) を使用してください。

遷移先のページのパスを取得します。 サービスから遷移先が一意に決まる場合にこのメソッドを使用します。 このメソッドは getNextPagePath(application, service, (java.util.Locale)null) を呼んだときと同じ結果になります。

定義:
インタフェース ServicePropertyHandler 内の getNextPagePath
パラメータ:
application - アプリケーションID
service - サービスID
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getNextPagePath

public String getNextPagePath(String application,
                              String service,
                              Locale locale)
                       throws ServicePropertyException
遷移先のページのパスを取得します。 サービスから遷移先が一意に決まる場合にこのメソッドを使用します。

定義:
インタフェース ServicePropertyHandler 内の getNextPagePath
パラメータ:
application - アプリケーションID
service - サービスID
locale - ロケール
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getNextPagePath

public String getNextPagePath(String application,
                              String service,
                              String key)
                       throws ServicePropertyException
推奨されていません。 このメソッドではなく getNextPagePath(String, String, String, Locale) を使用してください。

遷移先のページのパスを取得します。 サービスから遷移先が一意に決まらない場合にこのメソッドを使用します。 key null の場合、 getNextPagePath(String, String) と同じ動作になります。 このメソッドは getNextPagePath(application, service, key, (java.util.Locale)null) を呼んだときと同じ結果になります。

定義:
インタフェース ServicePropertyHandler 内の getNextPagePath
パラメータ:
application - アプリケーションID
service - サービスID
key - 遷移先のキー
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getNextPagePath

public String getNextPagePath(String application,
                              String service,
                              String key,
                              Locale locale)
                       throws ServicePropertyException
遷移先のページのパスを取得します。 サービスから遷移先が一意に決まらない場合にこのメソッドを使用します。 key null の場合、 getNextPagePath(String, String) と同じ動作になります。

定義:
インタフェース ServicePropertyHandler 内の getNextPagePath
パラメータ:
application - アプリケーションID
service - サービスID
key - 遷移先のキー
locale - ロケール
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getServiceControllerName

public String getServiceControllerName(String application,
                                       String service)
                                throws ServicePropertyException
推奨されていません。 このメソッドではなく getServiceControllerName(String, String, Locale) を使用してください。

サービスコントローラのクラス名を取得します。 該当するサービスコントローラが存在しない場合、nullを返します。 このメソッドは getServiceControllerName(application, service, (java.util.Locale)null) を呼んだときと同じ結果になります。

定義:
インタフェース ServicePropertyHandler 内の getServiceControllerName
パラメータ:
application - アプリケーションID
service - サービスID
戻り値:
サービスコントローラのクラス名、存在しない場合はnull
例外:
ServicePropertyException - サービスコントローラのクラス名の取得時に例外が発生

getServiceControllerName

public String getServiceControllerName(String application,
                                       String service,
                                       Locale locale)
                                throws ServicePropertyException
サービスコントローラのクラス名を取得します。 該当するサービスコントローラが存在しない場合、nullを返します。

定義:
インタフェース ServicePropertyHandler 内の getServiceControllerName
パラメータ:
application - アプリケーションID
service - サービスID
locale - ロケール
戻り値:
サービスコントローラのクラス名、存在しない場合はnull
例外:
ServicePropertyException - サービスコントローラのクラス名の取得時に例外が発生

getServiceErrorPagePath

public String getServiceErrorPagePath(String application,
                                      String service,
                                      String key)
                               throws ServicePropertyException
推奨されていません。 このメソッドではなく getServiceErrorPagePath(String, String, String, Locale) を使用してください。

処理例外時のページのパスを取得します。 このメソッドは getServiceErrorPagePath(application, service, key, (java.util.Locale)null) を呼んだときと同じ結果になります。

定義:
インタフェース ServicePropertyHandler 内の getServiceErrorPagePath
パラメータ:
application - アプリケーションID
service - サービスID
key - 遷移先のキー
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getServiceErrorPagePath

public String getServiceErrorPagePath(String application,
                                      String service,
                                      String key,
                                      Locale locale)
                               throws ServicePropertyException
処理例外時のページのパスを取得します。

定義:
インタフェース ServicePropertyHandler 内の getServiceErrorPagePath
パラメータ:
application - アプリケーションID
service - サービスID
key - 遷移先のキー
locale - ロケール
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getServiceErrorPagePath

public String getServiceErrorPagePath(String application,
                                      String service)
                               throws ServicePropertyException
推奨されていません。 このメソッドではなく getServiceErrorPagePath(String, String, Locale) を使用してください。

処理例外時のページのパスを取得します。 該当するページのパスが取得できない場合、 getServiceErrorPagePath(String)で取得されるページを返します。 このメソッドは getServiceErrorPagePath(application, service, (java.util.Locale)null) を呼んだときと同じ結果になります。

定義:
インタフェース ServicePropertyHandler 内の getServiceErrorPagePath
パラメータ:
application - アプリケーションID
service - サービスID
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getServiceErrorPagePath

public String getServiceErrorPagePath(String application,
                                      String service,
                                      Locale locale)
                               throws ServicePropertyException
処理例外時のページのパスを取得します。 該当するページのパスが取得できない場合、 getServiceErrorPagePath(String)で取得されるページを返します。

定義:
インタフェース ServicePropertyHandler 内の getServiceErrorPagePath
パラメータ:
application - アプリケーションID
service - サービスID
locale - ロケール
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getServiceErrorPagePath

public String getServiceErrorPagePath(String application)
                               throws ServicePropertyException
推奨されていません。 このメソッドではなく getServiceErrorPagePath(String, Locale) を使用してください。

処理例外時のページのパスを取得します。 該当するページのパスが取得できない場合、 getServiceErrorPagePath()で取得されるページを返します。 このメソッドは getServiceErrorPagePath(application, (java.util.Locale)null) を呼んだときと同じ結果になります。

定義:
インタフェース ServicePropertyHandler 内の getServiceErrorPagePath
パラメータ:
application - アプリケーションID
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getServiceErrorPagePath

public String getServiceErrorPagePath(String application,
                                      Locale locale)
                               throws ServicePropertyException
処理例外時のページのパスを取得します。 該当するページのパスが取得できない場合、 getServiceErrorPagePath()で取得されるページを返します。

定義:
インタフェース ServicePropertyHandler 内の getServiceErrorPagePath
パラメータ:
application - アプリケーションID
locale - ロケール
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getServiceErrorPagePath

public String getServiceErrorPagePath()
                               throws ServicePropertyException
推奨されていません。 このメソッドではなく getServiceErrorPagePath(Locale) を使用してください。

処理例外時のページのパスを取得します。 このメソッドは getServiceErrorPagePath((java.util.Locale)null) を呼んだときと同じ結果になります。

定義:
インタフェース ServicePropertyHandler 内の getServiceErrorPagePath
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getServiceErrorPagePath

public String getServiceErrorPagePath(Locale locale)
                               throws ServicePropertyException
処理例外時のページのパスを取得します。

定義:
インタフェース ServicePropertyHandler 内の getServiceErrorPagePath
パラメータ:
locale - ロケール
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getSystemErrorPagePath

public String getSystemErrorPagePath(String application,
                                     String service,
                                     String key)
                              throws ServicePropertyException
推奨されていません。 このメソッドではなく getSystemErrorPagePath(String, String, String, Locale) を使用してください。

システム例外時のページのパスを取得します。 該当するページのパスが取得できない場合、 getSystemErrorPagePath(String, String)で取得されるページを返します。 このメソッドは getSystemErrorPagePath(application, service, key, (java.util.Locale)null) を呼んだときと同じ結果になります。

定義:
インタフェース ServicePropertyHandler 内の getSystemErrorPagePath
パラメータ:
application - アプリケーションID
service - サービスID
key - 遷移先のキー
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getSystemErrorPagePath

public String getSystemErrorPagePath(String application,
                                     String service,
                                     String key,
                                     Locale locale)
                              throws ServicePropertyException
システム例外時のページのパスを取得します。 該当するページのパスが取得できない場合、 getSystemErrorPagePath(String, String)で取得されるページを返します。

定義:
インタフェース ServicePropertyHandler 内の getSystemErrorPagePath
パラメータ:
application - アプリケーションID
service - サービスID
key - 遷移先のキー
locale - ロケール
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getSystemErrorPagePath

public String getSystemErrorPagePath(String application,
                                     String service)
                              throws ServicePropertyException
推奨されていません。 このメソッドではなく getSystemErrorPagePath(String, String, Locale) を使用してください。

システム例外時のページのパスを取得します。 該当するページのパスが取得できない場合、 getSystemErrorPagePath(String)で取得されるページを返します。 このメソッドは getSystemErrorPagePath(application, service, (java.util.Locale)null) を呼んだときと同じ結果になります。

定義:
インタフェース ServicePropertyHandler 内の getSystemErrorPagePath
パラメータ:
application - アプリケーションID
service - サービスID
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getSystemErrorPagePath

public String getSystemErrorPagePath(String application,
                                     String service,
                                     Locale locale)
                              throws ServicePropertyException
システム例外時のページのパスを取得します。 該当するページのパスが取得できない場合、 getSystemErrorPagePath(String)で取得されるページを返します。

定義:
インタフェース ServicePropertyHandler 内の getSystemErrorPagePath
パラメータ:
application - アプリケーションID
service - サービスID
locale - ロケール
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getSystemErrorPagePath

public String getSystemErrorPagePath(String application)
                              throws ServicePropertyException
推奨されていません。 このメソッドではなく getSystemErrorPagePath(String, Locale) を使用してください。

システム例外時のページのパスを取得します。 該当するページのパスが取得できない場合、 getSystemErrorPagePath()で取得されるページを返します。 このメソッドは getSystemErrorPagePath(application, (java.util.Locale)null) を呼んだときと同じ結果になります。

定義:
インタフェース ServicePropertyHandler 内の getSystemErrorPagePath
パラメータ:
application - アプリケーションID
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getSystemErrorPagePath

public String getSystemErrorPagePath(String application,
                                     Locale locale)
                              throws ServicePropertyException
システム例外時のページのパスを取得します。 該当するページのパスが取得できない場合、 getSystemErrorPagePath()で取得されるページを返します。

定義:
インタフェース ServicePropertyHandler 内の getSystemErrorPagePath
パラメータ:
application - アプリケーションID
locale - ロケール
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getSystemErrorPagePath

public String getSystemErrorPagePath()
                              throws ServicePropertyException
推奨されていません。 このメソッドではなく getSystemErrorPagePath(Locale)を使用してください。

システム例外時のページのパスを取得します。 このメソッドは getSystemErrorPagePath((java.util.Locale)null) を呼んだときと同じ結果になります。

定義:
インタフェース ServicePropertyHandler 内の getSystemErrorPagePath
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getSystemErrorPagePath

public String getSystemErrorPagePath(Locale locale)
                              throws ServicePropertyException
システム例外時のページのパスを取得します。

定義:
インタフェース ServicePropertyHandler 内の getSystemErrorPagePath
パラメータ:
locale - ロケール
戻り値:
遷移先のページのパス
例外:
ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getTransitionName

public String getTransitionName(String application,
                                String service)
                         throws ServicePropertyException
推奨されていません。 このメソッドではなく getTransitionName(String, String, Locale) を使用してください。

トランジションのクラス名を取得します。 指定されたアプリケーションIDとサービスIDに対応するトランジション名を取得します。 特に設定されていない場合、nullが返ります。 このメソッドは getTransitionName(application, service, (java.util.Locale)null) を呼んだときと同じ結果になります。

定義:
インタフェース ServicePropertyHandler 内の getTransitionName
パラメータ:
application - アプリケーションID
service - サービスID
戻り値:
トランジションのクラス名、設定されていない場合はnull
例外:
ServicePropertyException - トランジションのクラス名の取得時に例外が発生

getTransitionName

public String getTransitionName(String application,
                                String service,
                                Locale locale)
                         throws ServicePropertyException
トランジションのクラス名を取得します。 指定されたアプリケーションIDとサービスIDに対応するトランジション名を取得します。 特に設定されていない場合、nullが返ります。

定義:
インタフェース ServicePropertyHandler 内の getTransitionName
パラメータ:
application - アプリケーションID
service - サービスID
locale - ロケール
戻り値:
トランジションのクラス名、設定されていない場合はnull
例外:
ServicePropertyException - トランジションのクラス名の取得時に例外が発生

getServiceServletPath

public String getServiceServletPath()
                             throws ServicePropertyException
サービスサーブレットのパスを取得します。

定義:
インタフェース ServicePropertyHandler 内の getServiceServletPath
戻り値:
サービスサーブレットのパス
例外:
ServicePropertyException - サービスサーブレットのパスの取得時に例外が発生

getContextPath

public String getContextPath()
                      throws ServicePropertyException
推奨されていません。 このメソッドではなく、javax.servlet.http.HttpRequestのgetContextPathを使用するようにしてください。

コンテキストパスを取得します。

定義:
インタフェース ServicePropertyHandler 内の getContextPath
戻り値:
コンテキストパス
例外:
ServicePropertyException - コンテキストパスの取得時に例外が発生

getApplicationParamName

public String getApplicationParamName()
                               throws ServicePropertyException
推奨されていません。 この実装は廃止されました。

アプリケーションIDに該当するパラメータ名を取得します。 設定されていない場合、 ServicePropertyHandler.DEFAULT_APPLICATION_PARAMETER で定義されている値を返します。

定義:
インタフェース ServicePropertyHandler 内の getApplicationParamName
戻り値:
アプリケーションIDに該当するパラメータ名
例外:
ServicePropertyException - アプリケーションIDに該当するパラメータ名の取得時に例外が発生

getServiceParamName

public String getServiceParamName()
                           throws ServicePropertyException
推奨されていません。 この実装は廃止されました。

サービスIDに該当するパラメータ名を取得します。 設定されていない場合、 ServicePropertyHandler.DEFAULT_SERVICE_PARAMETERで定義されている値を返します。

定義:
インタフェース ServicePropertyHandler 内の getServiceParamName
戻り値:
サービスIDに該当するパラメータ名
例外:
ServicePropertyException - サービスIDに該当するパラメータ名の取得時に例外が発生

getExceptionAttributeName

public String getExceptionAttributeName()
                                 throws ServicePropertyException
例外ページに遷移するときにjavax.servlet.http.HttpServletRequestに例外情報を属性として追加する場合の属性名を取得します。 設定されていない場合、 ServicePropertyHandler.DEFAULT_EXCEPTION_ATTRIBUTE で定義されている値を返します。

定義:
インタフェース ServicePropertyHandler 内の getExceptionAttributeName
戻り値:
例外の属性名
例外:
ServicePropertyException - 属性名の取得時に例外が発生

getEncodingAttributeName

public String getEncodingAttributeName()
                                throws ServicePropertyException
ログインユーザが使用するエンコードを保存しておくときの属性名を取得します。 設定されていない場合、 ServicePropertyHandler.DEFAULT_ENCODING_ATTRIBUTEで定義されている値を返します。

定義:
インタフェース ServicePropertyHandler 内の getEncodingAttributeName
戻り値:
エンコードの属性名
例外:
ServicePropertyException - 属性名の取得時に例外が発生

getLocaleAttributeName

public String getLocaleAttributeName()
                              throws ServicePropertyException
ログインユーザが使用するロケールを保存しておくときの属性名を取得します。 設定されていない場合、 ServicePropertyHandler.DEFAULT_LOCALE_ATTRIBUTEで定義されている値を返します 。

定義:
インタフェース ServicePropertyHandler 内の getLocaleAttributeName
戻り値:
ロケールの属性名
例外:
ServicePropertyException - 属性名の取得時に例外が発生

intra-mart(R) 6.0.13

Copyright © 2000-2009 NTT DATA INTRAMART CO.,LTD.. All Rights Reserved.