Class GenericWebApplicationContext
- All Implemented Interfaces:
- Closeable, AutoCloseable, BeanFactory, HierarchicalBeanFactory, ListableBeanFactory, BeanDefinitionRegistry, ApplicationContext, ApplicationEventPublisher, ConfigurableApplicationContext, Lifecycle, MessageSource, AliasRegistry, EnvironmentCapable, ResourceLoader, ResourcePatternResolver, 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.
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 SummaryNested classes/interfaces inherited from class DefaultResourceLoaderDefaultResourceLoader.ClassPathContextResource
- 
Field SummaryFields inherited from class AbstractApplicationContextAPPLICATION_EVENT_MULTICASTER_BEAN_NAME, LIFECYCLE_PROCESSOR_BEAN_NAME, logger, MESSAGE_SOURCE_BEAN_NAMEFields inherited from interface BeanFactoryFACTORY_BEAN_PREFIX, FACTORY_BEAN_PREFIX_CHARFields inherited from interface ConfigurableApplicationContextAPPLICATION_STARTUP_BEAN_NAME, BOOTSTRAP_EXECUTOR_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_NAMEFields inherited from interface ConfigurableWebApplicationContextAPPLICATION_CONTEXT_ID_PREFIX, SERVLET_CONFIG_BEAN_NAMEFields inherited from interface ResourceLoaderCLASSPATH_URL_PREFIXFields inherited from interface ResourcePatternResolverCLASSPATH_ALL_URL_PREFIX
- 
Constructor SummaryConstructorsConstructorDescriptionCreate a newGenericWebApplicationContext.GenericWebApplicationContext(ServletContext servletContext) Create a newGenericWebApplicationContextfor the givenServletContext.GenericWebApplicationContext(DefaultListableBeanFactory beanFactory) Create a newGenericWebApplicationContextwith the givenDefaultListableBeanFactory.GenericWebApplicationContext(DefaultListableBeanFactory beanFactory, ServletContext servletContext) Create a newGenericWebApplicationContextwith the givenDefaultListableBeanFactoryandServletContext.
- 
Method SummaryModifier and TypeMethodDescriptionprotected ConfigurableEnvironmentCreate 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, ornullif none specified.Return the namespace for this web application context, if any.protected ResourcegetResourceByPath(String path) This implementation supports file paths beneath the root of theServletContext.protected ResourcePatternResolverThis 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.protected voidReplace any stub property sources with actual instances.protected voidpostProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) Register request/session scopes, environment beans, aServletContextAwareProcessor, etc.voidsetConfigLocation(String configLocation) Set the config locations for this web application context in init-param style, i.e.voidsetConfigLocations(String... configLocations) Set the config locations for this web application context.voidsetNamespace(@Nullable String namespace) Set the namespace for this web application context, to be used for building a default context config location.voidsetServletConfig(@Nullable ServletConfig servletConfig) Set the ServletConfig for this web application context.voidsetServletContext(@Nullable ServletContext servletContext) Set theServletContextthat thisWebApplicationContextruns in.Methods inherited from class GenericApplicationContextcancelRefresh, closeBeanFactory, getAutowireCapableBeanFactory, getBeanDefinition, getBeanFactory, getClassLoader, getDefaultListableBeanFactory, getResource, getResources, isAlias, isBeanDefinitionOverridable, isBeanNameInUse, refreshBeanFactory, refreshForAotProcessing, register, registerAlias, registerBean, registerBean, registerBean, registerBean, registerBean, registerBean, registerBeanDefinition, removeAlias, removeBeanDefinition, setAllowBeanDefinitionOverriding, setAllowCircularReferences, setApplicationStartup, setClassLoader, setParent, setResourceLoaderMethods inherited from class AbstractApplicationContextaddApplicationListener, addBeanFactoryPostProcessor, assertBeanFactoryActive, clearResourceCaches, close, containsBean, containsBeanDefinition, containsLocalBean, destroyBeans, doClose, findAllAnnotationsOnBean, findAnnotationOnBean, findAnnotationOnBean, finishBeanFactoryInitialization, finishRefresh, getAliases, getApplicationListeners, getApplicationStartup, getBean, getBean, getBean, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanFactoryPostProcessors, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanProvider, 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, isClosed, isPrototype, isRunning, isSingleton, isTypeMatch, isTypeMatch, obtainFreshBeanFactory, onClose, onRefresh, pause, prepareBeanFactory, prepareRefresh, publishEvent, publishEvent, publishEvent, refresh, registerBeanPostProcessors, registerListeners, registerShutdownHook, removeApplicationListener, resetCommonCaches, restart, setDisplayName, setEnvironment, setId, start, stop, toStringMethods inherited from class DefaultResourceLoaderaddProtocolResolver, getProtocolResolvers, getResourceCacheMethods inherited from class Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface AliasRegistrygetAliasesMethods inherited from interface ApplicationContextgetAutowireCapableBeanFactory, getDisplayName, getId, getParent, getStartupDateMethods inherited from interface ApplicationEventPublisherpublishEvent, publishEventMethods inherited from interface BeanDefinitionRegistrycontainsBeanDefinition, getBeanDefinitionCount, getBeanDefinitionNamesMethods inherited from interface BeanFactorycontainsBean, getAliases, getBean, getBean, getBean, getBean, getBean, getBeanProvider, getBeanProvider, getBeanProvider, getType, getType, isPrototype, isSingleton, isTypeMatch, isTypeMatchMethods inherited from interface ConfigurableApplicationContextaddApplicationListener, addBeanFactoryPostProcessor, addProtocolResolver, close, getApplicationStartup, getBeanFactory, getEnvironment, isActive, isClosed, pause, refresh, registerShutdownHook, removeApplicationListener, restart, setApplicationStartup, setClassLoader, setEnvironment, setId, setParentMethods inherited from interface HierarchicalBeanFactorycontainsLocalBean, getParentBeanFactoryMethods inherited from interface ListableBeanFactorycontainsBeanDefinition, findAllAnnotationsOnBean, findAnnotationOnBean, findAnnotationOnBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanProvider, getBeanProvider, getBeansOfType, getBeansOfType, getBeansWithAnnotationMethods inherited from interface MessageSourcegetMessage, getMessage, getMessageMethods inherited from interface ResourceLoadergetClassLoader, getResourceMethods inherited from interface ResourcePatternResolvergetResources
- 
Constructor Details- 
GenericWebApplicationContextpublic GenericWebApplicationContext()Create a newGenericWebApplicationContext.- See Also:
 
