フィールドの詳細

• CONTEXT_ID_PARAM

  public static final StringSE CONTEXT_ID_PARAM

  ルート WebApplicationContext ID の構成パラメーター。基礎となる BeanFactory の直列化 ID として使用されます: "contextId"。

  関連事項:

  定数フィールド値

• CONFIG_LOCATION_PARAM

  public static final StringSE CONFIG_LOCATION_PARAM

  ルートコンテキストの構成場所を指定できるサーブレットコンテキストパラメーターの名前（ "contextConfigLocation" ）。それ以外の場合は、実装のデフォルトにフォールバックします。

  関連事項:

  XmlWebApplicationContext.DEFAULT_CONFIG_LOCATION, 定数フィールド値

• CONTEXT_CLASS_PARAM

  public static final StringSE CONTEXT_CLASS_PARAM

  使用するルート WebApplicationContext 実装クラスの構成パラメーター: "contextClass"。

  関連事項:

  determineContextClass(ServletContext), 定数フィールド値

• CONTEXT_INITIALIZER_CLASSES_PARAM

  public static final StringSE CONTEXT_INITIALIZER_CLASSES_PARAM

  ルート Web アプリケーションコンテキストの初期化に使用する ApplicationContextInitializer クラスの構成パラメーター: "contextInitializerClasses"。

  関連事項:

  customizeContext(ServletContext, ConfigurableWebApplicationContext), 定数フィールド値

• GLOBAL_INITIALIZER_CLASSES_PARAM

  public static final StringSE GLOBAL_INITIALIZER_CLASSES_PARAM

  現在のアプリケーション内のすべての Web アプリケーションコンテキストを初期化するために使用するグローバル ApplicationContextInitializer クラスの構成パラメーター: "globalInitializerClasses"。

  関連事項:

  customizeContext(ServletContext, ConfigurableWebApplicationContext), 定数フィールド値

コンストラクターの詳細

• ContextLoader

  public ContextLoader()

  "contextClass" および "contextConfigLocation" サーブレットの context-params に基づいて Web アプリケーションコンテキストを作成する新しい ContextLoader を作成します。それぞれのデフォルト値の詳細については、クラスレベルのドキュメントを参照してください。

  このコンストラクターは通常、引数なしのコンストラクターが必要であるため、ContextLoaderListener サブクラスを web.xml 内の <listener> として宣言するときに使用されます。

  作成されたアプリケーションコンテキストは属性名 WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE で ServletContext に登録され、サブクラスはコンテナーのシャットダウン時に closeWebApplicationContext(javax.servlet.ServletContext) メソッドを自由に呼び出してアプリケーションコンテキストを閉じることができます。

  関連事項:

  ContextLoader(WebApplicationContext), initWebApplicationContext(ServletContext), closeWebApplicationContext(ServletContext)

• ContextLoader

  public ContextLoader(WebApplicationContext context)

  指定されたアプリケーションコンテキストで新しい ContextLoader を作成します。このコンストラクターは、ServletContext.addListener(java.lang.String)EE API を介してリスナーのインスタンスベースの登録が可能な Servlet 3.0+ 環境で役立ちます。

  コンテキストはまだリフレッシュされている場合とされていない場合があります。（a）ConfigurableWebApplicationContext の実装であり、（b）がまだリフレッシュされていない場合（推奨されるアプローチ）、次のことが発生します。

  • 指定されたコンテキストにまだ id が割り当てられていない場合、1 つが割り当てられます
  • ServletContext および ServletConfig オブジェクトは、アプリケーションコンテキストに委譲されます。
  • customizeContext(javax.servlet.ServletContext, org.springframework.web.context.ConfigurableWebApplicationContext) が呼び出されます
  • "contextInitializerClasses" init-param で指定された ApplicationContextInitializers が適用されます。
  • refresh() が呼び出されます

  コンテキストがすでにリフレッシュされているか、ConfigurableWebApplicationContext を実装していない場合、ユーザーが特定のニーズに応じてこれらのアクションを実行した（または実行しない）という仮定では、上記のいずれも発生しません。

  使用例については、WebApplicationInitializer を参照してください。

  いずれの場合も、指定されたアプリケーションコンテキストは属性名 WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE で ServletContext に登録され、サブクラスはコンテナーのシャットダウン時に closeWebApplicationContext(javax.servlet.ServletContext) メソッドを自由に呼び出してアプリケーションコンテキストを閉じることができます。

  パラメーター:

  context - 管理するアプリケーションコンテキスト

  関連事項:

  initWebApplicationContext(ServletContext), closeWebApplicationContext(ServletContext)

メソッドの詳細

• setContextInitializers

  public void setContextInitializers(@Nullable
                                     ApplicationContextInitializer<?>... initializers)

  この ContextLoader で使用されるアプリケーションコンテキストを初期化するために使用する ApplicationContextInitializer インスタンスを指定します。

  導入:

  4.2

  関連事項:

  configureAndRefreshWebApplicationContext(org.springframework.web.context.ConfigurableWebApplicationContext, javax.servlet.ServletContext), customizeContext(javax.servlet.ServletContext, org.springframework.web.context.ConfigurableWebApplicationContext)

• initWebApplicationContext

  public WebApplicationContext initWebApplicationContext(ServletContextEE servletContext)

  構築時に提供されたアプリケーションコンテキストを使用して、指定されたサーブレットコンテキストの Spring の Web アプリケーションコンテキストを初期化するか、"contextClass" および "contextConfigLocation" context-params に従って新しいものを作成します。

  パラメーター:

  servletContext - 現在のサーブレットコンテキスト

  戻り値:

  新しい WebApplicationContext

  関連事項:

  ContextLoader(WebApplicationContext), CONTEXT_CLASS_PARAM, CONFIG_LOCATION_PARAM

• createWebApplicationContext

  protected WebApplicationContext createWebApplicationContext(ServletContextEE sc)

  このローダーのルート WebApplicationContext を、デフォルトのコンテキストクラスまたは指定されている場合はカスタムコンテキストクラスのいずれかでインスタンス化します。

  この実装は、カスタムコンテキストが ConfigurableWebApplicationContext インターフェースを実装することを期待しています。サブクラスでオーバーライドできます。

  さらに、customizeContext(javax.servlet.ServletContext, org.springframework.web.context.ConfigurableWebApplicationContext) はコンテキストをリフレッシュする前に呼び出されるため、サブクラスはコンテキストにカスタム変更を実行できます。

  パラメーター:

  sc - 現在のサーブレットコンテキスト

  戻り値:

  ルート WebApplicationContext

  関連事項:

  ConfigurableWebApplicationContext

• determineContextClass

  protected ClassSE<?> determineContextClass(ServletContextEE servletContext)

  使用する WebApplicationContext 実装クラス（デフォルトの XmlWebApplicationContext または指定されている場合はカスタムコンテキストクラス）を返します。

  パラメーター:

  servletContext - 現在のサーブレットコンテキスト

  戻り値:

  使用する WebApplicationContext 実装クラス

  関連事項:

  CONTEXT_CLASS_PARAM, XmlWebApplicationContext

• configureAndRefreshWebApplicationContext

  protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac,
                                                          ServletContextEE sc)

• customizeContext

  protected void customizeContext(ServletContextEE sc,
                                  ConfigurableWebApplicationContext wac)

  構成の場所がコンテキストに提供された後、コンテキストがリフレッシュされる前に、この ContextLoader によって作成された ConfigurableWebApplicationContext をカスタマイズします。

  デフォルトの実装は、コンテキスト初期化子クラス（存在する場合）がコンテキスト初期化パラメーターを介して指定されていることを判別し、特定の Web アプリケーションコンテキストでそれぞれを呼び出します。

  Ordered を実装する、または @Order でマークされた ApplicationContextInitializers は、適切にソートされます。

  パラメーター:

  sc - 現在のサーブレットコンテキスト

  wac - 新しく作成されたアプリケーションコンテキスト

  関連事項:

  CONTEXT_INITIALIZER_CLASSES_PARAM, ApplicationContextInitializer.initialize(ConfigurableApplicationContext)

• determineContextInitializerClasses

  protected ListSE<ClassSE<ApplicationContextInitializer<ConfigurableApplicationContext>>> determineContextInitializerClasses(ServletContextEE servletContext)

  CONTEXT_INITIALIZER_CLASSES_PARAM で指定されている場合に使用する ApplicationContextInitializer 実装クラスを返します。

  パラメーター:

  servletContext - 現在のサーブレットコンテキスト

  関連事項:

  CONTEXT_INITIALIZER_CLASSES_PARAM

• loadParentContext

  @Nullable
  protected ApplicationContext loadParentContext(ServletContextEE servletContext)

  ルート WebApplicationContext の親コンテキストとして使用される ApplicationContext インスタンスをロードまたは取得するための、デフォルトの実装（サブクラスによってオーバーライドされる可能性がある）を持つテンプレートメソッド。メソッドからの戻り値が null の場合、親コンテキストは設定されません。

  ここで親コンテキストをロードする主な理由は、複数のルート Web アプリケーションコンテキストをすべて共有 EAR コンテキストの子にできるようにするか、EJB から見える同じ親コンテキストも共有できるようにするためです。純粋な Web アプリケーションの場合、通常、ルート Web アプリケーションコンテキストへの親コンテキストを持つことを心配する必要はありません。

  デフォルトの実装は、5.0 以降、単に null を返します。

  パラメーター:

  servletContext - 現在のサーブレットコンテキスト

  戻り値:

  親アプリケーションコンテキスト。ない場合は null 

• closeWebApplicationContext

  public void closeWebApplicationContext(ServletContextEE servletContext)

  指定されたサーブレットコンテキストの Spring の Web アプリケーションコンテキストを閉じます。

  loadParentContext(ServletContext) をオーバーライドする場合は、このメソッドもオーバーライドする必要がある場合があります。

  パラメーター:

  servletContext - WebApplicationContext が実行される ServletContext

• getCurrentWebApplicationContext

  @Nullable
  public static WebApplicationContext getCurrentWebApplicationContext()

  現在のスレッドの Spring ルート Web アプリケーションコンテキストを取得します（つまり、現在のスレッドのコンテキスト ClassLoader です。これは、Web アプリケーションの ClassLoader である必要があります）。

  戻り値:

  現在のルート Web アプリケーションコンテキスト。見つからない場合は null 

  関連事項:

  SpringBeanAutowiringSupport