パッケージ jakarta.servlet

インターフェース ServletRegistration

すべてのスーパーインターフェース:
Registration
すべての既知のサブインターフェース:
ServletRegistration.Dynamic

public interface ServletRegistration extends Registration
Servlet をさらに構成できるインターフェース。
導入:
Servlet 3.0
  • ネストされたクラスのサマリー

    ネストされたクラス
    修飾子と型
    インターフェース
    説明
    static interface
    ServletContext 上の addServlet メソッドの 1 つを介して登録された Servlet をさらに構成できるインターフェース。
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    addMapping(StringSE... urlPatterns)
    この ServletRegistration によって表されるサーブレットの指定された URL パターンでサーブレットマッピングを追加します。
    この ServletRegistration によって表されるサーブレットの現在利用可能なマッピングを取得します。
    この ServletRegistration によって表されるサーブレットの runAs ロールの名前を取得します。

    インターフェース jakarta.servlet.Registration から継承されたメソッド

    getClassName, getInitParameter, getInitParameters, getName, setInitParameter, setInitParameters
  • メソッドの詳細

    • addMapping

      SetSE<StringSE> addMapping(StringSE... urlPatterns)
      この ServletRegistration によって表されるサーブレットの指定された URL パターンでサーブレットマッピングを追加します。

      指定された URL パターンのいずれかがすでに別のサーブレットにマップされている場合、更新は実行されません。

      このメソッドが複数回呼び出される場合、連続する呼び出しごとに前者の効果が追加されます。

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

      パラメーター:
      urlPatterns - サーブレットマッピングの URL パターン
      戻り値:
      (おそらく空の)異なるサーブレットにすでにマップされている URL パターンのセット
      例外:
      IllegalArgumentExceptionSE - urlPatterns が null または空の場合
      IllegalStateExceptionSE - この ServletRegistration の取得元の ServletContext がすでに初期化されている場合
    • getMappings

      CollectionSE<StringSE> getMappings()
      この ServletRegistration によって表されるサーブレットの現在利用可能なマッピングを取得します。

      許可されている場合、返された Collection への変更は、この ServletRegistration に影響してはなりません。

      戻り値:
      この ServletRegistration によって表されるサーブレットの現在利用可能なマッピングの(おそらく空の) Collection 
    • getRunAsRole

      StringSE getRunAsRole()
      この ServletRegistration によって表されるサーブレットの runAs ロールの名前を取得します。
      戻り値:
      runAs ロールの名前、またはサーブレットが呼び出し元として実行されるように構成されている場合は null