Class GenericWebApplicationContext
- All Implemented Interfaces:
Closeable
,AutoCloseable
,BeanFactory
,HierarchicalBeanFactory
,ListableBeanFactory
,BeanDefinitionRegistry
,ApplicationContext
,ApplicationEventPublisher
,ConfigurableApplicationContext
,Lifecycle
,MessageSource
,AliasRegistry
,EnvironmentCapable
,ResourceLoader
,ResourcePatternResolver
,ThemeSource
,ConfigurableWebApplicationContext
,WebApplicationContext
GenericApplicationContext
, suitable for web environments.
Implements ConfigurableWebApplicationContext
, but is not intended for
declarative setup in web.xml
. Instead, it is designed for programmatic setup,
for example for building nested contexts or for use within
WebApplicationInitializers
.
Interprets resource paths as servlet context resources, i.e. as paths beneath
the web application root. Absolute paths — for example, for files outside
the web app root — can be accessed via file:
URLs, as implemented
by AbstractApplicationContext
.
In addition to the special beans detected by
AbstractApplicationContext
,
this class detects a ThemeSource
bean in the context, with the name "themeSource".
If you wish to register annotated component classes with a
GenericWebApplicationContext
, you can use an
AnnotatedBeanDefinitionReader
, as demonstrated in the following example.
Component classes include in particular
@Configuration
classes but also plain @Component
classes as well as JSR-330 compliant classes using jakarta.inject
annotations.
GenericWebApplicationContext context = new GenericWebApplicationContext(); AnnotatedBeanDefinitionReader reader = new AnnotatedBeanDefinitionReader(context); reader.register(AppConfig.class, UserController.class, UserRepository.class);
If you intend to implement a WebApplicationContext
that reads bean definitions
from configuration files, consider deriving from AbstractRefreshableWebApplicationContext
,
reading the bean definitions in an implementation of the loadBeanDefinitions
method.
- Since:
- 1.2
- Author:
- Juergen Hoeller, Chris Beams, Sam Brannen
-
Nested Class Summary
Nested classes/interfaces inherited from class org.springframework.core.io.DefaultResourceLoader
DefaultResourceLoader.ClassPathContextResource
-
Field Summary
Fields inherited from class org.springframework.context.support.AbstractApplicationContext
APPLICATION_EVENT_MULTICASTER_BEAN_NAME, LIFECYCLE_PROCESSOR_BEAN_NAME, logger, MESSAGE_SOURCE_BEAN_NAME
Fields inherited from interface org.springframework.beans.factory.BeanFactory
FACTORY_BEAN_PREFIX
Fields inherited from interface org.springframework.context.ConfigurableApplicationContext
APPLICATION_STARTUP_BEAN_NAME, CONFIG_LOCATION_DELIMITERS, CONVERSION_SERVICE_BEAN_NAME, ENVIRONMENT_BEAN_NAME, LOAD_TIME_WEAVER_BEAN_NAME, SHUTDOWN_HOOK_THREAD_NAME, SYSTEM_ENVIRONMENT_BEAN_NAME, SYSTEM_PROPERTIES_BEAN_NAME
Fields inherited from interface org.springframework.web.context.ConfigurableWebApplicationContext
APPLICATION_CONTEXT_ID_PREFIX, SERVLET_CONFIG_BEAN_NAME
Fields inherited from interface org.springframework.core.io.ResourceLoader
CLASSPATH_URL_PREFIX
Fields inherited from interface org.springframework.core.io.support.ResourcePatternResolver
CLASSPATH_ALL_URL_PREFIX
Fields inherited from interface org.springframework.web.context.WebApplicationContext
CONTEXT_ATTRIBUTES_BEAN_NAME, CONTEXT_PARAMETERS_BEAN_NAME, ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, SCOPE_APPLICATION, SCOPE_REQUEST, SCOPE_SESSION, SERVLET_CONTEXT_BEAN_NAME
-
Constructor Summary
ConstructorDescriptionCreate a newGenericWebApplicationContext
.GenericWebApplicationContext
(ServletContext servletContext) Create a newGenericWebApplicationContext
for the givenServletContext
.GenericWebApplicationContext
(DefaultListableBeanFactory beanFactory) Create a newGenericWebApplicationContext
with the givenDefaultListableBeanFactory
.GenericWebApplicationContext
(DefaultListableBeanFactory beanFactory, ServletContext servletContext) Create a newGenericWebApplicationContext
with the givenDefaultListableBeanFactory
andServletContext
. -
Method Summary
Modifier and TypeMethodDescriptionprotected ConfigurableEnvironment
Create and return a newStandardServletEnvironment
.Return a name for the deployed application that this context belongs to.String[]
Return the config locations for this web application context, ornull
if none specified.Return the namespace for this web application context, if any.protected Resource
getResourceByPath
(String path) This implementation supports file paths beneath the root of theServletContext
.protected ResourcePatternResolver
This implementation supports pattern matching in unexpanded WARs too.Return the ServletConfig for this web application context, if any.Return the standard Servlet API ServletContext for this application.Return the Theme instance for the given theme name.protected void
Replace any stub property sources with actual instances.protected void
Initialize the theme capability.protected void
postProcessBeanFactory
(ConfigurableListableBeanFactory beanFactory) Register request/session scopes, environment beans, aServletContextAwareProcessor
, etc.void
setConfigLocation
(String configLocation) Set the config locations for this web application context in init-param style, i.e.void
setConfigLocations
(String... configLocations) Set the config locations for this web application context.void
setNamespace
(String namespace) Set the namespace for this web application context, to be used for building a default context config location.void
setServletConfig
(ServletConfig servletConfig) Set the ServletConfig for this web application context.void
setServletContext
(ServletContext servletContext) Set theServletContext
that thisWebApplicationContext
runs in.Methods inherited from class org.springframework.context.support.GenericApplicationContext
cancelRefresh, closeBeanFactory, getAutowireCapableBeanFactory, getBeanDefinition, getBeanFactory, getClassLoader, getDefaultListableBeanFactory, getResource, getResources, isAlias, isBeanNameInUse, refreshBeanFactory, refreshForAotProcessing, registerAlias, registerBean, registerBean, registerBean, registerBean, registerBean, registerBean, registerBeanDefinition, removeAlias, removeBeanDefinition, setAllowBeanDefinitionOverriding, setAllowCircularReferences, setApplicationStartup, setClassLoader, setParent, setResourceLoader
Methods inherited from class org.springframework.context.support.AbstractApplicationContext
addApplicationListener, addBeanFactoryPostProcessor, assertBeanFactoryActive, close, containsBean, containsBeanDefinition, containsLocalBean, destroyBeans, doClose, findAnnotationOnBean, findAnnotationOnBean, finishBeanFactoryInitialization, finishRefresh, getAliases, getApplicationListeners, getApplicationStartup, getBean, getBean, getBean, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanFactoryPostProcessors, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanProvider, getBeanProvider, getBeanProvider, getBeanProvider, getBeansOfType, getBeansOfType, getBeansWithAnnotation, getDisplayName, getEnvironment, getId, getInternalParentBeanFactory, getInternalParentMessageSource, getMessage, getMessage, getMessage, getParent, getParentBeanFactory, getStartupDate, getType, getType, initApplicationEventMulticaster, initLifecycleProcessor, initMessageSource, invokeBeanFactoryPostProcessors, isActive, isPrototype, isRunning, isSingleton, isTypeMatch, isTypeMatch, obtainFreshBeanFactory, onClose, prepareBeanFactory, prepareRefresh, publishEvent, publishEvent, publishEvent, refresh, registerBeanPostProcessors, registerListeners, registerShutdownHook, resetCommonCaches, setDisplayName, setEnvironment, setId, start, stop, toString
Methods inherited from class org.springframework.core.io.DefaultResourceLoader
addProtocolResolver, clearResourceCaches, getProtocolResolvers, getResourceCache
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.springframework.core.AliasRegistry
getAliases
Methods inherited from interface org.springframework.context.ApplicationContext
getAutowireCapableBeanFactory, getDisplayName, getId, getParent, getStartupDate
Methods inherited from interface org.springframework.context.ApplicationEventPublisher
publishEvent, publishEvent
Methods inherited from interface org.springframework.beans.factory.support.BeanDefinitionRegistry
containsBeanDefinition, getBeanDefinitionCount, getBeanDefinitionNames
Methods inherited from interface org.springframework.beans.factory.BeanFactory
containsBean, getAliases, getBean, getBean, getBean, getBean, getBean, getBeanProvider, getBeanProvider, getType, getType, isPrototype, isSingleton, isTypeMatch, isTypeMatch
Methods inherited from interface org.springframework.context.ConfigurableApplicationContext
addApplicationListener, addBeanFactoryPostProcessor, addProtocolResolver, close, getApplicationStartup, getBeanFactory, getEnvironment, isActive, refresh, registerShutdownHook, setApplicationStartup, setClassLoader, setEnvironment, setId, setParent
Methods inherited from interface org.springframework.beans.factory.HierarchicalBeanFactory
containsLocalBean, getParentBeanFactory
Methods inherited from interface org.springframework.beans.factory.ListableBeanFactory
containsBeanDefinition, findAnnotationOnBean, findAnnotationOnBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanProvider, getBeanProvider, getBeansOfType, getBeansOfType, getBeansWithAnnotation
Methods inherited from interface org.springframework.context.MessageSource
getMessage, getMessage, getMessage
Methods inherited from interface org.springframework.core.io.ResourceLoader
getClassLoader, getResource
Methods inherited from interface org.springframework.core.io.support.ResourcePatternResolver
getResources
-
Constructor Details
-
GenericWebApplicationContext
public GenericWebApplicationContext()Create a newGenericWebApplicationContext
. -
GenericWebApplicationContext
Create a newGenericWebApplicationContext
for the givenServletContext
.- Parameters:
servletContext
- theServletContext
to run in- See Also:
-
GenericWebApplicationContext
Create a newGenericWebApplicationContext
with the givenDefaultListableBeanFactory
.- Parameters:
beanFactory
- theDefaultListableBeanFactory
instance to use for this context- See Also:
-
GenericWebApplicationContext
public GenericWebApplicationContext(DefaultListableBeanFactory beanFactory, ServletContext servletContext) Create a newGenericWebApplicationContext
with the givenDefaultListableBeanFactory
andServletContext
.- Parameters:
beanFactory
- theDefaultListableBeanFactory
instance to use for this contextservletContext
- theServletContext
to run in- See Also:
-
-
Method Details
-
setServletContext
Set theServletContext
that thisWebApplicationContext
runs in.- Specified by:
setServletContext
in interfaceConfigurableWebApplicationContext
- See Also:
-
getServletContext
Description copied from interface:WebApplicationContext
Return the standard Servlet API ServletContext for this application.- Specified by:
getServletContext
in interfaceWebApplicationContext
-
getApplicationName
Description copied from interface:ApplicationContext
Return a name for the deployed application that this context belongs to.- Specified by:
getApplicationName
in interfaceApplicationContext
- Overrides:
getApplicationName
in classAbstractApplicationContext
- Returns:
- a name for the deployed application, or the empty String by default
-
createEnvironment
Create and return a newStandardServletEnvironment
.- Overrides:
createEnvironment
in classAbstractApplicationContext
-
postProcessBeanFactory
Register request/session scopes, environment beans, aServletContextAwareProcessor
, etc.- Overrides:
postProcessBeanFactory
in classAbstractApplicationContext
- Parameters:
beanFactory
- the bean factory used by the application context
-
getResourceByPath
This implementation supports file paths beneath the root of theServletContext
.- Overrides:
getResourceByPath
in classDefaultResourceLoader
- Parameters:
path
- the path to the resource- Returns:
- the corresponding Resource handle
- See Also:
-
getResourcePatternResolver
This implementation supports pattern matching in unexpanded WARs too.- Overrides:
getResourcePatternResolver
in classAbstractApplicationContext
- Returns:
- the ResourcePatternResolver for this context
- See Also:
-
onRefresh
protected void onRefresh()Initialize the theme capability.- Overrides:
onRefresh
in classAbstractApplicationContext
- See Also:
-
initPropertySources
protected void initPropertySources()Replace any stub property sources with actual instances.
Replace
Servlet
-related property sources. -
getTheme
Description copied from interface:ThemeSource
Return the Theme instance for the given theme name.The returned Theme will resolve theme-specific messages, codes, file paths, etc (e.g. CSS and image files in a web environment).
- Specified by:
getTheme
in interfaceThemeSource
- Parameters:
themeName
- the name of the theme- Returns:
- the corresponding Theme, or
null
if none defined. Note that, by convention, a ThemeSource should at least be able to return a default Theme for the default theme name "theme" but may also return default Themes for other theme names. - See Also:
-
setServletConfig
Description copied from interface:ConfigurableWebApplicationContext
Set the ServletConfig for this web application context. Only called for a WebApplicationContext that belongs to a specific Servlet.- Specified by:
setServletConfig
in interfaceConfigurableWebApplicationContext
- See Also:
-
getServletConfig
Description copied from interface:ConfigurableWebApplicationContext
Return the ServletConfig for this web application context, if any.- Specified by:
getServletConfig
in interfaceConfigurableWebApplicationContext
-
setNamespace
Description copied from interface:ConfigurableWebApplicationContext
Set the namespace for this web application context, to be used for building a default context config location. The root web application context does not have a namespace.- Specified by:
setNamespace
in interfaceConfigurableWebApplicationContext
-
getNamespace
Description copied from interface:ConfigurableWebApplicationContext
Return the namespace for this web application context, if any.- Specified by:
getNamespace
in interfaceConfigurableWebApplicationContext
-
setConfigLocation
Description copied from interface:ConfigurableWebApplicationContext
Set the config locations for this web application context in init-param style, i.e. with distinct locations separated by commas, semicolons or whitespace.If not set, the implementation is supposed to use a default for the given namespace or the root web application context, as appropriate.
- Specified by:
setConfigLocation
in interfaceConfigurableWebApplicationContext
-
setConfigLocations
Description copied from interface:ConfigurableWebApplicationContext
Set the config locations for this web application context.If not set, the implementation is supposed to use a default for the given namespace or the root web application context, as appropriate.
- Specified by:
setConfigLocations
in interfaceConfigurableWebApplicationContext
-
getConfigLocations
Description copied from interface:ConfigurableWebApplicationContext
Return the config locations for this web application context, ornull
if none specified.- Specified by:
getConfigLocations
in interfaceConfigurableWebApplicationContext
-