Package org.springframework.context.support

Class AbstractApplicationContext

java.lang.Object

org.springframework.core.io.DefaultResourceLoader

org.springframework.context.support.AbstractApplicationContext

All Implemented Interfaces:

Closeable, AutoCloseable, BeanFactory, HierarchicalBeanFactory, ListableBeanFactory, ApplicationContext, ApplicationEventPublisher, ConfigurableApplicationContext, Lifecycle, MessageSource, EnvironmentCapable, ResourceLoader, ResourcePatternResolver

Direct Known Subclasses:

AbstractRefreshableApplicationContext, GenericApplicationContext

public abstract class AbstractApplicationContext
extends DefaultResourceLoader
implements ConfigurableApplicationContext

Abstract implementation of the ApplicationContext interface. Doesn't mandate the type of storage used for configuration; simply implements common context functionality. Uses the Template Method design pattern, requiring concrete subclasses to implement abstract methods.

In contrast to a plain BeanFactory, an ApplicationContext is supposed to detect special beans defined in its internal bean factory: Therefore, this class automatically registers BeanFactoryPostProcessors, BeanPostProcessors, and ApplicationListeners which are defined as beans in the context.

A MessageSource may also be supplied as a bean in the context, with the name "messageSource"; otherwise, message resolution is delegated to the parent context. Furthermore, a multicaster for application events can be supplied as an "applicationEventMulticaster" bean of type ApplicationEventMulticaster in the context; otherwise, a default multicaster of type SimpleApplicationEventMulticaster will be used.

Implements resource loading by extending DefaultResourceLoader. Consequently treats non-URL resource paths as class path resources (supporting full class path resource names that include the package path, e.g. "mypackage/myresource.dat"), unless the DefaultResourceLoader.getResourceByPath(java.lang.String) method is overridden in a subclass.

Since:

January 21, 2001

Author:

Rod Johnson, Juergen Hoeller, Mark Fisher, Stephane Nicoll, Sam Brannen, Sebastien Deleuze, Brian Clozel

See Also:

• refreshBeanFactory()
• getBeanFactory()
• BeanFactoryPostProcessor
• BeanPostProcessor
• ApplicationEventMulticaster
• ApplicationListener
• MessageSource

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.core.io.DefaultResourceLoader

DefaultResourceLoader.ClassPathContextResource

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICATION_EVENT_MULTICASTER_BEAN_NAME	The name of the ApplicationEventMulticaster bean in the context.
static final String	LIFECYCLE_PROCESSOR_BEAN_NAME	The name of the LifecycleProcessor bean in the context.
protected final Log	logger	Logger used by this class.
static final String	MESSAGE_SOURCE_BEAN_NAME	The name of the MessageSource bean in the context.

Fields inherited from interface org.springframework.beans.factory.BeanFactory

FACTORY_BEAN_PREFIX

Fields inherited from interface org.springframework.context.ConfigurableApplicationContext

APPLICATION_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_NAME

Fields inherited from interface org.springframework.core.io.ResourceLoader

CLASSPATH_URL_PREFIX

Fields inherited from interface org.springframework.core.io.support.ResourcePatternResolver

CLASSPATH_ALL_URL_PREFIX

Constructor Summary

Constructors

Constructor	Description
AbstractApplicationContext()	Create a new AbstractApplicationContext with no parent.
AbstractApplicationContext(ApplicationContext parent)	Create a new AbstractApplicationContext with the given parent context.

Method Summary

