public class

GenericWebApplicationContext

extends GenericApplicationContext
implements ThemeSource WebApplicationContext

java.lang.Object
↳	org.springframework.core.io.DefaultResourceLoader
	↳	org.springframework.context.support.AbstractApplicationContext
		↳	org.springframework.context.support.GenericApplicationContext
			↳	org.springframework.web.context.support.GenericWebApplicationContext

Class Overview

Subclass of GenericApplicationContext, suitable for web environments.

Implements the WebApplicationContext interface, but not ConfigurableWebApplicationContext, as it is not intended for declarative setup in web.xml. Instead, it is designed for programmatic setup, for example for building nested contexts.

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".

Summary

[Expand]

Inherited Constants

From class org.springframework.context.support.AbstractApplicationContext

From interface org.springframework.beans.factory.BeanFactory

From interface org.springframework.context.ConfigurableApplicationContext

From interface org.springframework.core.io.ResourceLoader

From interface org.springframework.core.io.support.ResourcePatternResolver

From interface org.springframework.web.context.WebApplicationContext

[Expand]

Inherited Fields

From class org.springframework.context.support.AbstractApplicationContext

From interface org.springframework.web.context.WebApplicationContext

Public Constructors
	GenericWebApplicationContext() Create 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.

Public Methods
ServletContext	getServletContext() Return the standard Servlet API ServletContext for this application.
Theme	getTheme(String themeName) Return the Theme instance for the given theme name.
void	setServletContext(ServletContext servletContext) Set the ServletContext that this WebApplicationContext runs in.

Protected Methods
ConfigurableEnvironment	createEnvironment() Create and return a new `DefaultWebEnvironment`.
Resource	getResourceByPath(String path) This implementation supports file paths beneath the root of the ServletContext.
ResourcePatternResolver	getResourcePatternResolver() This implementation supports pattern matching in unexpanded WARs too.
void	initPropertySources() Replace any stub property sources with actual instances. Replace `Servlet`-related property sources.
void	onRefresh() Initialize the theme capability.
void	postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) Register ServletContextAwareProcessor.

[Expand]

Inherited Methods

From class org.springframework.context.support.GenericApplicationContext

