jp.co.intra_mart.framework.base.service

インタフェース ServicePropertyHandler

すべてのスーパーインタフェース:

PropertyHandler

既知の実装クラスのリスト:

DefaultServicePropertyHandler, DistributesServicePropertyHandler, TextFileServicePropertyHandler, XmlServicePropertyHandler

public interface ServicePropertyHandler
extends PropertyHandler

サービスの設定情報に接続するクラスです。

バージョン:

1.0

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static String	DEFAULT_APPLICATION_PARAMETER 非推奨です。 この実装は廃止されました。
static String	DEFAULT_ENCODING_ATTRIBUTE ログインユーザのエンコーディングのデフォルトの属性名
static String	DEFAULT_EXCEPTION_ATTRIBUTE 例外属性のデフォルトの属性名
static String	DEFAULT_LOCALE_ATTRIBUTE ログインユーザのロケールのデフォルトの属性名
static String	DEFAULT_SERVICE_PARAMETER 非推奨です。 この実装は廃止されました。
static String	REQUEST_INFO_ATTRIBUTE リクエスト情報の属性地

メソッドのサマリー

修飾子とタイプ	メソッドと説明
String	getApplicationParamName() 非推奨です。 この実装は廃止されました。
String	getClientEncoding() クライアントのエンコードを取得します。
Locale	getClientLocale() クライアントのロケールを取得します。
String	getContextPath() 非推奨です。 このメソッドではなく、javax.servlet.http.HttpRequestのgetContextPathを使用するようにしてください。
ControllerConverterConfig	getControllerConverterConfig(String application, String service, Locale locale) キーに該当するコントローラコンバータの初期パラメータを取得します。
String	getControllerConverterName(String application, String service, Locale locale) コントローラコンバータのクラス名を取得します。
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) トランジションのクラス名を取得します。
ValidatorMapping[]	getValidators(String application, String service, Locale locale) キーに該当するバリデータを取得します。
boolean	isDynamic() プロパティの動的読み込みが可能かどうか調べます。

インタフェースから継承されたメソッド jp.co.intra_mart.framework.system.property.PropertyHandler

init

フィールドの詳細

DEFAULT_APPLICATION_PARAMETER

static final String DEFAULT_APPLICATION_PARAMETER

非推奨です。 この実装は廃止されました。

アプリケーションIDのデフォルトのパラメータ名

関連項目:

定数フィールド値

DEFAULT_SERVICE_PARAMETER

static final String DEFAULT_SERVICE_PARAMETER

非推奨です。 この実装は廃止されました。

サービスIDのデフォルトのパラメータ名

関連項目:

定数フィールド値

DEFAULT_EXCEPTION_ATTRIBUTE

static final String DEFAULT_EXCEPTION_ATTRIBUTE

例外属性のデフォルトの属性名

関連項目:

定数フィールド値

DEFAULT_ENCODING_ATTRIBUTE

static final String DEFAULT_ENCODING_ATTRIBUTE

ログインユーザのエンコーディングのデフォルトの属性名

関連項目:

定数フィールド値

DEFAULT_LOCALE_ATTRIBUTE

static final String DEFAULT_LOCALE_ATTRIBUTE

ログインユーザのロケールのデフォルトの属性名

関連項目:

定数フィールド値

REQUEST_INFO_ATTRIBUTE

static final String REQUEST_INFO_ATTRIBUTE

リクエスト情報の属性地

関連項目:

定数フィールド値

メソッドの詳細

isDynamic

boolean isDynamic()
           throws ServicePropertyException

プロパティの動的読み込みが可能かどうか調べます。

戻り値:

true：プロパティの動的読み込みが可能、false：プロパティの動的読み込み不可

例外:

ServicePropertyException - チェック時に例外が発生

導入されたバージョン:

3.2

getClientEncoding

String getClientEncoding()
                  throws ServicePropertyException

クライアントのエンコードを取得します。

戻り値:

クライアントのエンコーディング

例外:

ServicePropertyException - クライアントのエンコードの取得時に例外が発生

getEncodingAttributeName

String getEncodingAttributeName()
                         throws ServicePropertyException

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

戻り値:

エンコードの属性名

例外:

ServicePropertyException - 属性名の取得時に例外が発生

getClientLocale

