public abstract class WebApplicationContextUtils
extends java.lang.Object
WebApplicationContext
for a given
ServletContext
. This is e.g. useful for accessing a Spring
context from within custom web views or Struts actions.
Note that there are more convenient ways of accessing the root context for many web frameworks, either part of Spring or available as external library. This helper class is just the most generic way to access the root context.
ContextLoader
,
FrameworkServlet
,
DispatcherServlet
,
FacesContextUtils
,
org.springframework.web.jsf.SpringBeanVariableResolver
,
SpringBeanFacesELResolver
Modifier and Type | Class and Description |
---|---|
private static class |
WebApplicationContextUtils.FacesDependencyRegistrar
Inner class to avoid hard-coded JSF dependency.
|
private static class |
WebApplicationContextUtils.RequestObjectFactory
Factory that exposes the current request object on demand.
|
private static class |
WebApplicationContextUtils.SessionObjectFactory
Factory that exposes the current session object on demand.
|
private static class |
WebApplicationContextUtils.WebRequestObjectFactory
Factory that exposes the current WebRequest object on demand.
|
Modifier and Type | Field and Description |
---|---|
private static boolean |
jsfPresent |
Constructor and Description |
---|
WebApplicationContextUtils() |
Modifier and Type | Method and Description |
---|---|
private static ServletRequestAttributes |
currentRequestAttributes()
Return the current RequestAttributes instance as ServletRequestAttributes.
|
static WebApplicationContext |
getRequiredWebApplicationContext(ServletContext sc)
Find the root WebApplicationContext for this web application, which is
typically loaded via
ContextLoaderListener . |
static WebApplicationContext |
getWebApplicationContext(ServletContext sc)
Find the root WebApplicationContext for this web application, which is
typically loaded via
ContextLoaderListener . |
static WebApplicationContext |
getWebApplicationContext(ServletContext sc,
java.lang.String attrName)
Find a custom WebApplicationContext for this web application.
|
static void |
initServletPropertySources(MutablePropertySources propertySources,
ServletContext servletContext)
Convenient variant of
initServletPropertySources(MutablePropertySources,
ServletContext, ServletConfig) that always provides null for the
ServletConfig parameter. |
static void |
initServletPropertySources(MutablePropertySources propertySources,
ServletContext servletContext,
ServletConfig servletConfig)
Replace
Servlet -based stub property sources with
actual instances populated with the given servletContext and
servletConfig objects. |
static void |
registerEnvironmentBeans(ConfigurableListableBeanFactory bf,
ServletContext sc)
Register web-specific environment beans ("contextParameters", "contextAttributes")
with the given BeanFactory, as used by the WebApplicationContext.
|
static void |
registerEnvironmentBeans(ConfigurableListableBeanFactory bf,
ServletContext sc,
ServletConfig config)
Register web-specific environment beans ("contextParameters", "contextAttributes")
with the given BeanFactory, as used by the WebApplicationContext.
|
static void |
registerWebApplicationScopes(ConfigurableListableBeanFactory beanFactory)
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.
|
public static WebApplicationContext getRequiredWebApplicationContext(ServletContext sc) throws java.lang.IllegalStateException
ContextLoaderListener
.
Will rethrow an exception that happened on root context startup, to differentiate between a failed context startup and no context at all.
sc
- ServletContext to find the web application context forjava.lang.IllegalStateException
- if the root WebApplicationContext could not be foundWebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE
public static WebApplicationContext getWebApplicationContext(ServletContext sc)
ContextLoaderListener
.
Will rethrow an exception that happened on root context startup, to differentiate between a failed context startup and no context at all.
sc
- ServletContext to find the web application context fornull
if noneWebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE
public static WebApplicationContext getWebApplicationContext(ServletContext sc, java.lang.String attrName)
sc
- ServletContext to find the web application context forattrName
- the name of the ServletContext attribute to look fornull
if nonepublic static void registerWebApplicationScopes(ConfigurableListableBeanFactory beanFactory)
beanFactory
- the BeanFactory to configurepublic static void registerWebApplicationScopes(ConfigurableListableBeanFactory beanFactory, ServletContext sc)
beanFactory
- the BeanFactory to configuresc
- the ServletContext that we're running withinpublic static void registerEnvironmentBeans(ConfigurableListableBeanFactory bf, ServletContext sc)
bf
- the BeanFactory to configuresc
- the ServletContext that we're running withinpublic static void registerEnvironmentBeans(ConfigurableListableBeanFactory bf, ServletContext sc, ServletConfig config)
bf
- the BeanFactory to configuresc
- the ServletContext that we're running withinconfig
- the ServletConfig of the containing Portletpublic static void initServletPropertySources(MutablePropertySources propertySources, ServletContext servletContext)
initServletPropertySources(MutablePropertySources,
ServletContext, ServletConfig)
that always provides null
for the
ServletConfig
parameter.public static void initServletPropertySources(MutablePropertySources propertySources, ServletContext servletContext, ServletConfig servletConfig)
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.
propertySources
- the MutablePropertySources
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()
private static ServletRequestAttributes currentRequestAttributes()