パッケージ jakarta.servlet

インターフェース ServletRegistration.Dynamic

すべてのスーパーインターフェース:
RegistrationRegistration.DynamicServletRegistration
含まれているインターフェース:
ServletRegistration

public static interface ServletRegistration.Dynamic extends ServletRegistration, Registration.Dynamic
ServletContext 上の addServlet メソッドの 1 つを介して登録された Servlet をさらに構成できるインターフェース。
  • メソッドの詳細

    • setLoadOnStartup

      void setLoadOnStartup(int loadOnStartup)
      この動的 ServletRegistration によって表されるサーブレットに loadOnStartup 優先順位を設定します。

      loadOnStartup 値がゼロ以上の場合、サーブレットの初期化優先度がコンテナーに示されます。この場合、コンテナーは、ServletContext の初期化フェーズ中に、つまり、ServletContext 用に構成されたすべての ServletContextListener オブジェクトを ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent) メソッドで呼び出した後で、サーブレットをインスタンス化して初期化する必要があります。

      loadOnStartup が負の整数の場合、コンテナーはサーブレットを遅延してインスタンス化および初期化できます。

      loadOnStartup のデフォルト値は -1 です。

      このメソッドの呼び出しは、以前の設定をオーバーライドします。

      パラメーター:
      loadOnStartup - サーブレットの初期化優先順位
      例外:
      IllegalStateExceptionSE - この ServletRegistration の取得元の ServletContext がすでに初期化されている場合
    • setServletSecurity

      SetSE<StringSE> setServletSecurity(ServletSecurityElement constraint)
      この ServletRegistration に定義されたマッピングに適用される ServletSecurityElement を設定します。

      このメソッドは、取得元の ServletContext が初期化されるまで、この ServletRegistration に追加されたすべてのマッピングに適用されます。

      この ServletRegistration の URL パターンが、ポータブルデプロイ記述子を介して確立された security-constraint の正確なターゲットである場合、このメソッドはそのパターンの security-constraint を変更せず、パターンは戻り値に含まれます。

      この ServletRegistration の URL パターンが、ServletSecurity アノテーションまたはこのメソッドへの以前の呼び出しによって確立されたセキュリティ制約の正確なターゲットである場合、このメソッドはそのパターンのセキュリティ制約を置き換えます。

      この ServletRegistration の URL パターンが、ServletSecurity アノテーションまたはこのメソッドへの以前の呼び出しを介して確立されたセキュリティ制約の正確なターゲットでも、移植可能なデプロイ記述子内の security-constraint の正確なターゲットでもない場合、このメソッドはセキュリティを確立します。引数 ServletSecurityElement からのそのパターンの制約。

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

      パラメーター:
      constraint - この ServletRegistration にマップされたパターンに適用される ServletSecurityElement
      戻り値:
      ポータブルデプロイ記述子によって確立された security-constraint の正確なターゲットであった URL パターンのセット(空の場合もある)。このメソッドは、返されたセットに含まれるパターンには影響しません
      例外:
      IllegalArgumentExceptionSE - constraint が null の場合
      IllegalStateExceptionSE - この ServletRegistration の取得元の ServletContext がすでに初期化されている場合
    • setMultipartConfig

      void setMultipartConfig(MultipartConfigElement multipartConfig)
      この ServletRegistration に定義されたマッピングに適用される MultipartConfigElement を設定します。このメソッドが複数回呼び出された場合、連続する呼び出しごとに前者の効果がオーバーライドされます。
      パラメーター:
      multipartConfig - 登録にマップされたパターンに適用される MultipartConfigElement
      例外:
      IllegalArgumentExceptionSE - multipartConfig が null の場合
      IllegalStateExceptionSE - この ServletRegistration の取得元の ServletContext がすでに初期化されている場合
    • setRunAsRole

      void setRunAsRole(StringSE roleName)
      この ServletRegistration の runAs ロールの名前を設定します。
      パラメーター:
      roleName - runAs ロールの名前
      例外:
      IllegalArgumentExceptionSE - roleName が null の場合
      IllegalStateExceptionSE - この ServletRegistration の取得元の ServletContext がすでに初期化されている場合