Class AbstractRefreshableWebApplicationContext
- All Implemented Interfaces:
- Closeable,- AutoCloseable,- Aware,- BeanFactory,- BeanNameAware,- HierarchicalBeanFactory,- InitializingBean,- ListableBeanFactory,- ApplicationContext,- ApplicationEventPublisher,- ConfigurableApplicationContext,- Lifecycle,- MessageSource,- EnvironmentCapable,- ResourceLoader,- ResourcePatternResolver,- ThemeSource,- ConfigurableWebApplicationContext,- WebApplicationContext
- Direct Known Subclasses:
- AnnotationConfigWebApplicationContext,- GroovyWebApplicationContext,- XmlWebApplicationContext
AbstractRefreshableApplicationContext
 subclass which implements the
 ConfigurableWebApplicationContext
 interface for web environments. Provides a "configLocations" property,
 to be populated through the ConfigurableWebApplicationContext interface
 on web application startup.
 This class is as easy to subclass as AbstractRefreshableApplicationContext:
 All you need to implement is the AbstractRefreshableApplicationContext.loadBeanDefinitions(org.springframework.beans.factory.support.DefaultListableBeanFactory) method;
 see the superclass javadoc for details. Note that implementations are supposed
 to load bean definitions from the files specified by the locations returned
 by the getConfigLocations() 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
 DefaultResourceLoader.
 
In addition to the special beans detected by
 AbstractApplicationContext,
 this class detects a bean of type ThemeSource
 in the context, under the special bean name "themeSource".
 Theme support is deprecated as of 6.0 with no direct replacement.
 
This is the web context to be subclassed for a different bean definition format.
 Such a context implementation can be specified as "contextClass" context-param
 for ContextLoader or as "contextClass"
 init-param for FrameworkServlet,
 replacing the default XmlWebApplicationContext. It will then automatically
 receive the "contextConfigLocation" context-param or init-param, respectively.
 
Note that WebApplicationContext implementations are generally supposed
 to configure themselves based on the configuration received through the
 ConfigurableWebApplicationContext interface. In contrast, a standalone
 application context might allow for configuration in custom startup code
 (for example, GenericApplicationContext).
- 
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, 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 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 SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected ConfigurableEnvironmentCreate and return a newStandardServletEnvironment.Return a name for the deployed application that this context belongs to.String[]Return an array of resource locations, referring to the XML bean definition files that this context should be built with.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.Deprecated.protected voidReplace any stub property sources with actual instances.protected voidInitialize the theme capability.protected voidpostProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) Register request/session scopes, aServletContextAwareProcessor, etc.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 for this web application context.Methods inherited from class org.springframework.context.support.AbstractRefreshableConfigApplicationContextafterPropertiesSet, getDefaultConfigLocations, resolvePath, setBeanName, setConfigLocation, setConfigLocations, setIdMethods inherited from class org.springframework.context.support.AbstractRefreshableApplicationContextassertBeanFactoryActive, cancelRefresh, closeBeanFactory, createBeanFactory, customizeBeanFactory, getBeanFactory, hasBeanFactory, loadBeanDefinitions, refreshBeanFactory, setAllowBeanDefinitionOverriding, setAllowCircularReferencesMethods inherited from class org.springframework.context.support.AbstractApplicationContextaddApplicationListener, addBeanFactoryPostProcessor, clearResourceCaches, close, containsBean, containsBeanDefinition, containsLocalBean, destroyBeans, doClose, findAllAnnotationsOnBean, findAnnotationOnBean, findAnnotationOnBean, finishBeanFactoryInitialization, finishRefresh, getAliases, getApplicationListeners, getApplicationStartup, getAutowireCapableBeanFactory, 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, getResources, getStartupDate, getType, getType, initApplicationEventMulticaster, initLifecycleProcessor, initMessageSource, invokeBeanFactoryPostProcessors, isActive, isClosed, isPrototype, isRunning, isSingleton, isTypeMatch, isTypeMatch, obtainFreshBeanFactory, onClose, prepareBeanFactory, prepareRefresh, publishEvent, publishEvent, publishEvent, refresh, registerBeanPostProcessors, registerListeners, registerShutdownHook, removeApplicationListener, resetCommonCaches, setApplicationStartup, setDisplayName, setEnvironment, setParent, start, stop, toStringMethods inherited from class org.springframework.core.io.DefaultResourceLoaderaddProtocolResolver, getClassLoader, getProtocolResolvers, getResource, getResourceCache, setClassLoaderMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods 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.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, isClosed, refresh, registerShutdownHook, removeApplicationListener, setApplicationStartup, setClassLoader, setEnvironment, setId, setParentMethods inherited from interface org.springframework.web.context.ConfigurableWebApplicationContextsetConfigLocation, setConfigLocationsMethods inherited from interface org.springframework.beans.factory.HierarchicalBeanFactorycontainsLocalBean, getParentBeanFactoryMethods inherited from interface org.springframework.beans.factory.ListableBeanFactorycontainsBeanDefinition, findAllAnnotationsOnBean, 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- 
AbstractRefreshableWebApplicationContextpublic AbstractRefreshableWebApplicationContext()
 
- 
- 
Method Details- 
setServletContextDescription copied from interface:ConfigurableWebApplicationContextSet the ServletContext for this web application context.Does not cause an initialization of the context: refresh needs to be called after the setting of all configuration properties. - 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
 
- 
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
 
- 
getConfigLocationsDescription copied from class:AbstractRefreshableConfigApplicationContextReturn an array of resource locations, referring to the XML bean definition files that this context should be built with. Can also include location patterns, which will get resolved via a ResourcePatternResolver.The default implementation returns null. Subclasses can override this to provide a set of resource locations to load bean definitions from.- Specified by:
- getConfigLocationsin interface- ConfigurableWebApplicationContext
- Overrides:
- getConfigLocationsin class- AbstractRefreshableConfigApplicationContext
- Returns:
- an array of resource locations, or nullif none
- See Also:
 
- 
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. Subclasses may override in order to configure the environment or specialize the environment type returned.- Overrides:
- createEnvironmentin class- AbstractApplicationContext
 
- 
postProcessBeanFactoryRegister request/session scopes, 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 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.
- 
getThemeDeprecated.Description 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:
 
 
-