javax.servlet

インタフェース ServletContainerInitializer

public interface ServletContainerInitializer

Webアプリケーションの起動フェーズがライブラリ/ランタイムに通知され、それに応じてサーブレットやフィルター、リスナーの必要とするプログラマティックな登録を実行するためのインターフェースです。

このインターフェースの実装にはHandlesTypesアノテーションを付けることができ、 アノテーションによって指定されたクラスタイプを実装、拡張、またはアノテーションをつけられたアプリケーションクラスのSetを(onStartup(Set, ServletContext)メソッドで)受け取るために使用します。

このインターフェースの実装がHandlesTypesアノテーションを使用しない場合、またはアプリケーション内のクラスのどれもがアノテーションで指定されたものと一致しない場合は コンテナはクラスのSetとしてnullをonStartup(Set, ServletContext)に渡します。

アプリケーションのクラスを調べてServletContainerInitializerのHandlesTypesアノテーションで指定された基準と一致するかどうかを確認するときに、 コンテナはアプリケーションのオプショナルなJARファイルが見つからない場合にクラスローディングの問題に遭遇する可能性があります。 コンテナはこれらのタイプのクラスローディングの失敗がアプリケーションの正常な動作を妨げるかどうかを判断する立場にないため、それらを無視する必要があると同時にログを記録するような設定オプションを提供します。

このインターフェースの実装はJARファイル内のMETA-INF/servicesディレクトリにあるこのインターフェースの完全修飾クラス名の名前が付けられたリソースによって宣言され、 ランタイムのサービスプロバイダルックアップメカニズムまたはそれと意味的に同等のコンテナ固有のメカニズムを使用して検出されます。 どちらの場合でも、絶対順序から除外されたWebフラグメントJARファイルのServletContainerInitializerサービスは無視する必要があり、 これらのサービスが検出される順序はアプリケーションのクラスローダー委譲モデルに従う必要があります。

導入されたバージョン:

Servlet 3.0

関連項目:

HandlesTypes

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	onStartup(Set<Class<?>> c, ServletContext ctx) 与えられたServletContextが表すアプリケーションの起動をこのServletContainerInitializerに通知します。

メソッドの詳細

onStartup

void onStartup(Set<Class<?>> c,
               ServletContext ctx)
        throws ServletException

与えられたServletContextが表すアプリケーションの起動をこのServletContainerInitializerに通知します。

このServletContainerInitializerがアプリケーションのWEB-INF/lib内のJARファイルに入っているならば、 このonStartupメソッドは含まれているアプリケーションの起動中に1回だけ実行されるでしょう。 このServletContainerInitializerがWEB-INF/libディレクトリ以外のJARファイルに入っているが、 上記のように引き続き発見可能であるならば、このonStartup はアプリケーションが起動するたびに実行されるでしょう。

パラメータ:

c - HandlesTypesアノテーションで指定されたクラス型を拡張もしくは実装、またはアノテーションのつけられたアプリケーション内のクラスのSet、 一致するものがない、またはこのServletContainerInitializerにHandlesTypesアノテーションが付けられていない場合はnull

ctx - 起動中にcに含まれるクラスが見つかったウェブアプリケーションのServletContext

例外:

ServletException - エラーが発生した場合