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.
 
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.
 
Interprets resource paths as servlet context resources, i.e. as paths beneath the web application root. Absolute paths, e.g. 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".
- Since:
- 1.2
- Author:
- Juergen Hoeller, Chris Beams
- 
Nested Class SummaryNested classes/interfaces inherited from class org.springframework.core.io.DefaultResourceLoaderDefaultResourceLoader.ClassPathContextResource
- 
Field SummaryFields inherited from class org.springframework.context.support.AbstractApplicationContextAPPLICATION_EVENT_MULTICASTER_BEAN_NAME, LIFECYCLE_PROCESSOR_BEAN_NAME, logger, MESSAGE_SOURCE_BEAN_NAMEFields inherited from interface org.springframework.beans.factory.BeanFactoryFACTORY_BEAN_PREFIXFields inherited from interface org.springframework.context.ConfigurableApplicationContextAPPLICATION_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_NAMEFields inherited from interface org.springframework.web.context.ConfigurableWebApplicationContextAPPLICATION_CONTEXT_ID_PREFIX, SERVLET_CONFIG_BEAN_NAMEFields inherited from interface org.springframework.core.io.ResourceLoaderCLASSPATH_URL_PREFIXFields inherited from interface org.springframework.core.io.support.ResourcePatternResolverCLASSPATH_ALL_URL_PREFIXFields inherited from interface org.springframework.web.context.WebApplicationContextCONTEXT_ATTRIBUTES_BEAN_NAME, CONTEXT_PARAMETERS_BEAN_NAME, ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, SCOPE_APPLICATION, SCOPE_REQUEST, SCOPE_SESSION, SERVLET_CONTEXT_BEAN_NAME
- 
Constructor SummaryConstructorsConstructorDescriptionCreate a new GenericWebApplicationContext.GenericWebApplicationContext(ServletContext servletContext) Create a new GenericWebApplicationContext for the given ServletContext.GenericWebApplicationContext(DefaultListableBeanFactory beanFactory) Create a new GenericWebApplicationContext with the given DefaultListableBeanFactory.GenericWebApplicationContext(DefaultListableBeanFactory beanFactory, ServletContext servletContext) Create a new GenericWebApplicationContext with the given DefaultListableBeanFactory.
- 
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 the ServletContext.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.Return the Theme instance for the given theme name.protected voidReplace any stub property sources with actual instances.protected voidInitialize the theme capability.protected voidpostProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) Register ServletContextAwareProcessor.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(String namespace) Set the namespace for this web application context, to be used for building a default context config location.voidsetServletConfig(ServletConfig servletConfig) Set the ServletConfig for this web application context.voidsetServletContext(ServletContext servletContext) Set the ServletContext that this WebApplicationContext runs in.Methods inherited from class org.springframework.context.support.GenericApplicationContextcancelRefresh, closeBeanFactory, getAutowireCapableBeanFactory, getBeanDefinition, getBeanFactory, getClassLoader, getDefaultListableBeanFactory, getResource, getResources, isAlias, isBeanNameInUse, refreshBeanFactory, registerAlias, registerBean, registerBean, registerBean, registerBean, registerBean, registerBean, registerBeanDefinition, removeAlias, removeBeanDefinition, setAllowBeanDefinitionOverriding, setAllowCircularReferences, setApplicationStartup, setClassLoader, setParent, setResourceLoaderMethods inherited from class org.springframework.context.support.AbstractApplicationContextaddApplicationListener, 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, toStringMethods inherited from class org.springframework.core.io.DefaultResourceLoaderaddProtocolResolver, clearResourceCaches, getProtocolResolvers, getResourceCacheMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.springframework.core.AliasRegistrygetAliasesMethods inherited from interface org.springframework.context.ApplicationContextgetAutowireCapableBeanFactory, getDisplayName, getId, getParent, getStartupDateMethods inherited from interface org.springframework.context.ApplicationEventPublisherpublishEvent, publishEventMethods inherited from interface org.springframework.beans.factory.support.BeanDefinitionRegistrycontainsBeanDefinition, getBeanDefinitionCount, getBeanDefinitionNamesMethods inherited from interface org.springframework.beans.factory.BeanFactorycontainsBean, getAliases, getBean, getBean, getBean, getBean, getBean, getBeanProvider, getBeanProvider, getType, getType, isPrototype, isSingleton, isTypeMatch, isTypeMatchMethods inherited from interface org.springframework.context.ConfigurableApplicationContextaddApplicationListener, addBeanFactoryPostProcessor, addProtocolResolver, close, getApplicationStartup, getBeanFactory, getEnvironment, isActive, refresh, registerShutdownHook, setApplicationStartup, setClassLoader, setEnvironment, setId, setParentMethods inherited from interface org.springframework.beans.factory.HierarchicalBeanFactorycontainsLocalBean, getParentBeanFactoryMethods inherited from interface org.springframework.beans.factory.ListableBeanFactorycontainsBeanDefinition, findAnnotationOnBean, findAnnotationOnBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanProvider, getBeanProvider, getBeansOfType, getBeansOfType, getBeansWithAnnotationMethods inherited from interface org.springframework.context.MessageSourcegetMessage, getMessage, getMessageMethods inherited from interface org.springframework.core.io.ResourceLoadergetClassLoader, getResourceMethods inherited from interface org.springframework.core.io.support.ResourcePatternResolvergetResources
- 
Constructor Details- 
GenericWebApplicationContextpublic GenericWebApplicationContext()Create a new GenericWebApplicationContext.
- 
GenericWebApplicationContextCreate a new GenericWebApplicationContext for the given ServletContext.- Parameters:
- servletContext- the ServletContext to run in
- See Also:
 
- 
GenericWebApplicationContextCreate a new GenericWebApplicationContext with the given DefaultListableBeanFactory.- Parameters:
- beanFactory- the DefaultListableBeanFactory instance to use for this context
- See Also:
 
- 
GenericWebApplicationContextpublic GenericWebApplicationContext(DefaultListableBeanFactory beanFactory, ServletContext servletContext) Create a new GenericWebApplicationContext with the given DefaultListableBeanFactory.- Parameters:
- beanFactory- the DefaultListableBeanFactory instance to use for this context
- servletContext- the ServletContext to run in
- See Also:
 
 
- 
- 
Method Details- 
setServletContextSet the ServletContext that this WebApplicationContext runs 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 ServletContextAwareProcessor.- Overrides:
- postProcessBeanFactoryin class- AbstractApplicationContext
- Parameters:
- beanFactory- the bean factory used by the application context
- See Also:
 
- 
getResourceByPathThis implementation supports file paths beneath the root of the ServletContext.- 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:
 
- 
onRefreshprotected void onRefresh()Initialize the theme capability.- Overrides:
- onRefreshin class- AbstractApplicationContext
- See Also:
 
- 
initPropertySourcesprotected void initPropertySources()Replace any stub property sources with actual instances. Replace Servlet-related property sources.
- 
getThemeDescription copied from interface:ThemeSourceReturn 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:
- getThemein interface- ThemeSource
- Parameters:
- themeName- the name of the theme
- Returns:
- the corresponding Theme, or nullif 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:
 
- 
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
 
 
-