void	cancelRefresh(BeansException ex) Cancel this context's refresh attempt, resetting the `active` flag after an exception got thrown.
final void	closeBeanFactory() Not much to do: We hold a single internal BeanFactory that will never get released.
BeanDefinition	getBeanDefinition(String beanName) Return the BeanDefinition for the given bean name.
final ConfigurableListableBeanFactory	getBeanFactory() Return the single internal BeanFactory held by this context (as ConfigurableListableBeanFactory).
final DefaultListableBeanFactory	getDefaultListableBeanFactory() Return the underlying bean factory of this context, available for registering bean definitions.
Resource	getResource(String location) This implementation delegates to this context's ResourceLoader if set, falling back to the default superclass behavior else.
Resource[]	getResources(String locationPattern) This implementation delegates to this context's ResourceLoader if it implements the ResourcePatternResolver interface, falling back to the default superclass behavior else.
boolean	isAlias(String beanName) Determine whether this given name is defines as an alias (as opposed to the name of an actually registered component).
boolean	isBeanNameInUse(String beanName) Determine whether the given bean name is already in use within this registry, i.e.
final void	refreshBeanFactory() Do nothing: We hold a single internal BeanFactory and rely on callers to register beans through our public methods (or the BeanFactory's).
void	registerAlias(String beanName, String alias) Given a name, register an alias for it.
void	registerBeanDefinition(String beanName, BeanDefinition beanDefinition) Register a new bean definition with this registry.
void	removeAlias(String alias) Remove the specified alias from this registry.
void	removeBeanDefinition(String beanName) Remove the BeanDefinition for the given name.
void	setAllowBeanDefinitionOverriding(boolean allowBeanDefinitionOverriding) Set whether it should be allowed to override bean definitions by registering a different definition with the same name, automatically replacing the former.
void	setAllowCircularReferences(boolean allowCircularReferences) Set whether to allow circular references between beans - and automatically try to resolve them.
void	setId(String id) Set the unique id of this application context.
void	setParent(ApplicationContext parent) Set the parent of this application context, also setting the parent of the internal BeanFactory accordingly.
void	setResourceLoader(ResourceLoader resourceLoader) Set a ResourceLoader to use for this context.

From class org.springframework.context.support.AbstractApplicationContext

void	addApplicationListener(ApplicationListener<?> listener) Add a new ApplicationListener that will be notified on context events such as context refresh and context shutdown.
void	addBeanFactoryPostProcessor(BeanFactoryPostProcessor beanFactoryPostProcessor) Add a new BeanFactoryPostProcessor that will get applied to the internal bean factory of this application context on refresh, before any of the bean definitions get evaluated.
void	addListener(ApplicationListener<?> listener) This method is deprecated. as of Spring 3.0, in favor of `addApplicationListener(ApplicationListener)`
void	cancelRefresh(BeansException ex) Cancel this context's refresh attempt, resetting the `active` flag after an exception got thrown.
void	close() Close this application context, destroying all beans in its bean factory.
abstract void	closeBeanFactory() Subclasses must implement this method to release their internal bean factory.
boolean	containsBean(String name) Does this bean factory contain a bean with the given name? More specifically, is `getBean(Class)` able to obtain a bean instance for the given name? Translates aliases back to the corresponding canonical bean name.
boolean	containsBeanDefinition(String beanName) Check if this bean factory contains a bean definition with the given name.
boolean	containsLocalBean(String name) Return whether the local bean factory contains a bean of the given name, ignoring beans defined in ancestor contexts.
ConfigurableEnvironment	createEnvironment() Create and return a new `DefaultEnvironment`.
void	destroy() DisposableBean callback for destruction of this instance.
void	destroyBeans() Template method for destroying all beans that this context manages.
void	doClose() Actually performs context closing: publishes a ContextClosedEvent and destroys the singletons in the bean factory of this application context.
<A extends Annotation> A	findAnnotationOnBean(String beanName, Class<A> annotationType) Find a `Annotation` of `annotationType` on the specified bean, traversing its interfaces and super classes if no annotation can be found on the given class itself.
void	finishBeanFactoryInitialization(ConfigurableListableBeanFactory beanFactory) Finish the initialization of this context's bean factory, initializing all remaining singleton beans.
void	finishRefresh() Finish the refresh of this context, invoking the LifecycleProcessor's onRefresh() method and publishing the `ContextRefreshedEvent`.
String[]	getAliases(String name) Return the aliases for the given bean name, if any.
Collection<ApplicationListener<?>>	getApplicationListeners() Return the list of statically specified ApplicationListeners.
AutowireCapableBeanFactory	getAutowireCapableBeanFactory() Return this context's internal bean factory as AutowireCapableBeanFactory, if already available.
<T> T	getBean(Class<T> requiredType) Return the bean instance that uniquely matches the given object type, if any.
Object	getBean(String name, Object... args) Return an instance, which may be shared or independent, of the specified bean.
<T> T	getBean(String name, Class<T> requiredType) Return an instance, which may be shared or independent, of the specified bean.
Object	getBean(String name) Return an instance, which may be shared or independent, of the specified bean.
int	getBeanDefinitionCount() Return the number of beans defined in the factory.
String[]	getBeanDefinitionNames() Return the names of all beans defined in this factory.
abstract ConfigurableListableBeanFactory	getBeanFactory() Subclasses must return their internal bean factory here.
List<BeanFactoryPostProcessor>	getBeanFactoryPostProcessors() Return the list of BeanFactoryPostProcessors that will get applied to the internal BeanFactory.
String[]	getBeanNamesForType(Class<?> type, boolean includeNonSingletons, boolean allowEagerInit) Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
String[]	getBeanNamesForType(Class<?> type) Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
<T> Map<String, T>	getBeansOfType(Class<T> type, boolean includeNonSingletons, boolean allowEagerInit) Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
<T> Map<String, T>	getBeansOfType(Class<T> type) Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
Map<String, Object>	getBeansWithAnnotation(Class<? extends Annotation> annotationType) Find all beans whose `Class` has the supplied `Annotation` type.
String	getDisplayName() Return a friendly name for this context.
ConfigurableEnvironment	getEnvironment() Return the Environment for this application context in configurable form.
String	getId() Return the unique id of this application context.
BeanFactory	getInternalParentBeanFactory() Return the internal bean factory of the parent context if it implements ConfigurableApplicationContext; else, return the parent context itself.
MessageSource	getInternalParentMessageSource() Return the internal message source of the parent context if it is an AbstractApplicationContext too; else, return the parent context itself.
String	getMessage(MessageSourceResolvable resolvable, Locale locale) Try to resolve the message using all the attributes contained within the `MessageSourceResolvable` argument that was passed in.
String	getMessage(String code, Object[] args, Locale locale) Try to resolve the message.
String	getMessage(String code, Object[] args, String defaultMessage, Locale locale) Try to resolve the message.
ApplicationContext	getParent() Return the parent context, or `null` if there is no parent (that is, this context is the root of the context hierarchy).
BeanFactory	getParentBeanFactory() Return the parent bean factory, or `null` if there is none.
ResourcePatternResolver	getResourcePatternResolver() Return the ResourcePatternResolver to use for resolving location patterns into Resource instances.
Resource[]	getResources(String locationPattern) Resolve the given location pattern into Resource objects.
long	getStartupDate() Return the timestamp (ms) when this context was first loaded.
Class<?>	getType(String name) Determine the type of the bean with the given name.
void	initApplicationEventMulticaster() Initialize the ApplicationEventMulticaster.
void	initLifecycleProcessor() Initialize the LifecycleProcessor.
void	initMessageSource() Initialize the MessageSource.
void	initPropertySources() Replace any stub property sources with actual instances.
void	invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory beanFactory) Instantiate and invoke all registered BeanFactoryPostProcessor beans, respecting explicit order if given.
boolean	isActive() Determine whether this application context is active, that is, whether it has been refreshed at least once and has not been closed yet.
boolean	isPrototype(String name) Is this bean a prototype? That is, will `getBean(Class)` always return independent instances? Note: This method returning `false` does not clearly indicate a singleton object.
boolean	isRunning() Check whether this component is currently running.
boolean	isSingleton(String name) Is this bean a shared singleton? That is, will `getBean(Class)` always return the same instance? Note: This method returning `false` does not clearly indicate independent instances.
boolean	isTypeMatch(String name, Class<?> targetType) Check whether the bean with the given name matches the specified type.
ConfigurableListableBeanFactory	obtainFreshBeanFactory() Tell the subclass to refresh the internal bean factory.
void	onClose() Template method which can be overridden to add context-specific shutdown work.
void	onRefresh() Template method which can be overridden to add context-specific refresh work.
void	postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) Modify the application context's internal bean factory after its standard initialization.
void	prepareBeanFactory(ConfigurableListableBeanFactory beanFactory) Configure the factory's standard context characteristics, such as the context's ClassLoader and post-processors.
void	prepareRefresh() Prepare this context for refreshing, setting its startup date and active flag as well as performing any initialization of property sources.
void	publishEvent(ApplicationEvent event) Publish the given event to all listeners.
void	refresh() Load or refresh the persistent representation of the configuration, which might an XML file, properties file, or relational database schema.
abstract void	refreshBeanFactory() Subclasses must implement this method to perform the actual configuration load.
void	registerBeanPostProcessors(ConfigurableListableBeanFactory beanFactory) Instantiate and invoke all registered BeanPostProcessor beans, respecting explicit order if given.
void	registerListeners() Add beans that implement ApplicationListener as listeners.
void	registerShutdownHook() Register a shutdown hook with the JVM runtime, closing this context on JVM shutdown unless it has already been closed at that time.
void	setDisplayName(String displayName) Set a friendly name for this context.
void	setEnvironment(ConfigurableEnvironment environment) Set the `Environment` for this application context. Default value is determined by `createEnvironment()`.
void	setId(String id) Set the unique id of this application context.
void	setParent(ApplicationContext parent) Set the parent of this application context.
void	start() Start this component.
void	stop() Stop this component.
String	toString() Return information about this context.

From class org.springframework.core.io.DefaultResourceLoader

From class java.lang.Object

From interface org.springframework.beans.factory.BeanFactory

abstract boolean	containsBean(String name) Does this bean factory contain a bean with the given name? More specifically, is `getBean(Class)` able to obtain a bean instance for the given name? Translates aliases back to the corresponding canonical bean name.
abstract String[]	getAliases(String name) Return the aliases for the given bean name, if any.
abstract Object	getBean(String name) Return an instance, which may be shared or independent, of the specified bean.
abstract Object	getBean(String name, Object... args) Return an instance, which may be shared or independent, of the specified bean.
abstract <T> T	getBean(Class<T> requiredType) Return the bean instance that uniquely matches the given object type, if any.
abstract <T> T	getBean(String name, Class<T> requiredType) Return an instance, which may be shared or independent, of the specified bean.
abstract Class<?>	getType(String name) Determine the type of the bean with the given name.
abstract boolean	isPrototype(String name) Is this bean a prototype? That is, will `getBean(Class)` always return independent instances? Note: This method returning `false` does not clearly indicate a singleton object.
abstract boolean	isSingleton(String name) Is this bean a shared singleton? That is, will `getBean(Class)` always return the same instance? Note: This method returning `false` does not clearly indicate independent instances.
abstract boolean	isTypeMatch(String name, Class<?> targetType) Check whether the bean with the given name matches the specified type.

