public class GenericWebApplicationContext extends GenericApplicationContext implements ConfigurableWebApplicationContext, ThemeSource
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".
DefaultResourceLoader.ClassPathContextResource
Modifier and Type | Field and Description |
---|---|
private ServletContext |
servletContext |
private ThemeSource |
themeSource |
APPLICATION_EVENT_MULTICASTER_BEAN_NAME, LIFECYCLE_PROCESSOR_BEAN_NAME, logger, MESSAGE_SOURCE_BEAN_NAME
APPLICATION_CONTEXT_ID_PREFIX, SERVLET_CONFIG_BEAN_NAME
CONTEXT_ATTRIBUTES_BEAN_NAME, CONTEXT_PARAMETERS_BEAN_NAME, ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, SCOPE_APPLICATION, SCOPE_REQUEST, SCOPE_SESSION, SERVLET_CONTEXT_BEAN_NAME
CONFIG_LOCATION_DELIMITERS, CONVERSION_SERVICE_BEAN_NAME, ENVIRONMENT_BEAN_NAME, LOAD_TIME_WEAVER_BEAN_NAME, SYSTEM_ENVIRONMENT_BEAN_NAME, SYSTEM_PROPERTIES_BEAN_NAME
FACTORY_BEAN_PREFIX
CLASSPATH_ALL_URL_PREFIX
CLASSPATH_URL_PREFIX
Constructor and Description |
---|
GenericWebApplicationContext()
Create a new GenericWebApplicationContext.
|
GenericWebApplicationContext(DefaultListableBeanFactory beanFactory,
ServletContext servletContext)
Create a new GenericWebApplicationContext with the given DefaultListableBeanFactory.
|
GenericWebApplicationContext(ServletContext servletContext)
Create a new GenericWebApplicationContext for the given ServletContext.
|
Modifier and Type | Method and Description |
---|---|
protected ConfigurableEnvironment |
createEnvironment()
Create and return a new
StandardServletEnvironment . |
java.lang.String |
getApplicationName()
Return a name for the deployed application that this context belongs to.
|
java.lang.String[] |
getConfigLocations()
Return the config locations for this web application context,
or
null if none specified. |
java.lang.String |
getNamespace()
Return the namespace for this web application context, if any.
|
protected Resource |
getResourceByPath(java.lang.String path)
This implementation supports file paths beneath the root of the ServletContext.
|
protected ResourcePatternResolver |
getResourcePatternResolver()
This implementation supports pattern matching in unexpanded WARs too.
|
ServletConfig |
getServletConfig()
Return the ServletConfig for this web application context, if any.
|
ServletContext |
getServletContext()
Return the standard Servlet API ServletContext for this application.
|
Theme |
getTheme(java.lang.String themeName)
Return the Theme instance for the given theme name.
|
protected void |
initPropertySources()
Replace any stub property sources with actual instances.
|
protected void |
onRefresh()
Initialize the theme capability.
|
protected void |
postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
Register ServletContextAwareProcessor.
|
void |
setConfigLocation(java.lang.String configLocation)
Set the config locations for this web application context in init-param style,
i.e.
|
void |
setConfigLocations(java.lang.String... configLocations)
Set the config locations for this web application context.
|
void |
setNamespace(java.lang.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 the ServletContext that this WebApplicationContext runs in.
|
cancelRefresh, closeBeanFactory, getAutowireCapableBeanFactory, getBeanDefinition, getBeanFactory, getClassLoader, getDefaultListableBeanFactory, getResource, getResources, isAlias, isBeanNameInUse, refreshBeanFactory, registerAlias, registerBean, registerBean, registerBean, registerBean, registerBean, registerBean, registerBeanDefinition, removeAlias, removeBeanDefinition, setAllowBeanDefinitionOverriding, setAllowCircularReferences, setClassLoader, setParent, setResourceLoader
addApplicationListener, addBeanFactoryPostProcessor, assertBeanFactoryActive, close, containsBean, containsBeanDefinition, containsLocalBean, destroy, destroyBeans, doClose, findAnnotationOnBean, finishBeanFactoryInitialization, finishRefresh, getAliases, getApplicationListeners, getBean, getBean, getBean, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanFactoryPostProcessors, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanProvider, getBeanProvider, getBeansOfType, getBeansOfType, getBeansWithAnnotation, getDisplayName, getEnvironment, getId, getInternalParentBeanFactory, getInternalParentMessageSource, getMessage, getMessage, getMessage, getParent, getParentBeanFactory, getStartupDate, 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
addProtocolResolver, clearResourceCaches, getProtocolResolvers, getResourceCache
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addApplicationListener, addBeanFactoryPostProcessor, addProtocolResolver, close, getBeanFactory, getEnvironment, isActive, refresh, registerShutdownHook, setEnvironment, setId, setParent
getAutowireCapableBeanFactory, getDisplayName, getId, getParent, getStartupDate
containsBeanDefinition, findAnnotationOnBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType, getBeansWithAnnotation
containsLocalBean, getParentBeanFactory
containsBean, getAliases, getBean, getBean, getBean, getBean, getBean, getBeanProvider, getBeanProvider, getType, isPrototype, isSingleton, isTypeMatch, isTypeMatch
getMessage, getMessage, getMessage
publishEvent, publishEvent
getResources
getClassLoader, getResource
containsBeanDefinition, getBeanDefinitionCount, getBeanDefinitionNames
getAliases
@Nullable private ServletContext servletContext
@Nullable private ThemeSource themeSource
public GenericWebApplicationContext()
public GenericWebApplicationContext(ServletContext servletContext)
servletContext
- the ServletContext to run inGenericApplicationContext.registerBeanDefinition(java.lang.String, org.springframework.beans.factory.config.BeanDefinition)
,
AbstractApplicationContext.refresh()
public GenericWebApplicationContext(DefaultListableBeanFactory beanFactory, ServletContext servletContext)
beanFactory
- the DefaultListableBeanFactory instance to use for this contextservletContext
- the ServletContext to run inGenericApplicationContext.registerBeanDefinition(java.lang.String, org.springframework.beans.factory.config.BeanDefinition)
,
AbstractApplicationContext.refresh()
public void setServletContext(@Nullable ServletContext servletContext)
setServletContext
in interface ConfigurableWebApplicationContext
ConfigurableApplicationContext.refresh()
@Nullable public ServletContext getServletContext()
WebApplicationContext
getServletContext
in interface WebApplicationContext
public java.lang.String getApplicationName()
ApplicationContext
getApplicationName
in interface ApplicationContext
getApplicationName
in class AbstractApplicationContext
protected ConfigurableEnvironment createEnvironment()
StandardServletEnvironment
.createEnvironment
in class AbstractApplicationContext
protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
postProcessBeanFactory
in class AbstractApplicationContext
beanFactory
- the bean factory used by the application contextServletContextAwareProcessor
protected Resource getResourceByPath(java.lang.String path)
getResourceByPath
in class DefaultResourceLoader
path
- the path to the resourceServletContextResource
protected ResourcePatternResolver getResourcePatternResolver()
getResourcePatternResolver
in class AbstractApplicationContext
ServletContextResourcePatternResolver
protected void onRefresh()
onRefresh
in class AbstractApplicationContext
AbstractApplicationContext.refresh()
protected void initPropertySources()
Replace any stub property sources with actual instances.
Replace Servlet
-related property sources.
@Nullable public Theme getTheme(java.lang.String themeName)
ThemeSource
The returned Theme will resolve theme-specific messages, codes, file paths, etc (e.g. CSS and image files in a web environment).
getTheme
in interface ThemeSource
themeName
- the name of the themenull
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.AbstractThemeResolver.ORIGINAL_DEFAULT_THEME_NAME
public void setServletConfig(@Nullable ServletConfig servletConfig)
ConfigurableWebApplicationContext
setServletConfig
in interface ConfigurableWebApplicationContext
ConfigurableApplicationContext.refresh()
@Nullable public ServletConfig getServletConfig()
ConfigurableWebApplicationContext
getServletConfig
in interface ConfigurableWebApplicationContext
public void setNamespace(@Nullable java.lang.String namespace)
ConfigurableWebApplicationContext
setNamespace
in interface ConfigurableWebApplicationContext
@Nullable public java.lang.String getNamespace()
ConfigurableWebApplicationContext
getNamespace
in interface ConfigurableWebApplicationContext
public void setConfigLocation(java.lang.String configLocation)
ConfigurableWebApplicationContext
If not set, the implementation is supposed to use a default for the given namespace or the root web application context, as appropriate.
setConfigLocation
in interface ConfigurableWebApplicationContext
public void setConfigLocations(java.lang.String... configLocations)
ConfigurableWebApplicationContext
If not set, the implementation is supposed to use a default for the given namespace or the root web application context, as appropriate.
setConfigLocations
in interface ConfigurableWebApplicationContext
public java.lang.String[] getConfigLocations()
ConfigurableWebApplicationContext
null
if none specified.getConfigLocations
in interface ConfigurableWebApplicationContext