Class AbstractRefreshableWebApplicationContext
- All Implemented Interfaces:
- Closeable, AutoCloseable, Aware, BeanFactory, BeanNameAware, HierarchicalBeanFactory, InitializingBean, ListableBeanFactory, ApplicationContext, ApplicationEventPublisher, ConfigurableApplicationContext, Lifecycle, MessageSource, EnvironmentCapable, ResourceLoader, ResourcePatternResolver, 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(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, for example, for files outside the web app root,
can be accessed via "file:" URLs, as implemented by
DefaultResourceLoader.
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).
- Since:
- 1.1.3
- Author:
- Juergen Hoeller
- See Also:
- 
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 SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected ConfigurableEnvironmentCreate and return a newStandardServletEnvironment.Return a name for the deployed application that this context belongs to.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.@Nullable jakarta.servlet.ServletConfigReturn the ServletConfig for this web application context, if any.@Nullable jakarta.servlet.ServletContextReturn 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, aServletContextAwareProcessor, etc.voidsetNamespace(@Nullable String namespace) Set the namespace for this web application context, to be used for building a default context config location.voidsetServletConfig(@Nullable jakarta.servlet.ServletConfig servletConfig) Set the ServletConfig for this web application context.voidsetServletContext(@Nullable jakarta.servlet.ServletContext servletContext) Set the ServletContext for this web application context.Methods inherited from class AbstractRefreshableConfigApplicationContextafterPropertiesSet, getDefaultConfigLocations, resolvePath, setBeanName, setConfigLocation, setConfigLocations, setIdMethods inherited from class AbstractRefreshableApplicationContextassertBeanFactoryActive, cancelRefresh, closeBeanFactory, createBeanFactory, customizeBeanFactory, getBeanFactory, hasBeanFactory, loadBeanDefinitions, refreshBeanFactory, setAllowBeanDefinitionOverriding, setAllowCircularReferencesMethods inherited from class 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, 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, onRefresh, pause, prepareBeanFactory, prepareRefresh, publishEvent, publishEvent, publishEvent, refresh, registerBeanPostProcessors, registerListeners, registerShutdownHook, removeApplicationListener, resetCommonCaches, restart, setApplicationStartup, setDisplayName, setEnvironment, setParent, start, stop, toStringMethods inherited from class DefaultResourceLoaderaddProtocolResolver, getClassLoader, getProtocolResolvers, getResource, getResourceCache, setClassLoaderMethods inherited from class Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface ApplicationContextgetAutowireCapableBeanFactory, getDisplayName, getId, getParent, getStartupDateMethods inherited from interface ApplicationEventPublisherpublishEvent, publishEventMethods 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 ConfigurableWebApplicationContextsetConfigLocation, setConfigLocationsMethods 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- 
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:
 
- 
initPropertySourcesprotected void initPropertySources()Replace any stub property sources with actual instances. Replace Servlet-related property sources.- Overrides:
- initPropertySourcesin class- AbstractApplicationContext
- See Also:
 
 
-