From interface org.springframework.beans.factory.DisposableBean

From interface org.springframework.beans.factory.HierarchicalBeanFactory

From interface org.springframework.beans.factory.ListableBeanFactory

abstract boolean	containsBeanDefinition(String beanName) Check if this bean factory contains a bean definition with the given name.
abstract <A extends Annotation> A	findAnnotationOnBean(String beanName, Class<A> annotationType) Find a `Annotation` of `annotationType` on the specified bean, traversing its interfaces and super classes if no annotation can be found on the given class itself.
abstract int	getBeanDefinitionCount() Return the number of beans defined in the factory.
abstract String[]	getBeanDefinitionNames() Return the names of all beans defined in this factory.
abstract String[]	getBeanNamesForType(Class<?> type, boolean includeNonSingletons, boolean allowEagerInit) Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
abstract String[]	getBeanNamesForType(Class<?> type) Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
abstract <T> Map<String, T>	getBeansOfType(Class<T> type) Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
abstract <T> Map<String, T>	getBeansOfType(Class<T> type, boolean includeNonSingletons, boolean allowEagerInit) Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
abstract Map<String, Object>	getBeansWithAnnotation(Class<? extends Annotation> annotationType) Find all beans whose `Class` has the supplied `Annotation` type.

From interface org.springframework.beans.factory.support.BeanDefinitionRegistry

From interface org.springframework.context.ApplicationContext

From interface org.springframework.context.ApplicationEventPublisher

From interface org.springframework.context.ConfigurableApplicationContext