Modifier and Type	Method	Description
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 postProcessor)	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.
protected void	assertBeanFactoryActive()	Assert that this context's BeanFactory is currently active, throwing an IllegalStateException if it isn't.
protected 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.
protected 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 definition or externally registered singleton instance with the given 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.
protected ConfigurableEnvironment	createEnvironment()	Create and return a new StandardEnvironment.
protected void	destroyBeans()	Template method for destroying all beans that this context manages.
protected void	doClose()	Actually performs context closing: publishes a ContextClosedEvent and destroys the singletons in the bean factory of this application context.
<A extends Annotation> Set<A>	findAllAnnotationsOnBean(String beanName, Class<A> annotationType, boolean allowFactoryBeanInit)	Find all Annotation instances of annotationType on the specified bean, traversing its interfaces and superclasses if no annotation can be found on the given class itself, as well as checking the bean's factory method (if any).
<A extends Annotation> A	findAnnotationOnBean(String beanName, Class<A> annotationType)	Find an Annotation of annotationType on the specified bean, traversing its interfaces and superclasses if no annotation can be found on the given class itself, as well as checking the bean's factory method (if any).
<A extends Annotation> A	findAnnotationOnBean(String beanName, Class<A> annotationType, boolean allowFactoryBeanInit)	Find an Annotation of annotationType on the specified bean, traversing its interfaces and superclasses if no annotation can be found on the given class itself, as well as checking the bean's factory method (if any).
protected void	finishBeanFactoryInitialization(ConfigurableListableBeanFactory beanFactory)	Finish the initialization of this context's bean factory, initializing all remaining singleton beans.
protected 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.
String	getApplicationName()	Return a name for the deployed application that this context belongs to.
ApplicationStartup	getApplicationStartup()	Return the ApplicationStartup for this application context.
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.
<T> T	getBean(Class<T> requiredType, Object... args)	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.
<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, Object... args)	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[]	getBeanNamesForAnnotation(Class<? extends Annotation> annotationType)	Find all names of beans which are annotated with the supplied Annotation type, without creating corresponding bean instances yet.
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.
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(ResolvableType 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.
String[]	getBeanNamesForType(ResolvableType 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.
<T> ObjectProvider<T>	getBeanProvider(Class<T> requiredType)	Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.
<T> ObjectProvider<T>	getBeanProvider(Class<T> requiredType, boolean allowEagerInit)	Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.
<T> ObjectProvider<T>	getBeanProvider(ResolvableType requiredType)	Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.
<T> ObjectProvider<T>	getBeanProvider(ResolvableType requiredType, boolean allowEagerInit)	Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.
<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.
<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.
Map<String,Object>	getBeansWithAnnotation(Class<? extends Annotation> annotationType)	Find all beans which are annotated with the supplied Annotation type, returning a Map of bean names with corresponding bean instances.
String	getDisplayName()	Return a friendly name for this context.
ConfigurableEnvironment	getEnvironment()	Return the Environment for this application context in configurable form, allowing for further customization.
String	getId()	Return the unique id of this application context.
protected BeanFactory	getInternalParentBeanFactory()	Return the internal bean factory of the parent context if it implements ConfigurableApplicationContext; else, return the parent context itself.
protected 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(String code, Object[] args, String defaultMessage, Locale locale)	Try to resolve the message.
String	getMessage(String code, Object[] args, Locale locale)	Try to resolve the message.
String	getMessage(MessageSourceResolvable resolvable, Locale locale)	Try to resolve the message using all the attributes contained within the MessageSourceResolvable argument that was passed in.
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.
protected 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.
Class<?>	getType(String name, boolean allowFactoryBeanInit)	Determine the type of the bean with the given name.
protected void	initApplicationEventMulticaster()	Initialize the ApplicationEventMulticaster.
protected void	initLifecycleProcessor()	Initialize the LifecycleProcessor.
protected void	initMessageSource()	Initialize the MessageSource.
protected void	initPropertySources()	Replace any stub property sources with actual instances.
protected 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 BeanFactory.getBean(java.lang.String) always return independent instances?
boolean	isRunning()	Check whether this component is currently running.
boolean	isSingleton(String name)	Is this bean a shared singleton? That is, will BeanFactory.getBean(java.lang.String) always return the same instance?
boolean	isTypeMatch(String name, Class<?> typeToMatch)	Check whether the bean with the given name matches the specified type.
boolean	isTypeMatch(String name, ResolvableType typeToMatch)	Check whether the bean with the given name matches the specified type.
protected ConfigurableListableBeanFactory	obtainFreshBeanFactory()	Tell the subclass to refresh the internal bean factory.
protected void	onClose()	Template method which can be overridden to add context-specific shutdown work.
protected void	onRefresh()	Template method which can be overridden to add context-specific refresh work.
protected void	postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)	Modify the application context's internal bean factory after its standard initialization.
protected void	prepareBeanFactory(ConfigurableListableBeanFactory beanFactory)	Configure the factory's standard context characteristics, such as the context's ClassLoader and post-processors.
protected 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(Object event)	Publish the given event to all listeners.
protected void	publishEvent(Object event, ResolvableType typeHint)	Publish the given event to all listeners.
void	publishEvent(ApplicationEvent event)	Publish the given event to all listeners.
void	refresh()	Load or refresh the persistent representation of the configuration, which might be from Java-based configuration, an XML file, a properties file, a relational database schema, or some other format.
protected abstract void	refreshBeanFactory()	Subclasses must implement this method to perform the actual configuration load.
protected void	registerBeanPostProcessors(ConfigurableListableBeanFactory beanFactory)	Instantiate and register all BeanPostProcessor beans, respecting explicit order if given.
protected void	registerListeners()	Add beans that implement ApplicationListener as listeners.
void	registerShutdownHook()	Register a shutdown hook named SpringContextShutdownHook with the JVM runtime, closing this context on JVM shutdown unless it has already been closed at that time.
void	removeApplicationListener(ApplicationListener<?> listener)	Remove the given ApplicationListener from this context's set of listeners, assuming it got registered via ConfigurableApplicationContext.addApplicationListener(org.springframework.context.ApplicationListener<?>) before.
protected void	resetCommonCaches()	Reset Spring's common reflection metadata caches, in particular the ReflectionUtils, AnnotationUtils, ResolvableType and CachedIntrospectionResults caches.
void	setApplicationStartup(ApplicationStartup applicationStartup)	Set the ApplicationStartup for this application context.
void	setDisplayName(String displayName)	Set a friendly name for this context.
void	setEnvironment(ConfigurableEnvironment environment)	Set the Environment for this application context.
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, typically in a synchronous fashion, such that the component is fully stopped upon return of this method.
String	toString()	Return information about this context.

Methods inherited from class org.springframework.core.io.DefaultResourceLoader

addProtocolResolver, clearResourceCaches, getClassLoader, getProtocolResolvers, getResource, getResourceByPath, getResourceCache, setClassLoader

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.context.ConfigurableApplicationContext

addProtocolResolver, setClassLoader

Methods inherited from interface org.springframework.core.io.ResourceLoader

getClassLoader, getResource

Field Details

MESSAGE_SOURCE_BEAN_NAME

public static final String MESSAGE_SOURCE_BEAN_NAME

The name of the MessageSource bean in the context. If none is supplied, message resolution is delegated to the parent.

See Also:

• MessageSource
• ResourceBundleMessageSource
• ReloadableResourceBundleMessageSource
• getMessage(MessageSourceResolvable, Locale)
• Constant Field Values

APPLICATION_EVENT_MULTICASTER_BEAN_NAME

public static final String APPLICATION_EVENT_MULTICASTER_BEAN_NAME

The name of the ApplicationEventMulticaster bean in the context. If none is supplied, a SimpleApplicationEventMulticaster is used.

See Also:

• ApplicationEventMulticaster
• SimpleApplicationEventMulticaster
• publishEvent(ApplicationEvent)
• addApplicationListener(ApplicationListener)
• Constant Field Values

LIFECYCLE_PROCESSOR_BEAN_NAME

public static final String LIFECYCLE_PROCESSOR_BEAN_NAME

The name of the LifecycleProcessor bean in the context. If none is supplied, a DefaultLifecycleProcessor is used.

Since:

3.0

See Also:

• LifecycleProcessor
• DefaultLifecycleProcessor
• start()
• stop()
• Constant Field Values

logger

protected final Log logger

Logger used by this class. Available to subclasses.

Constructor Details

AbstractApplicationContext

public AbstractApplicationContext()

Create a new AbstractApplicationContext with no parent.

AbstractApplicationContext

public AbstractApplicationContext(@Nullable
 ApplicationContext parent)

Create a new AbstractApplicationContext with the given parent context.

Parameters:

parent - the parent context

Method Details

setId

public void setId(String id)

Set the unique id of this application context.

Default is the object id of the context instance, or the name of the context bean if the context is itself defined as a bean.

Specified by:

setId in interface ConfigurableApplicationContext

Parameters:

id - the unique id of the context

getId

public String getId()

Description copied from interface: ApplicationContext

Return the unique id of this application context.

Specified by:

getId in interface ApplicationContext

Returns:

the unique id of the context, or null if none

getApplicationName

public String getApplicationName()

Description copied from interface: ApplicationContext

Return a name for the deployed application that this context belongs to.

Specified by:

getApplicationName in interface ApplicationContext

Returns:

a name for the deployed application, or the empty String by default

setDisplayName

public void setDisplayName(String displayName)

Set a friendly name for this context. Typically done during initialization of concrete context implementations.

Default is the object id of the context instance.

getDisplayName

public String getDisplayName()

Return a friendly name for this context.

Specified by:

getDisplayName in interface ApplicationContext

Returns:

a display name for this context (never null)

getParent

@Nullable
public ApplicationContext getParent()

Return the parent context, or null if there is no parent (that is, this context is the root of the context hierarchy).

Specified by:

getParent in interface ApplicationContext

Returns:

the parent context, or null if there is no parent

setEnvironment

public void setEnvironment(ConfigurableEnvironment environment)

Set the Environment for this application context.

Default value is determined by createEnvironment(). Replacing the default with this method is one option but configuration through getEnvironment() should also be considered. In either case, such modifications should be performed before refresh().

Specified by:

setEnvironment in interface ConfigurableApplicationContext

Parameters:

environment - the new environment

See Also:

• createEnvironment()

getEnvironment

public ConfigurableEnvironment getEnvironment()

Return the Environment for this application context in configurable form, allowing for further customization.

If none specified, a default environment will be initialized via createEnvironment().

Specified by:

getEnvironment in interface ConfigurableApplicationContext

Specified by:

getEnvironment in interface EnvironmentCapable

createEnvironment

protected ConfigurableEnvironment createEnvironment()

Create and return a new StandardEnvironment.

Subclasses may override this method in order to supply a custom ConfigurableEnvironment implementation.

getAutowireCapableBeanFactory

public AutowireCapableBeanFactory getAutowireCapableBeanFactory()
                                                         throws IllegalStateException

Return this context's internal bean factory as AutowireCapableBeanFactory, if already available.

Specified by:

getAutowireCapableBeanFactory in interface ApplicationContext

Returns:

the AutowireCapableBeanFactory for this context

Throws:

IllegalStateException - if the context does not support the AutowireCapableBeanFactory interface, or does not hold an autowire-capable bean factory yet (e.g. if refresh() has never been called), or if the context has been closed already

See Also:

• getBeanFactory()

getStartupDate

public long getStartupDate()

Return the timestamp (ms) when this context was first loaded.

Specified by:

getStartupDate in interface ApplicationContext

Returns:

the timestamp (ms) when this context was first loaded

publishEvent

public void publishEvent(ApplicationEvent event)

Publish the given event to all listeners.

Note: Listeners get initialized after the MessageSource, to be able to access it within listener implementations. Thus, MessageSource implementations cannot publish events.

Specified by:

publishEvent in interface ApplicationEventPublisher

Parameters:

event - the event to publish (may be application-specific or a standard framework event)

See Also:

• ApplicationEventPublisher.publishEvent(Object)
• ContextRefreshedEvent
• ContextClosedEvent

publishEvent

public void publishEvent(Object event)

Publish the given event to all listeners.

Note: Listeners get initialized after the MessageSource, to be able to access it within listener implementations. Thus, MessageSource implementations cannot publish events.

Specified by:

publishEvent in interface ApplicationEventPublisher

Parameters:

event - the event to publish (may be an ApplicationEvent or a payload object to be turned into a PayloadApplicationEvent)

See Also:

• ApplicationEventPublisher.publishEvent(ApplicationEvent)
• PayloadApplicationEvent

publishEvent

protected void publishEvent(Object event,
 @Nullable
 ResolvableType typeHint)

Publish the given event to all listeners.

This is the internal delegate that all other publishEvent methods refer to. It is not meant to be called directly but rather serves as a propagation mechanism between application contexts in a hierarchy, potentially overridden in subclasses for a custom propagation arrangement.

Parameters:

event - the event to publish (may be an ApplicationEvent or a payload object to be turned into a PayloadApplicationEvent)

typeHint - the resolved event type, if known. The implementation of this method also tolerates a payload type hint for a payload object to be turned into a PayloadApplicationEvent. However, the recommended way is to construct an actual event object via PayloadApplicationEvent(Object, Object, ResolvableType) instead for such scenarios.

Since:

4.2

See Also:

• ApplicationEventMulticaster.multicastEvent(ApplicationEvent, ResolvableType)

setApplicationStartup

public void setApplicationStartup(ApplicationStartup applicationStartup)

Description copied from interface: ConfigurableApplicationContext

Set the ApplicationStartup for this application context.

This allows the application context to record metrics during startup.

Specified by:

setApplicationStartup in interface ConfigurableApplicationContext

Parameters:

applicationStartup - the new context event factory

getApplicationStartup

public ApplicationStartup getApplicationStartup()

Description copied from interface: ConfigurableApplicationContext

Return the ApplicationStartup for this application context.

Specified by:

getApplicationStartup in interface ConfigurableApplicationContext

getResourcePatternResolver

protected ResourcePatternResolver getResourcePatternResolver()

Return the ResourcePatternResolver to use for resolving location patterns into Resource instances. Default is a PathMatchingResourcePatternResolver, supporting Ant-style location patterns.

Can be overridden in subclasses, for extended resolution strategies, for example in a web environment.

Do not call this when needing to resolve a location pattern. Call the context's getResources method instead, which will delegate to the ResourcePatternResolver.

Returns:

the ResourcePatternResolver for this context

See Also:

• getResources(java.lang.String)
• PathMatchingResourcePatternResolver

setParent

public void setParent(@Nullable
 ApplicationContext parent)

Set the parent of this application context.

The parent environment is merged with this (child) application context environment if the parent is non-null and its environment is an instance of ConfigurableEnvironment.

Specified by:

setParent in interface ConfigurableApplicationContext

Parameters:

parent - the parent context

See Also:

• ConfigurableEnvironment.merge(ConfigurableEnvironment)

addBeanFactoryPostProcessor

public void addBeanFactoryPostProcessor(BeanFactoryPostProcessor postProcessor)

Description copied from interface: