Class WebApplicationContextUtils
WebApplicationContext
for
a given ServletContext
. This is useful for programmatically accessing
a Spring 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 Spring or available as an external library. This helper class is just the most generic way to access the root context.
- Author:
- Juergen Hoeller
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic WebApplicationContext
Find a uniqueWebApplicationContext
for this web app: either the root web app context (preferred) or a uniqueWebApplicationContext
among the registeredServletContext
attributes (typically coming from a singleDispatcherServlet
in the current web application).static WebApplicationContext
Find the rootWebApplicationContext
for this web app, typically loaded viaContextLoaderListener
.static WebApplicationContext
Find the rootWebApplicationContext
for this web app, typically loaded viaContextLoaderListener
.static WebApplicationContext
getWebApplicationContext
(ServletContext sc, String attrName) Find a customWebApplicationContext
for this web app.static void
initServletPropertySources
(MutablePropertySources propertySources, ServletContext servletContext) Convenient variant ofinitServletPropertySources(MutablePropertySources, ServletContext, ServletConfig)
that always providesnull
for theServletConfig
parameter.static void
initServletPropertySources
(MutablePropertySources sources, ServletContext servletContext, ServletConfig servletConfig) ReplaceServlet
-basedstub property sources
with actual instances populated with the givenservletContext
andservletConfig
objects.static void
Register web-specific environment beans ("contextParameters", "contextAttributes") with the given BeanFactory, as used by the WebApplicationContext.static void
registerEnvironmentBeans
(ConfigurableListableBeanFactory bf, ServletContext servletContext, ServletConfig servletConfig) Register web-specific environment beans ("contextParameters", "contextAttributes") with the given BeanFactory, as used by the WebApplicationContext.static void
Register web-specific scopes ("request", "session", "globalSession") with the given BeanFactory, as used by the WebApplicationContext.static void
registerWebApplicationScopes
(ConfigurableListableBeanFactory beanFactory, ServletContext sc) Register web-specific scopes ("request", "session", "globalSession", "application") with the given BeanFactory, as used by the WebApplicationContext.
-
Constructor Details
-
WebApplicationContextUtils
public WebApplicationContextUtils()
-
-
Method Details
-
getRequiredWebApplicationContext
public static WebApplicationContext getRequiredWebApplicationContext(ServletContext sc) throws IllegalStateException Find the rootWebApplicationContext
for this web app, typically loaded viaContextLoaderListener
.Will rethrow an exception that happened on root context startup, to differentiate between a failed context startup and no context at all.
- Parameters:
sc
- the ServletContext to find the web application context for- Returns:
- the root WebApplicationContext for this web app
- Throws:
IllegalStateException
- if the root WebApplicationContext could not be found- See Also:
-
getWebApplicationContext
Find the rootWebApplicationContext
for this web app, typically loaded viaContextLoaderListener
.Will rethrow an exception that happened on root context startup, to differentiate between a failed context startup and no context at all.
- Parameters:
sc
- the ServletContext to find the web application context for- Returns:
- the root WebApplicationContext for this web app, or
null
if none - See Also:
-
getWebApplicationContext
@Nullable public static WebApplicationContext getWebApplicationContext(ServletContext sc, String attrName) Find a customWebApplicationContext
for this web app.- Parameters:
sc
- the ServletContext to find the web application context forattrName
- the name of the ServletContext attribute to look for- Returns:
- the desired WebApplicationContext for this web app, or
null
if none
-
findWebApplicationContext
Find a uniqueWebApplicationContext
for this web app: either the root web app context (preferred) or a uniqueWebApplicationContext
among the registeredServletContext
attributes (typically coming from a singleDispatcherServlet
in the current web application).Note that
DispatcherServlet
's exposure of its context can be controlled through itspublishContext
property, which istrue
by default but can be selectively switched to only publish a single context despite multipleDispatcherServlet
registrations in the web app.- Parameters:
sc
- the ServletContext to find the web application context for- Returns:
- the desired WebApplicationContext for this web app, or
null
if none - Since:
- 4.2
- See Also:
-
registerWebApplicationScopes
Register web-specific scopes ("request", "session", "globalSession") with the given BeanFactory, as used by the WebApplicationContext.- Parameters:
beanFactory
- the BeanFactory to configure
-
registerWebApplicationScopes
public static void registerWebApplicationScopes(ConfigurableListableBeanFactory beanFactory, @Nullable ServletContext sc) Register web-specific scopes ("request", "session", "globalSession", "application") with the given BeanFactory, as used by the WebApplicationContext.- Parameters:
beanFactory
- the BeanFactory to configuresc
- the ServletContext that we're running within
-
registerEnvironmentBeans
public static void registerEnvironmentBeans(ConfigurableListableBeanFactory bf, @Nullable ServletContext sc) Register web-specific environment beans ("contextParameters", "contextAttributes") with the given BeanFactory, as used by the WebApplicationContext.- Parameters:
bf
- the BeanFactory to configuresc
- the ServletContext that we're running within
-
registerEnvironmentBeans
public static void registerEnvironmentBeans(ConfigurableListableBeanFactory bf, @Nullable ServletContext servletContext, @Nullable ServletConfig servletConfig) Register web-specific environment beans ("contextParameters", "contextAttributes") with the given BeanFactory, as used by the WebApplicationContext.- Parameters:
bf
- the BeanFactory to configureservletContext
- the ServletContext that we're running withinservletConfig
- the ServletConfig
-
initServletPropertySources
public static void initServletPropertySources(MutablePropertySources propertySources, ServletContext servletContext) Convenient variant ofinitServletPropertySources(MutablePropertySources, ServletContext, ServletConfig)
that always providesnull
for theServletConfig
parameter. -
initServletPropertySources
public static void initServletPropertySources(MutablePropertySources sources, @Nullable ServletContext servletContext, @Nullable ServletConfig servletConfig) ReplaceServlet
-basedstub property sources
with actual instances populated with the givenservletContext
andservletConfig
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.
- Parameters:
sources
- theMutablePropertySources
to initialize (must not benull
)servletContext
- the currentServletContext
(ignored ifnull
or if theservlet context property source
has already been initialized)servletConfig
- the currentServletConfig
(ignored ifnull
or if theservlet config property source
has already been initialized)- See Also:
-