abstract void	addApplicationListener(ApplicationListener<?> listener) Add a new ApplicationListener that will be notified on context events such as context refresh and context shutdown.
abstract void	addBeanFactoryPostProcessor(BeanFactoryPostProcessor beanFactoryPostProcessor) Add a new BeanFactoryPostProcessor that will get applied to the internal bean factory of this application context on refresh, before any of the bean definitions get evaluated.
abstract void	close() Close this application context, releasing all resources and locks that the implementation might hold.
abstract ConfigurableListableBeanFactory	getBeanFactory() Return the internal bean factory of this application context.
abstract ConfigurableEnvironment	getEnvironment() Return the Environment for this application context in configurable form.
abstract boolean	isActive() Determine whether this application context is active, that is, whether it has been refreshed at least once and has not been closed yet.
abstract void	refresh() Load or refresh the persistent representation of the configuration, which might an XML file, properties file, or relational database schema.
abstract void	registerShutdownHook() Register a shutdown hook with the JVM runtime, closing this context on JVM shutdown unless it has already been closed at that time.
abstract void	setEnvironment(ConfigurableEnvironment environment) Set the `Environment` for this application context.
abstract void	setId(String id) Set the unique id of this application context.
abstract void	setParent(ApplicationContext parent) Set the parent of this application context.

From interface org.springframework.context.Lifecycle

From interface org.springframework.context.MessageSource

From interface org.springframework.core.AliasRegistry

From interface org.springframework.core.env.EnvironmentCapable

From interface org.springframework.core.io.ResourceLoader

From interface org.springframework.core.io.support.ResourcePatternResolver

From interface org.springframework.ui.context.ThemeSource

From interface org.springframework.web.context.WebApplicationContext

Public Constructors

public GenericWebApplicationContext ()

Create a new GenericWebApplicationContext.

public GenericWebApplicationContext (ServletContext servletContext)

Create a new GenericWebApplicationContext for the given ServletContext.

Parameters

servletContext	the ServletContext to run in

public GenericWebApplicationContext (DefaultListableBeanFactory beanFactory)

Create a new GenericWebApplicationContext with the given DefaultListableBeanFactory.

Parameters

beanFactory	the DefaultListableBeanFactory instance to use for this context

public 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

Public Methods

public ServletContext getServletContext ()

Return the standard Servlet API ServletContext for this application.

Also available for a Portlet application, in addition to the PortletContext.

public Theme getTheme (String themeName)

Return 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).

Parameters

themeName	the name of the theme

Returns

the corresponding Theme, or null 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.

public void setServletContext (ServletContext servletContext)

Set the ServletContext that this WebApplicationContext runs in.

Protected Methods

protected ConfigurableEnvironment createEnvironment ()

Create and return a new DefaultWebEnvironment.

protected Resource getResourceByPath (String path)

This implementation supports file paths beneath the root of the ServletContext.

Parameters

path	the path to the resource

Returns

the corresponding Resource handle

protected ResourcePatternResolver getResourcePatternResolver ()

This implementation supports pattern matching in unexpanded WARs too.

Returns

the ResourcePatternResolver for this context

protected void initPropertySources ()

Replace any stub property sources with actual instances.

Replace Servlet-related property sources.

protected void onRefresh ()

Initialize the theme capability.

protected void postProcessBeanFactory (ConfigurableListableBeanFactory beanFactory)

Register ServletContextAwareProcessor.

Parameters

beanFactory	the bean factory used by the application context

Classes

GenericWebApplicationContext

Class Overview

Summary

Public Constructors

public GenericWebApplicationContext ()

See Also

public GenericWebApplicationContext (ServletContext servletContext)

Parameters

See Also

public GenericWebApplicationContext (DefaultListableBeanFactory beanFactory)

Parameters

See Also

public GenericWebApplicationContext (DefaultListableBeanFactory beanFactory, ServletContext servletContext)

Parameters

See Also

Public Methods

public ServletContext getServletContext ()

public Theme getTheme (String themeName)

Parameters

Returns

public void setServletContext (ServletContext servletContext)

Protected Methods

protected ConfigurableEnvironment createEnvironment ()

protected Resource getResourceByPath (String path)

Parameters

Returns

See Also

protected ResourcePatternResolver getResourcePatternResolver ()

Returns

See Also

protected void initPropertySources ()

protected void onRefresh ()

protected void postProcessBeanFactory (ConfigurableListableBeanFactory beanFactory)

Parameters

See Also