クラス AbstractDispatcherServletInitializer

メソッドの詳細

• onStartup

  public void onStartup(jakarta.servlet.ServletContext servletContext) throws jakarta.servlet.ServletException

  インターフェースからコピーされた説明: WebApplicationInitializer

  指定された ServletContext に、この Web アプリケーションの初期化に必要なサーブレット、フィルター、リスナー、コンテキストパラメーター、属性を設定します。上記の例を参照してください。

  次で指定:

  インターフェース WebApplicationInitializer の onStartup 

  オーバーライド:

  クラス AbstractContextLoaderInitializer の onStartup 

  パラメーター:

  servletContext - 初期化する ServletContext 

  例外:

  jakarta.servlet.ServletException - 指定された ServletContext に対する呼び出しが ServletException をスローした場合

• registerDispatcherServlet

  protected void registerDispatcherServlet(jakarta.servlet.ServletContext servletContext)

  指定されたサーブレットコンテキストに対して DispatcherServlet を登録します。

  このメソッドは、getServletName() から返された名前で DispatcherServlet を作成し、createServletApplicationContext() から返されたアプリケーションコンテキストで初期化し、getServletMappings() から返されたパターンにマッピングします。

  customizeRegistration(ServletRegistration.Dynamic) または createDispatcherServlet(WebApplicationContext) をオーバーライドすることにより、さらにカスタマイズできます。

  パラメーター:

  servletContext - サーブレットを登録するコンテキスト

• getServletName

  protected StringSE getServletName()

  DispatcherServlet が登録される名前を返します。デフォルトは DEFAULT_SERVLET_NAME です。

  関連事項:

  • registerDispatcherServlet(ServletContext)

• createServletApplicationContext

  protected abstract WebApplicationContext createServletApplicationContext()

  DispatcherServlet に提供されるサーブレットアプリケーションコンテキストを作成します。

  返されたコンテキストは、Spring の DispatcherServlet(WebApplicationContext) に委譲されます。そのため、通常、コントローラー、ビューリゾルバー、ロケールリゾルバー、その他の Web 関連の Bean が含まれます。

  関連事項:

  • registerDispatcherServlet(ServletContext)

• createDispatcherServlet

  protected FrameworkServlet createDispatcherServlet(WebApplicationContext servletAppContext)

  指定された WebApplicationContext で DispatcherServlet（または他の種類の FrameworkServlet -derived ディスパッチャー）を作成します。

  メモ: これにより、4.2.3 以降の FrameworkServlet サブクラスが許可されます。以前は、DispatcherServlet またはそのサブクラスを返すことを主張していました。

• getServletApplicationContextInitializers

  protected ApplicationContextInitializer<?> @Nullable [] getServletApplicationContextInitializers()

  DispatcherServlet が作成されるサーブレット固有のアプリケーションコンテキストに適用されるアプリケーションコンテキスト初期化子を指定します。

  導入:

  4.2

  関連事項:

  • createServletApplicationContext()
  • FrameworkServlet.setContextInitializers(ApplicationContextInitializer...)
  • AbstractContextLoaderInitializer.getRootApplicationContextInitializers()

• getServletMappings

  protected abstract StringSE[] getServletMappings()

  DispatcherServlet のサーブレットマッピングを指定します。たとえば、"/"、"/app" など。

  関連事項:

  • registerDispatcherServlet(ServletContext)

• getServletFilters

  protected jakarta.servlet.Filter @Nullable [] getServletFilters()

  DispatcherServlet に追加およびマップするフィルターを指定します。

  戻り値:

  フィルターまたは null の配列

  関連事項:

  • registerServletFilter(ServletContext, Filter)

• registerServletFilter

  protected jakarta.servlet.FilterRegistration.Dynamic registerServletFilter(jakarta.servlet.ServletContext servletContext, jakarta.servlet.Filter filter)

  指定されたフィルターを ServletContext に追加し、次のように DispatcherServlet にマップします。

  • デフォルトのフィルター名は、その具象型に基づいて選択されます
  • asyncSupported フラグは、asyncSupported の戻り値に応じて設定されます
  • asyncSupported の戻り値に応じて、ディスパッチャー型 REQUEST、FORWARD、INCLUDE および条件付き ASYNC でフィルターマッピングが作成されます。

  上記のデフォルトが適切でないか不十分である場合、このメソッドをオーバーライドし、ServletContext でフィルターを直接登録します。

  パラメーター:

  servletContext - フィルターを登録するサーブレットコンテキスト

  filter - 登録するフィルター

  戻り値:

  フィルター登録

• isAsyncSupported

  protected boolean isAsyncSupported()

  DispatcherServlet の asyncSupported フラグと getServletFilters() を介して追加されたすべてのフィルターを制御する単一の場所。

  デフォルト値は "true" です。

• customizeRegistration

  protected void customizeRegistration(jakarta.servlet.ServletRegistration.Dynamic registration)

  registerDispatcherServlet(ServletContext) が完了したら、オプションでさらに登録のカスタマイズを実行します。

  パラメーター:

  registration - カスタマイズする DispatcherServlet 登録

  関連事項:

  • registerDispatcherServlet(ServletContext)