public interface Registration
Servlet
または Filter
をさらに構成できるインターフェース。getClassName()
メソッドが null を返す Registration オブジェクトは準備ものと見なされます。実装クラスがコンテナー実装固有であるサーブレットとフィルターは、それぞれサーブレットクラスまたはフィルタークラス要素なしで宣言でき、予備の登録オブジェクトとして表されます。ServletContext
で addServlet メソッドまたは addFilter メソッドのいずれかを呼び出し、サポートするサーブレットまたはフィルターの実装クラス名、クラスオブジェクト、インスタンスとともに、サーブレット名またはフィルター名(getName()
を介して取得)を渡すことにより、予備登録を完了する必要があります。ほとんどの場合、予備登録はコンテナーが提供する適切な ServletContainerInitializer
によって行われます。
修飾子と型 | インターフェースと説明 |
---|---|
static interface | Registration.Dynamic Servlet または Filter がそれぞれ ServletContext の addServlet メソッドまたは addFilter メソッドのいずれかを介して登録されるインターフェースをさらに構成できます。 |
修飾子と型 | メソッドと説明 |
---|---|
StringSE | getClassName() この登録によって表されるサーブレットまたはフィルターの完全修飾クラス名を取得します。 |
StringSE | getInitParameter(StringSE name) この Registration オブジェクトによって表されるサーブレットまたはフィルターを初期化するために使用される指定された名前の初期化パラメーターの値を取得します。 |
MapSE<StringSE, StringSE> | getInitParameters() この Registration オブジェクトによって表されるサーブレットまたはフィルターを初期化するために使用される、現在利用可能な初期化パラメーターを含む不変の(場合によっては空の)マップを取得します。 |
StringSE | getName() この登録によって表されるサーブレットまたはフィルターの名前を取得します。 |
boolean | setInitParameter(StringSE name, StringSE value) この登録で表されるサーブレットまたはフィルターの指定された名前と値で初期化パラメーターを設定します。 |
SetSE<StringSE> | setInitParameters(MapSE<StringSE, StringSE> initParameters) この登録によって表されるサーブレットまたはフィルターに、指定された初期化パラメーターを設定します。 |
StringSE getName()
StringSE getClassName()
boolean setInitParameter(StringSE name, StringSE value)
name
- 初期化パラメーター名 value
- 初期化パラメーター値 IllegalStateExceptionSE
- この登録を取得した ServletContext がすでに初期化されている場合 IllegalArgumentExceptionSE
- 指定された名前または値が null の場合 StringSE getInitParameter(StringSE name)
name
- 値がリクエストされている初期化パラメーターの名前 SetSE<StringSE> setInitParameters(MapSE<StringSE,StringSE> initParameters)
指定された初期化パラメーターのマップは値ごとに処理されます。つまり、マップに含まれる各初期化パラメーターについて、このメソッドは setInitParameter(String,String)
を呼び出します。指定されたマップの初期化パラメーターのいずれかでそのメソッドが false を返す場合、更新は実行されず、false が返されます。同様に、名前または値が null の初期化パラメーターがマップに含まれている場合、更新は実行されず、IllegalArgumentException がスローされます。
返されたセットは Registration
オブジェクトによって支援されないため、返されたセットの変更は Registration
オブジェクトに反映されず、その逆も同様です。
initParameters
- 初期化パラメーター IllegalStateExceptionSE
- この登録を取得した ServletContext がすでに初期化されている場合 IllegalArgumentExceptionSE
- 指定されたマップに null の名前または値を持つ初期化パラメーターが含まれている場合 Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.