- 
GenericWebApplicationContextCreate a newGenericWebApplicationContextfor the givenServletContext.- Parameters:
- servletContext- the- ServletContextto run in
- See Also:
 
- 
GenericWebApplicationContextCreate a newGenericWebApplicationContextwith the givenDefaultListableBeanFactory.- Parameters:
- beanFactory- the- DefaultListableBeanFactoryinstance to use for this context
- See Also:
 
- 
GenericWebApplicationContextpublic GenericWebApplicationContext(DefaultListableBeanFactory beanFactory, ServletContext servletContext) Create a newGenericWebApplicationContextwith the givenDefaultListableBeanFactoryandServletContext.- Parameters:
- beanFactory- the- DefaultListableBeanFactoryinstance to use for this context
- servletContext- the- ServletContextto run in
- See Also:
 
 
- 
- 
Method Details- 
setServletContextSet theServletContextthat thisWebApplicationContextruns in.- Specified by:
- setServletContextin interface- ConfigurableWebApplicationContext
- See Also:
 
- 
getServletContextDescription copied from interface:WebApplicationContextReturn the standard Servlet API ServletContext for this application.- Specified by:
- getServletContextin interface- WebApplicationContext
 
- 
getApplicationNameDescription copied from interface:ApplicationContextReturn a name for the deployed application that this context belongs to.- Specified by:
- getApplicationNamein interface- ApplicationContext
- Overrides:
- getApplicationNamein class- AbstractApplicationContext
- Returns:
- a name for the deployed application, or the empty String by default
 
- 
createEnvironmentCreate and return a newStandardServletEnvironment.- Overrides:
- createEnvironmentin class- AbstractApplicationContext
 
- 
postProcessBeanFactoryRegister request/session scopes, environment beans, aServletContextAwareProcessor, etc.- Overrides:
- postProcessBeanFactoryin class- AbstractApplicationContext
- Parameters:
- beanFactory- the bean factory used by the application context
 
- 
getResourceByPathThis implementation supports file paths beneath the root of theServletContext.- Overrides:
- getResourceByPathin class- DefaultResourceLoader
- Parameters:
- path- the path to the resource
- Returns:
- the corresponding Resource handle
- See Also:
 
- 
getResourcePatternResolverThis implementation supports pattern matching in unexpanded WARs too.- Overrides:
- getResourcePatternResolverin class- AbstractApplicationContext
- Returns:
- the ResourcePatternResolver for this context
- See Also:
 
- 
initPropertySourcesprotected void initPropertySources()Replace any stub property sources with actual instances. Replace Servlet-related property sources.- Overrides:
- initPropertySourcesin class- AbstractApplicationContext
- See Also:
 
- 
setServletConfigDescription copied from interface:ConfigurableWebApplicationContextSet the ServletConfig for this web application context. Only called for a WebApplicationContext that belongs to a specific Servlet.- Specified by:
- setServletConfigin interface- ConfigurableWebApplicationContext
- See Also:
 
- 
getServletConfigDescription copied from interface:ConfigurableWebApplicationContextReturn the ServletConfig for this web application context, if any.- Specified by:
- getServletConfigin interface- ConfigurableWebApplicationContext
 
- 
setNamespaceDescription copied from interface:ConfigurableWebApplicationContextSet 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:
- setNamespacein interface- ConfigurableWebApplicationContext
 
- 
getNamespaceDescription copied from interface:ConfigurableWebApplicationContextReturn the namespace for this web application context, if any.- Specified by:
- getNamespacein interface- ConfigurableWebApplicationContext
 
- 
setConfigLocationDescription copied from interface:ConfigurableWebApplicationContextSet 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:
- setConfigLocationin interface- ConfigurableWebApplicationContext
 
- 
setConfigLocationsDescription copied from interface:ConfigurableWebApplicationContextSet 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:
- setConfigLocationsin interface- ConfigurableWebApplicationContext
 
- 
getConfigLocationsDescription copied from interface:ConfigurableWebApplicationContextReturn the config locations for this web application context, ornullif none specified.- Specified by:
- getConfigLocationsin interface- ConfigurableWebApplicationContext
 
 
-