Locale getClientLocale()
                throws ServicePropertyException

クライアントのロケールを取得します。

戻り値:

クライアントのロケール（設定されていない場合はnull）

例外:

ServicePropertyException - クライアントのロケールの取得時に例外が発生

導入されたバージョン:

4.2

getLocaleAttributeName

String getLocaleAttributeName()
                       throws ServicePropertyException

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

戻り値:

ロケールの属性名

例外:

ServicePropertyException - 属性名の取得時に例外が発生

導入されたバージョン:

4.2

getNextPagePath

String getNextPagePath(String application,
                       String service)
                throws ServicePropertyException

非推奨です。 このメソッドではなくgetNextPagePath(String, String, Locale)を使用してください。

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

パラメータ:

application - アプリケーションID

service - サービスID

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getNextPagePath

String getNextPagePath(String application,
                       String service,
                       Locale locale)
                throws ServicePropertyException

遷移先のページのパスを取得します。 サービスから遷移先が一意に決まる場合にこのメソッドを使用します。

パラメータ:

application - アプリケーションID

service - サービスID

locale - ロケール

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

導入されたバージョン:

4.2

getNextPagePath

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)を呼んだときと同じ結果になるように実装される必要があります。

パラメータ:

application - アプリケーションID

service - サービスID

key - 遷移先のキー

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getNextPagePath

String getNextPagePath(String application,
                       String service,
                       String key,
                       Locale locale)
                throws ServicePropertyException

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

パラメータ:

application - アプリケーションID

service - サービスID

key - 遷移先のキー

locale - ロケール

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

導入されたバージョン:

4.2

getInputErrorPagePath

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)を呼んだときと同じ結果になるように実装される必要があります。

パラメータ:

application - アプリケーションID

service - サービスID

key - 遷移先のキー

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getInputErrorPagePath

String getInputErrorPagePath(String application,
                             String service,
                             String key,
                             Locale locale)
                      throws ServicePropertyException

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

パラメータ:

application - アプリケーションID

service - サービスID

key - 遷移先のキー

locale - ロケール

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

導入されたバージョン:

4.2

getInputErrorPagePath

String getInputErrorPagePath(String application,
                             String service)
                      throws ServicePropertyException

非推奨です。 このメソッドではなくgetInputErrorPagePath(String, String, Locale)を使用してください。

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

パラメータ:

application - アプリケーションID

service - サービスID

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getInputErrorPagePath

String getInputErrorPagePath(String application,
                             String service,
                             Locale locale)
                      throws ServicePropertyException

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

パラメータ:

application - アプリケーションID

service - サービスID

locale - ロケール

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

導入されたバージョン:

4.2

getInputErrorPagePath

String getInputErrorPagePath(String application)
                      throws ServicePropertyException

非推奨です。 このメソッドではなくgetInputErrorPagePath(String, Locale)を使用してください。

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

パラメータ:

application - アプリケーションID

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getInputErrorPagePath

String getInputErrorPagePath(String application,
                             Locale locale)
                      throws ServicePropertyException

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

パラメータ:

application - アプリケーションID

locale - ロケール

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

導入されたバージョン:

4.2

getInputErrorPagePath

String getInputErrorPagePath()
                      throws ServicePropertyException

非推奨です。 このメソッドではなくgetInputErrorPagePath(Locale)を使用してください。

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

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getInputErrorPagePath

String getInputErrorPagePath(Locale locale)
                      throws ServicePropertyException

入力例外時のページのパスを取得します。

パラメータ:

locale - ロケール

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

導入されたバージョン:

4.2

getServiceErrorPagePath

String getServiceErrorPagePath(String application,
                               String service,
                               String key)
                        throws ServicePropertyException

非推奨です。 このメソッドではなくgetServiceErrorPagePath(String, String, String, Locale)を使用してください。

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

パラメータ:

application - アプリケーションID

service - サービスID

key - 遷移先のキー

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getServiceErrorPagePath

String getServiceErrorPagePath(String application,
                               String service,
                               String key,
                               Locale locale)
                        throws ServicePropertyException

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

パラメータ:

application - アプリケーションID

service - サービスID

key - 遷移先のキー

locale - ロケール

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

導入されたバージョン:

4.2

getServiceErrorPagePath

String getServiceErrorPagePath(String application,
                               String service)
                        throws ServicePropertyException

