パッケージ jakarta.servlet

インターフェース Registration

すべての既知のサブインターフェース:
FilterRegistration、FilterRegistration.Dynamic、Registration.Dynamic、ServletRegistration、ServletRegistration.Dynamic
public interface Registration
Servlet または Filter をさらに構成できるインターフェース。

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

導入:
Servlet 3.0

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

    ネストされたクラス
    修飾子と型
    インターフェース
    説明
    static interface
    Registration.Dynamic
    ServletContext 上の addServlet または addFilter のいずれかの方法で登録された Servlet または Filter をさらに構成できるインターフェース。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    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)
    この登録によって表されるサーブレットまたはフィルターに、指定された初期化パラメーターを設定します。

  • メソッドの詳細

    • getName

      StringSE getName()
      この登録によって表されるサーブレットまたはフィルターの名前を取得します。
      戻り値:
      この登録によって表されるサーブレットまたはフィルターの名前

    • getClassName

      StringSE getClassName()
      この登録によって表されるサーブレットまたはフィルターの完全修飾クラス名を取得します。
      戻り値:
      この登録で表されるサーブレットまたはフィルターの完全修飾クラス名。この登録が予備の場合は null

    • setInitParameter

      boolean setInitParameter(StringSE name, StringSE value)
      この登録で表されるサーブレットまたはフィルターの指定された名前と値で初期化パラメーターを設定します。
      パラメーター:
      name - 初期化パラメーター名
      value - 初期化パラメーター値
      戻り値:
      更新が成功した場合、つまり、指定された名前の初期化パラメーターが、この登録で表されているサーブレットまたはフィルターにまだ存在していない場合は true、そうでない場合は false
      例外:
      IllegalStateExceptionSE - この登録を取得した ServletContext がすでに初期化されている場合
      IllegalArgumentExceptionSE - 指定された名前または値が null の場合

    • getInitParameter

      StringSE getInitParameter(StringSE name)
      この Registration オブジェクトによって表されるサーブレットまたはフィルターを初期化するために使用される指定された名前の初期化パラメーターの値を取得します。
      パラメーター:
      name - 値がリクエストされている初期化パラメーターの名前
      戻り値:
      指定された名前の初期化パラメーターの値。指定された名前の初期化パラメーターが存在しない場合は null

    • setInitParameters

      SetSE<StringSE> setInitParameters(MapSE<StringSE,StringSE> initParameters)
      この登録によって表されるサーブレットまたはフィルターに、指定された初期化パラメーターを設定します。

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

      返されたセットは Registration オブジェクトによって支援されないため、返されたセットの変更は Registration オブジェクトに反映されず、その逆も同様です。

      パラメーター:
      initParameters - 初期化パラメーター
      戻り値:
      競合している初期化パラメーター名のセット（空の場合もある）
      例外:
      IllegalStateExceptionSE - この登録を取得した ServletContext がすでに初期化されている場合
      IllegalArgumentExceptionSE - 指定されたマップに null の名前または値を持つ初期化パラメーターが含まれている場合

    • getInitParameters

      MapSE<StringSE,StringSE> getInitParameters()
      この Registration オブジェクトによって表されるサーブレットまたはフィルターを初期化するために使用される、現在利用可能な初期化パラメーターを含む不変の（場合によっては空の）マップを取得します。
      戻り値:
      この登録オブジェクトによって表されるサーブレットまたはフィルターを初期化するために使用される現在利用可能な初期化パラメーターを含むマップ