public abstract class AbstractDispatcherServletInitializer extends AbstractContextLoaderInitializer
DispatcherServlet
をサーブレットコンテキストに登録する WebApplicationInitializer
実装の基本クラス。 ほとんどのアプリケーションでは、Spring Java config サブクラス AbstractAnnotationConfigDispatcherServletInitializer
の拡張を検討する必要があります。
修飾子と型 | フィールドと説明 |
---|---|
static StringSE | DEFAULT_SERVLET_NAME デフォルトのサーブレット名。 |
logger
コンストラクターと説明 |
---|
AbstractDispatcherServletInitializer() |
修飾子と型 | メソッドと説明 |
---|---|
protected FrameworkServlet | createDispatcherServlet(WebApplicationContext servletAppContext) |
protected abstract WebApplicationContext | createServletApplicationContext() DispatcherServlet に提供されるサーブレットアプリケーションコンテキストを作成します。 |
protected void | customizeRegistration(ServletRegistration.DynamicEE registration) registerDispatcherServlet(ServletContext) が完了したら、オプションでさらに登録のカスタマイズを実行します。 |
protected ApplicationContextInitializer<?>[] | getServletApplicationContextInitializers() DispatcherServlet が作成されるサーブレット固有のアプリケーションコンテキストに適用されるアプリケーションコンテキスト初期化子を指定します。 |
protected FilterEE[] | getServletFilters() DispatcherServlet に追加およびマップするフィルターを指定します。 |
protected abstract StringSE[] | getServletMappings() DispatcherServlet のサーブレットマッピングを指定します。たとえば、"/" 、"/app" など。 |
protected StringSE | getServletName() DispatcherServlet が登録される名前を返します。 |
protected boolean | isAsyncSupported() |
void | onStartup(ServletContextEE servletContext) この Web アプリケーションの初期化に必要なサーブレット、フィルター、リスナー context-params および属性を使用して、指定された ServletContext EE を構成します。 |
protected void | registerDispatcherServlet(ServletContextEE servletContext) 指定されたサーブレットコンテキストに対して DispatcherServlet を登録します。 |
protected FilterRegistration.DynamicEE | registerServletFilter(ServletContextEE servletContext, FilterEE filter) 指定されたフィルターを ServletContext に追加し、次のように DispatcherServlet にマッピングします。具象型に基づいてデフォルトのフィルター名が選択されます。asyncSupported フラグは asyncSupported の戻り値に応じて設定されます。asyncSupported の戻り値に応じて条件付きで ASYNC REQUEST 、FORWARD 、INCLUDE |
createRootApplicationContext, getRootApplicationContextInitializers, registerContextLoaderListener
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
public static final StringSE DEFAULT_SERVLET_NAME
getServletName()
をオーバーライドしてカスタマイズできます。public void onStartup(ServletContextEE servletContext) throws ServletExceptionEE
WebApplicationInitializer
ServletContext
EE を構成します。上記の例を参照してください。WebApplicationInitializer
の onStartup
AbstractContextLoaderInitializer
の onStartup
servletContext
- 初期化する ServletContext
ServletExceptionEE
- 指定された ServletContext
に対する呼び出しが ServletException
をスローした場合 protected void registerDispatcherServlet(ServletContextEE servletContext)
DispatcherServlet
を登録します。 このメソッドは、getServletName()
から返された名前で DispatcherServlet
を作成し、createServletApplicationContext()
から返されたアプリケーションコンテキストで初期化し、getServletMappings()
から返されたパターンにマッピングします。
customizeRegistration(ServletRegistration.Dynamic)
または createDispatcherServlet(WebApplicationContext)
をオーバーライドすることにより、さらにカスタマイズできます。
servletContext
- サーブレットを登録するコンテキスト protected StringSE getServletName()
DispatcherServlet
が登録される名前を返します。デフォルトは DEFAULT_SERVLET_NAME
です。protected abstract WebApplicationContext createServletApplicationContext()
DispatcherServlet
に提供されるサーブレットアプリケーションコンテキストを作成します。 返されたコンテキストは、Spring の DispatcherServlet(WebApplicationContext)
に委譲されます。そのため、通常、コントローラー、ビューリゾルバー、ロケールリゾルバー、その他の Web 関連の Bean が含まれます。
protected FrameworkServlet createDispatcherServlet(WebApplicationContext servletAppContext)
WebApplicationContext
で DispatcherServlet
(または他の種類の FrameworkServlet
-derived ディスパッチャー)を作成します。 メモ: これにより、4.2.3 以降の FrameworkServlet
サブクラスが許可されます。以前は、DispatcherServlet
またはそのサブクラスを返すことを主張していました。
@Nullable protected ApplicationContextInitializer<?>[] getServletApplicationContextInitializers()
DispatcherServlet
が作成されるサーブレット固有のアプリケーションコンテキストに適用されるアプリケーションコンテキスト初期化子を指定します。protected abstract StringSE[] getServletMappings()
DispatcherServlet
のサーブレットマッピングを指定します。たとえば、"/"
、"/app"
など。@Nullable protected FilterEE[] getServletFilters()
DispatcherServlet
に追加およびマップするフィルターを指定します。null
の配列 registerServletFilter(ServletContext, Filter)
protected FilterRegistration.DynamicEE registerServletFilter(ServletContextEE servletContext, FilterEE filter)
DispatcherServlet
にマップします。asyncSupported
フラグは、asyncSupported
の戻り値に応じて設定されます asyncSupported
の戻り値に応じて、ディスパッチャー型 REQUEST
、FORWARD
、INCLUDE
および条件付き ASYNC
でフィルターマッピングが作成されます。 上記のデフォルトが適切でないか不十分である場合、このメソッドをオーバーライドし、ServletContext
でフィルターを直接登録します。
servletContext
- フィルターを登録するサーブレットコンテキスト filter
- 登録するフィルター protected boolean isAsyncSupported()
DispatcherServlet
の asyncSupported
フラグと getServletFilters()
を介して追加されたすべてのフィルターを制御する単一の場所。デフォルト値は "true" です。
protected void customizeRegistration(ServletRegistration.DynamicEE registration)
registerDispatcherServlet(ServletContext)
が完了したら、オプションでさらに登録のカスタマイズを実行します。registration
- カスタマイズする DispatcherServlet
登録 registerDispatcherServlet(ServletContext)