javax.servlet

インタフェース Registration

既知のサブインタフェースのリスト:

FilterRegistration, FilterRegistration.Dynamic, Registration.Dynamic, ServletRegistration, ServletRegistration.Dynamic

public interface Registration

ServletやFilter に詳細な構成をするためのインターフェース。

getClassName()メソッドがnullを返す登録オブジェクトは準備段階とみなされます。 サーブレットとフィルタのコンテナ実装固有のクラスは、それぞれservlet-classまたはfilter-class要素なしで宣言され、 事前登録(Registration:登録)オブジェクトとして表されます。 事前登録はServletContextのaddServletメソッドまたはaddFilterメソッドの1つを呼び出し、 サポートするサーブレットまたはフィルターの実装クラス名、クラスオブジェクトかインスタンス、 それらと一緒にサーブレット名またはフィルター名（getName()を使用して取得される)を渡すことによって完了する必要があります。 ほとんどの場合、事前登録はコンテナ提供の適切なServletContainerInitializerによって完了されます。

導入されたバージョン:

Servlet 3.0

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	インタフェースと説明
static interface	Registration.Dynamic ServletContextのaddServletメソッドまたはaddFilterメソッドの1つを使用して登録された ServletまたはFilterを詳細に構成するためのインターフェース。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
String	getClassName() このRegistrationによって表されるサーブレットまたはフィルターの完全修飾クラス名(FQCN)を取得します。
String	getInitParameter(String name) このRegistrationオブジェクトによって表されるサーブレットまたはフィルターを初期化するために使用される指定された名前を持つ初期化パラメータの値を取得します。
Map<String,String>	getInitParameters() このRegistrationオブジェクトによって表されるサーブレットまたはフィルターを初期化するために使用される 現在使用可能な初期化パラメータを含む不変の(空の可能性がある)Mapを取得します。
String	getName() このRegistrationによって表されるサーブレットまたはフィルターの名前を取得します。
boolean	setInitParameter(String name, String value) 指定された名前と値を持つ初期化パラメーターをこのRegistrationで表されるサーブレットまたはフィルターに設定します。
Set<String>	setInitParameters(Map<String,String> initParameters) 指定された初期化パラメータをこのRegistrationによって表されるサーブレットまたはフィルターに設定します。

メソッドの詳細

getName

String getName()

このRegistrationによって表されるサーブレットまたはフィルターの名前を取得します。

戻り値:

このRegistrationによって表されるサーブレットまたはフィルタの名前

getClassName

String getClassName()

このRegistrationによって表されるサーブレットまたはフィルターの完全修飾クラス名(FQCN)を取得します。

戻り値:

このRegistrationによって表されるサーブレットまたはフィルタの完全修飾クラス名、このRegistrationが事前登録状態である場合はnull

setInitParameter

boolean setInitParameter(String name,
                         String value)

指定された名前と値を持つ初期化パラメーターをこのRegistrationで表されるサーブレットまたはフィルターに設定します。

パラメータ:

name - 初期化パラメーター名

value - 初期化パラメーターの値

戻り値:

更新が成功した場合、つまり指定された名前を持つ初期化パラメータがこのRegistrationで表されるサーブレットまたはフィルターに存在しない場合はtrue、そうでない場合はfalse

例外:

IllegalStateException - この登録が取得されたServletContextがすでに初期化されている場合

IllegalArgumentException - 指定された名前または値がnullの場合

getInitParameter

String getInitParameter(String name)

このRegistrationオブジェクトによって表されるサーブレットまたはフィルターを初期化するために使用される指定された名前を持つ初期化パラメータの値を取得します。

パラメータ:

name - 値が要求されている初期化パラメータの名前

戻り値:

指定された名前を持つ初期化パラメータの値、指定された名前を持つ初期化パラメータが存在しない場合はnull

setInitParameters

Set<String> setInitParameters(Map<String,String> initParameters)

指定された初期化パラメータをこのRegistrationによって表されるサーブレットまたはフィルターに設定します。

初期化パラメータの指定されたMapは、 値毎に処理されます。 つまり、Mapに含まれる各初期化パラメータについて、このメソッドはsetInitParameter(String,String)を呼び出します。 このメソッドが指定されたMapのいずれかの初期化パラメータに対してfalseを返すと、更新は実行されず、このメソッドの戻り値として返されます。 同様に、Mapにnullの名前または値を持つ初期化パラメータが含まれている場合、更新は実行されず、IllegalArgumentExceptionが投げられます。

返されたSetはRegistrationオブジェクトによって追跡されていないため、返されたSetへの変更はRegistrationオブジェクトに反映されず、その逆もそうです。

パラメータ:

initParameters - 初期化パラメーター

戻り値:

コンフリクトした初期化パラメーターの(空の可能性がある)Set

例外:

IllegalStateException - このRegistratioが取得されたServletContextがすでに初期化されている場合

IllegalArgumentException - 指定されたMapにnullの名前または値を持つ初期化パラメータを含まれていた場合

getInitParameters

Map<String,String> getInitParameters()

このRegistrationオブジェクトによって表されるサーブレットまたはフィルターを初期化するために使用される 現在使用可能な初期化パラメータを含む不変の(空の可能性がある)Mapを取得します。

戻り値:

このRegistrationオブジェクトによって表されるサーブレットまたはフィルターを初期化するために使用される 現在利用可能な初期化パラメータを含むMap