非推奨です。 このメソッドではなくgetServiceErrorPagePath(String, String, Locale)を使用してください。

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

パラメータ:

application - アプリケーションID

service - サービスID

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getServiceErrorPagePath

String getServiceErrorPagePath(String application,
                               String service,
                               Locale locale)
                        throws ServicePropertyException

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

パラメータ:

application - アプリケーションID

service - サービスID

locale - ロケール

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

導入されたバージョン:

4.2

getServiceErrorPagePath

String getServiceErrorPagePath(String application)
                        throws ServicePropertyException

非推奨です。 このメソッドではなくgetServiceErrorPagePath(String, Locale)を使用してください。

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

パラメータ:

application - アプリケーションID

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getServiceErrorPagePath

String getServiceErrorPagePath(String application,
                               Locale locale)
                        throws ServicePropertyException

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

パラメータ:

application - アプリケーションID

locale - ロケール

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

導入されたバージョン:

4.2

getServiceErrorPagePath

String getServiceErrorPagePath()
                        throws ServicePropertyException

非推奨です。 このメソッドではなくgetServiceErrorPagePath(Locale)を使用してください。

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

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getServiceErrorPagePath

String getServiceErrorPagePath(Locale locale)
                        throws ServicePropertyException

処理例外時のページのパスを取得します。

パラメータ:

locale - ロケール

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

導入されたバージョン:

4.2

getSystemErrorPagePath

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)を呼んだときと同じ結果になるように実装される必要があります。

パラメータ:

application - アプリケーションID

service - サービスID

key - 遷移先のキー

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getSystemErrorPagePath

String getSystemErrorPagePath(String application,
                              String service,
                              String key,
                              Locale locale)
                       throws ServicePropertyException

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

パラメータ:

application - アプリケーションID

service - サービスID

key - 遷移先のキー

locale - ロケール

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

導入されたバージョン:

4.2

getSystemErrorPagePath

String getSystemErrorPagePath(String application,
                              String service)
                       throws ServicePropertyException

非推奨です。 このメソッドではなくgetSystemErrorPagePath(String, String, Locale)を使用してください。

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

パラメータ:

application - アプリケーションID

service - サービスID

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getSystemErrorPagePath

String getSystemErrorPagePath(String application,
                              String service,
                              Locale locale)
                       throws ServicePropertyException

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

パラメータ:

application - アプリケーションID

service - サービスID

locale - ロケール

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

導入されたバージョン:

4.2

getSystemErrorPagePath

String getSystemErrorPagePath(String application)
                       throws ServicePropertyException

非推奨です。 このメソッドではなくgetSystemErrorPagePath(String, Locale)を使用してください。

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

パラメータ:

application - アプリケーションID

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getSystemErrorPagePath

String getSystemErrorPagePath(String application,
                              Locale locale)
                       throws ServicePropertyException

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

パラメータ:

application - アプリケーションID

locale - ロケール

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

導入されたバージョン:

4.2

getSystemErrorPagePath

String getSystemErrorPagePath()
                       throws ServicePropertyException

非推奨です。 このメソッドではなくgetSystemErrorPagePath(Locale)を使用してください。

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

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

getSystemErrorPagePath

String getSystemErrorPagePath(Locale locale)
                       throws ServicePropertyException

システム例外時のページのパスを取得します。

パラメータ:

locale - ロケール

戻り値:

遷移先のページのパス

例外:

ServicePropertyException - 遷移先のページのパスの取得時に例外が発生

導入されたバージョン:

4.2

getServiceControllerName

String getServiceControllerName(String application,
                                String service)
                         throws ServicePropertyException

非推奨です。 このメソッドではなくgetServiceControllerName(String, String, Locale)を使用してください。

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

パラメータ:

application - アプリケーションID

service - サービスID

戻り値:

サービスコントローラのクラス名、存在しない場合はnull

例外:

ServicePropertyException - サービスコントローラのクラス名の取得時に例外が発生

getServiceControllerName

String getServiceControllerName(String application,
                                String service,
                                Locale locale)
                         throws ServicePropertyException

サービスコントローラのクラス名を取得します。 該当するサービスコントローラが存在しない場合、nullを返します。

パラメータ:

application - アプリケーションID

service - サービスID

