|
FlatServe 0.3 |
||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Objectcom.small_it_office.flatserve.core.config.Config
public class Config
FlatServeに対する設定を表すクラスです。
FlatServeでは、設定をファイルに記述するのではなく、このクラスのオブジェクトに格納します。
ApplicationInitializer
クラスがこのクラスのオブジェクトを生成し、必要な設定値を格納します。
このオブジェクトに格納することができる設定項目は下記の通りです。
設定項目 | 説明 | 設定メソッド | デフォルト値 |
---|---|---|---|
リクエストエンコーディング | HTTPリクエストボディの文字エンコーディング。 リクエストのContent-Typeがapplication/x-www-form-urlencodedの場合のみ有効。 | setRequestEncoding(String) |
UTF-8 |
ロケール | H実行時のロケール。ログなどのメッセージに適用される。 | setLocale(Locale) |
システムのデフォルトロケール |
パッケージ名共通部 | HTTPサービスクラス全体に共通するパッケージの先頭部分の文字列。 たとえば、すべてのHTTPサービスクラスのパッケージがcom.foo.barで始まる場合、 "com.foo.bar"を設定することで、呼出URLを短縮することが可能。 | setPackageHeadName(String) |
なし |
サービスクラスマッピング | URIとHTTPサービスクラスのマッピング。 たとえば、"/foo"という文字列をfoo.Fooクラスにマッピングすると、 /contxtroot/foo/service.lsというURIでリクエストを受信した場合にfoo.Fooクラスのserviceメソッドが サービスメソッドとして実行される。 |
addRequestPathMapping(String, Class) ,
addRequestPathMapping(Map) ,
addRequestPathMapping(Properties)
|
なし |
プラグイン自動検出 |
クラスパス上のプラグインを自動で読み込む設定。
trueの場合は、クラスパス上にあるプラグインを全て自動的に読み込み、利用する。
falseの場合は、「プラグイン選択」(addAvailablePlugin(Class) )で指定したプラグイン以外は読み込まない。
|
setPluginAutoDetect(boolean)
|
true |
プラグイン選択 | 利用するプラグインの指定。 指定したプラグイン以外読み込まない。 ただし、「プラグイン自動検出」が有効な場合は無視される。 |
addAvailablePlugin(Class)
|
なし |
オプション設定 | プラグインで必要とする固有の設定オブジェクト。 | addOptionalConfig(Object) |
なし |
コンストラクタの概要 | |
---|---|
Config()
|
メソッドの概要 | ||
---|---|---|
void |
addAvailablePlugin(java.lang.Class<? extends Plugin> pluginClass)
適用するプラグインを指定します。 |
|
void |
addOptionalConfig(java.lang.Object config)
プラグインによるオプション設定を追加します。 |
|
void |
addRequestPathMapping(java.util.Map<java.lang.String,java.lang.Class<?>> mapping)
サービスクラスのマッピングを追加します。 |
|
void |
addRequestPathMapping(java.util.Properties properties)
HTTPサービスクラスのマッピングを追加します。 |
|
void |
addRequestPathMapping(java.lang.String requestPath,
java.lang.Class<?> serviceClass)
サービスクラスマッピングを追加します。 |
|
java.util.Locale |
getLocale()
実行時のロケールを返します。 |
|
|
getOptionalConfig(java.lang.Class<T> configType)
オプション設定を返します。 |
|
java.lang.String |
getPackageHeadName()
パッケージ名共通部の設定を返します。 |
|
java.lang.String |
getRequestEncoding()
リクエストエンコーディングの設定を返します。 |
|
boolean |
isAvailablePlugin(java.lang.String pluginClassName)
文字列で指定した名前のクラスが、適用されるプラグインとして指定されているかどうかを返します。 |
|
boolean |
isPluginAutoDetect()
プラグインをクラスパス上から自動的にプラグインを探し出すかどうかを返します。 |
|
java.lang.Class<?> |
pathToClass(java.lang.String requestPath)
サービスクラスマッピングが設定されている場合、リクエストパスに対するHTTPサービスクラスを返します。 |
|
void |
setLocale(java.util.Locale locale)
実行時のロケールを設定します。 |
|
void |
setPackageHeadName(java.lang.String packageHeadName)
パッケージ名共通部を設定します。 |
|
void |
setPluginAutoDetect(boolean autoDetect)
プラグインをクラスパス上から自動的にプラグインを探し出すかどうかを設定します。 |
|
void |
setRequestEncoding(java.lang.String requestEncoding)
リクエストエンコーディングを設定します。 |
|
java.lang.String |
toString()
このオブジェクトが持つ設定内容を文字列にして返します。 |
クラス java.lang.Object から継承されたメソッド |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
コンストラクタの詳細 |
---|
public Config()
メソッドの詳細 |
---|
public java.lang.String getPackageHeadName()
public java.lang.Class<?> pathToClass(java.lang.String requestPath)
requestPath
- リクエストパス
public java.lang.String getRequestEncoding()
public <T> T getOptionalConfig(java.lang.Class<T> configType)
T
- オプション設定オブジェクトの型configType
- オプション設定オブジェクトの型を表すクラス
public void addRequestPathMapping(java.lang.String requestPath, java.lang.Class<?> serviceClass)
requestPath
- リクエストパスserviceClass
- HTTPサービスクラスpublic void addRequestPathMapping(java.util.Map<java.lang.String,java.lang.Class<?>> mapping)
mapping
- リクエストパスとHTTPサービスクラスのマッピングpublic void addRequestPathMapping(java.util.Properties properties)
リクエストパス=HTTPサービスクラス名の形式である必要があります。 リクエストパスは、コンテキストルートの下の階層から、先頭に"/"を含めたものを設定します。
properties
- リクエストパスとHTTPサービスクラス名のマッピングpublic void setPackageHeadName(java.lang.String packageHeadName)
packageHeadName
- パッケージ名共通部public void setRequestEncoding(java.lang.String requestEncoding)
requestEncoding
- リクエストエンコーディングpublic java.util.Locale getLocale()
public void setLocale(java.util.Locale locale)
ログメッセージや例外メッセージをリソースバンドルとして読み込む際に、指定したロケールが適用されます。 設定しない場合、システムのデフォルトが適用されます。
ただし、アプリケーション初期化クラスの実行が完了するまでは、設定オブジェクトの内容が反映されないため、 必ずシステムのデフォルトロケールが適用されます。
locale
- 実行時のロケールpublic void addAvailablePlugin(java.lang.Class<? extends Plugin> pluginClass)
isPluginAutoDetect()
メソッドはfalseを返すように設定されます。
再度setPluginAutoDetect(boolean)
でtrueを設定した場合、
このメソッドによるプラグインの指定は無視されます。
pluginClass
- アプリケーションで使用するプラグインを表すクラスpublic boolean isAvailablePlugin(java.lang.String pluginClassName)
pluginClassName
- Plugin
インターフェースを実装したクラスの完全修飾名。
addAvailablePlugin(Class)
メソッドで追加されたクラスの名前であればtrue。public void setPluginAutoDetect(boolean autoDetect)
autoDetect
- trueならクラスパス上のプラグインをすべて読み込み・適用する。public boolean isPluginAutoDetect()
public void addOptionalConfig(java.lang.Object config)
config
- オプション設定オブジェクトpublic java.lang.String toString()
java.lang.Object
内の toString
|
FlatServe 0.3 |
||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |