程序包 cn.taketoday.web.servlet.support

类 WebApplicationContextUtils

java.lang.Object
cn.taketoday.web.servlet.support.WebApplicationContextUtils
public class WebApplicationContextUtils extends Object
Convenience methods for retrieving the root WebApplicationContext for a given ServletContext. This is useful for programmatically accessing a application context from within custom web views or MVC actions.

Note that there are more convenient ways of accessing the root context for many web frameworks, either part of Infra or available as an external library. This helper class is just the most generic way to access the root context.

从以下版本开始:
4.0 2022/2/20 17:12
作者:
Juergen Hoeller, Harry Yang

  • 构造器详细资料

    • WebApplicationContextUtils

      public WebApplicationContextUtils()

  • 方法详细资料

    • getRequiredWebApplicationContext

      public static WebApplicationContext getRequiredWebApplicationContext(ServletContext sc) throws IllegalStateException
      Find the root WebServletApplicationContext for this web app, typically loaded via ContextLoaderListener.

      Will rethrow an exception that happened on root context startup, to differentiate between a failed context startup and no context at all.

      参数:
      sc - the ServletContext to find the web application context for
      返回:
      the root WebServletApplicationContext for this web app
      抛出:
      IllegalStateException - if the root WebServletApplicationContext could not be found
      另请参阅:

    • getWebApplicationContext

      @Nullable public static WebApplicationContext getWebApplicationContext(ServletContext sc)
      Find the root WebServletApplicationContext for this web app, typically loaded via ContextLoaderListener.

      Will rethrow an exception that happened on root context startup, to differentiate between a failed context startup and no context at all.

      参数:
      sc - the ServletContext to find the web application context for
      返回:
      the root WebServletApplicationContext for this web app, or null if none
      另请参阅:

    • getWebApplicationContext

      @Nullable public static WebApplicationContext getWebApplicationContext(ServletContext sc, String attrName)
      Find a custom WebServletApplicationContext for this web app.
      参数:
      sc - the ServletContext to find the web application context for
      attrName - the name of the ServletContext attribute to look for
      返回:
      the desired WebServletApplicationContext for this web app, or null if none

    • findWebApplicationContext

      @Nullable public static WebApplicationContext findWebApplicationContext(ServletContext sc)
      Find a unique WebServletApplicationContext for this web app: either the root web app context (preferred) or a unique WebServletApplicationContext among the registered ServletContext attributes (typically coming from a single DispatcherServlet in the current web application).

      Note that DispatcherServlet's exposure of its context can be controlled through its publishContext property, which is true by default but can be selectively switched to only publish a single context despite multiple DispatcherServlet registrations in the web app.

      参数:
      sc - the ServletContext to find the web application context for
      返回:
      the desired WebServletApplicationContext for this web app, or null if none
      另请参阅:

    • registerWebApplicationScopes

      public static void registerWebApplicationScopes(cn.taketoday.beans.factory.config.ConfigurableBeanFactory beanFactory)
      Register web-specific scopes ("request", "session", "globalSession") with the given BeanFactory, as used by the WebServletApplicationContext.
      参数:
      beanFactory - the BeanFactory to configure

    • registerWebApplicationScopes

      public static void registerWebApplicationScopes(cn.taketoday.beans.factory.config.ConfigurableBeanFactory beanFactory, @Nullable ServletContext sc)
      Register web-specific scopes ("request", "session") with the given BeanFactory, as used by the WebServletApplicationContext.
      参数:
      beanFactory - the BeanFactory to configure
      sc - the ServletContext that we're running within

    • registerEnvironmentBeans

      public static void registerEnvironmentBeans(cn.taketoday.beans.factory.config.ConfigurableBeanFactory bf, @Nullable ServletContext sc)
      Register web-specific environment beans ("contextParameters", "contextAttributes") with the given BeanFactory, as used by the WebServletApplicationContext.
      参数:
      bf - the BeanFactory to configure
      sc - the ServletContext that we're running within

    • registerEnvironmentBeans

      public static void registerEnvironmentBeans(cn.taketoday.beans.factory.config.ConfigurableBeanFactory bf, @Nullable ServletContext servletContext, @Nullable ServletConfig servletConfig)
      Register web-specific environment beans ("contextParameters", "contextAttributes") with the given BeanFactory, as used by the WebServletApplicationContext.
      参数:
      bf - the BeanFactory to configure
      servletContext - the ServletContext that we're running within
      servletConfig - the ServletConfig

    • initServletPropertySources

      public static void initServletPropertySources(cn.taketoday.core.env.PropertySources propertySources, ServletContext servletContext)
      Convenient variant of initServletPropertySources(PropertySources, ServletContext, ServletConfig) that always provides null for the ServletConfig parameter.
      另请参阅:

    • initServletPropertySources

      public static void initServletPropertySources(cn.taketoday.core.env.PropertySources sources, @Nullable ServletContext servletContext, @Nullable ServletConfig servletConfig)
      Replace Servlet-based stub property sources with actual instances populated with the given servletContext and servletConfig objects.

      This method is idempotent with respect to the fact it may be called any number of times but will perform replacement of stub property sources with their corresponding actual property sources once and only once.

      参数:
      sources - the PropertySources to initialize (must not be null)
      servletContext - the current ServletContext (ignored if null or if the servlet context property source has already been initialized)
      servletConfig - the current ServletConfig (ignored if null or if the servlet config property source has already been initialized)
      另请参阅:
      • PropertySource.StubPropertySource
      • ConfigurableEnvironment.getPropertySources()