locale - ロケール

戻り値:

サービスコントローラのクラス名、存在しない場合はnull

例外:

ServicePropertyException - サービスコントローラのクラス名の取得時に例外が発生

導入されたバージョン:

4.2

getTransitionName

String getTransitionName(String application,
                         String service)
                  throws ServicePropertyException

非推奨です。 このメソッドではなくgetTransitionName(String, String, Locale)を使用してください。

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

パラメータ:

application - アプリケーションID

service - サービスID

戻り値:

トランジションのクラス名、設定されていない場合はnull

例外:

ServicePropertyException - トランジションのクラス名の取得時に例外が発生

getTransitionName

String getTransitionName(String application,
                         String service,
                         Locale locale)
                  throws ServicePropertyException

トランジションのクラス名を取得します。 指定されたアプリケーションIDとサービスIDに対応するトランジション名を取得します。 特に設定されていない場合、nullが返ります。

パラメータ:

application - アプリケーションID

service - サービスID

locale - ロケール

戻り値:

トランジションのクラス名、設定されていない場合はnull

例外:

ServicePropertyException - トランジションのクラス名の取得時に例外が発生

導入されたバージョン:

4.2

getControllerConverterName

String getControllerConverterName(String application,
                                  String service,
                                  Locale locale)
                           throws ServicePropertyException

コントローラコンバータのクラス名を取得します。 指定されたアプリケーションIDとサービスIDに対応するコントローラコンバータ名を取得します。 特に設定されていない場合、nullが返ります。

パラメータ:

application - アプリケーションID

service - サービスID

locale - ロケール

戻り値:

コントローラコンバータのクラス名、設定されていない場合はnull

例外:

ServicePropertyException - コントローラコンバータのクラス名の取得時に例外が発生

導入されたバージョン:

6.1

getControllerConverterConfig

ControllerConverterConfig getControllerConverterConfig(String application,
                                                       String service,
                                                       Locale locale)
                                                throws ServicePropertyException

キーに該当するコントローラコンバータの初期パラメータを取得します。

パラメータ:

application - アプリケーションID

service - サービスID

locale - ロケール

戻り値:

コントローラコンバータの初期パラメータ

例外:

ServicePropertyException - コントローラコンバータの初期パラメータの取得に失敗

導入されたバージョン:

6.1

getValidators

ValidatorMapping[] getValidators(String application,
                                 String service,
                                 Locale locale)
                          throws ServicePropertyException

キーに該当するバリデータを取得します。

パラメータ:

application - アプリケーションID

service - サービスID

locale - ロケール

戻り値:

コントローラコンバータの初期パラメータ

例外:

ServicePropertyException - バリデータの取得に失敗

導入されたバージョン:

6.1

getServiceServletPath

String getServiceServletPath()
                      throws ServicePropertyException

非推奨です。 この実装は廃止されました。

サービスサーブレットのパスを取得します。

戻り値:

サービスサーブレットのパス

例外:

ServicePropertyException - サービスサーブレットのパスの取得時に例外が発生

getContextPath

String getContextPath()
               throws ServicePropertyException

非推奨です。 このメソッドではなく、javax.servlet.http.HttpRequestのgetContextPathを使用するようにしてください。

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

戻り値:

コンテキストパス(設定されていない場合はnull)

例外:

ServicePropertyException - コンテキストパスの取得時に例外が発生

getApplicationParamName

String getApplicationParamName()
                        throws ServicePropertyException

非推奨です。 この実装は廃止されました。

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

戻り値:

アプリケーションIDに該当するパラメータ名

例外:

ServicePropertyException - アプリケーションIDに該当するパラメータ名の取得時に例外が発生

getServiceParamName

String getServiceParamName()
                    throws ServicePropertyException

非推奨です。 この実装は廃止されました。

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

戻り値:

サービスIDに該当するパラメータ名

例外:

ServicePropertyException - サービスIDに該当するパラメータ名の取得時に例外が発生

getExceptionAttributeName

String getExceptionAttributeName()
                          throws ServicePropertyException

例外ページに遷移するときにjavax.servlet.http.HttpServletRequestに例外情報を属性として追加する場合の属性名を取得します。

戻り値:

例外の属性名

例外:

ServicePropertyException - 属性名の取得時に例外が発生