public abstract class AbstractRefreshableApplicationContext extends AbstractApplicationContext
ApplicationContext
implementations which are supposed to support multiple calls to AbstractApplicationContext.refresh()
,
creating a new internal bean factory instance every time.
Typically (but not necessarily), such a context will be driven by
a set of config locations to load bean definitions from.
The only method to be implemented by subclasses is loadBeanDefinitions(org.springframework.beans.factory.support.DefaultListableBeanFactory)
,
which gets invoked on each refresh. A concrete implementation is supposed to load
bean definitions into the given
DefaultListableBeanFactory
,
typically delegating to one or more specific bean definition readers.
Note that there is a similar base class for WebApplicationContexts.
AbstractRefreshableWebApplicationContext
provides the same subclassing strategy, but additionally pre-implements
all context functionality for web environments. There is also a
pre-defined way to receive config locations for a web context.
Concrete standalone subclasses of this base class, reading in a
specific bean definition format, are ClassPathXmlApplicationContext
and FileSystemXmlApplicationContext
, which both derive from the
common AbstractXmlApplicationContext
base class;
AnnotationConfigApplicationContext
supports @Configuration
-annotated classes as a source of bean definitions.
loadBeanDefinitions(org.springframework.beans.factory.support.DefaultListableBeanFactory)
,
DefaultListableBeanFactory
,
AbstractRefreshableWebApplicationContext
,
AbstractXmlApplicationContext
,
ClassPathXmlApplicationContext
,
FileSystemXmlApplicationContext
,
AnnotationConfigApplicationContext
DefaultResourceLoader.ClassPathContextResource
APPLICATION_EVENT_MULTICASTER_BEAN_NAME, LIFECYCLE_PROCESSOR_BEAN_NAME, logger, MESSAGE_SOURCE_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 |
---|
AbstractRefreshableApplicationContext()
Create a new AbstractRefreshableApplicationContext with no parent.
|
AbstractRefreshableApplicationContext(ApplicationContext parent)
Create a new AbstractRefreshableApplicationContext with the given parent context.
|
Modifier and Type | Method and Description |
---|---|
protected void |
assertBeanFactoryActive()
Overridden to turn it into a no-op: With AbstractRefreshableApplicationContext,
getBeanFactory() serves a strong assertion for an active context anyway. |
protected void |
cancelRefresh(BeansException ex)
Cancel this context's refresh attempt, resetting the
active flag
after an exception got thrown. |
protected void |
closeBeanFactory()
Subclasses must implement this method to release their internal bean factory.
|
protected DefaultListableBeanFactory |
createBeanFactory()
Create an internal bean factory for this context.
|
protected void |
customizeBeanFactory(DefaultListableBeanFactory beanFactory)
Customize the internal bean factory used by this context.
|
ConfigurableListableBeanFactory |
getBeanFactory()
Subclasses must return their internal bean factory here.
|
protected boolean |
hasBeanFactory()
Determine whether this context currently holds a bean factory,
i.e.
|
protected abstract void |
loadBeanDefinitions(DefaultListableBeanFactory beanFactory)
Load bean definitions into the given bean factory, typically through
delegating to one or more bean definition readers.
|
protected void |
refreshBeanFactory()
This implementation performs an actual refresh of this context's underlying
bean factory, shutting down the previous bean factory (if any) and
initializing a fresh bean factory for the next phase of the context's lifecycle.
|
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.
|
addApplicationListener, addBeanFactoryPostProcessor, close, containsBean, containsBeanDefinition, containsLocalBean, createEnvironment, destroy, destroyBeans, doClose, findAnnotationOnBean, finishBeanFactoryInitialization, finishRefresh, getAliases, getApplicationListeners, getApplicationName, getAutowireCapableBeanFactory, getBean, getBean, getBean, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanFactoryPostProcessors, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType, getBeansWithAnnotation, getDisplayName, getEnvironment, getId, getInternalParentBeanFactory, getInternalParentMessageSource, getMessage, getMessage, getMessage, getParent, getParentBeanFactory, getResourcePatternResolver, getResources, getStartupDate, getType, initApplicationEventMulticaster, initLifecycleProcessor, initMessageSource, initPropertySources, invokeBeanFactoryPostProcessors, isActive, isPrototype, isRunning, isSingleton, isTypeMatch, isTypeMatch, obtainFreshBeanFactory, onClose, onRefresh, postProcessBeanFactory, prepareBeanFactory, prepareRefresh, publishEvent, publishEvent, publishEvent, refresh, registerBeanPostProcessors, registerListeners, registerShutdownHook, resetCommonCaches, setDisplayName, setEnvironment, setId, setParent, start, stop, toString
addProtocolResolver, getClassLoader, getProtocolResolvers, getResource, getResourceByPath, setClassLoader
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addProtocolResolver
getClassLoader, getResource
public AbstractRefreshableApplicationContext()
public AbstractRefreshableApplicationContext(ApplicationContext parent)
parent
- the parent contextpublic void setAllowBeanDefinitionOverriding(boolean allowBeanDefinitionOverriding)
public void setAllowCircularReferences(boolean allowCircularReferences)
Default is "true". Turn this off to throw an exception when encountering a circular reference, disallowing them completely.
protected final void refreshBeanFactory() throws BeansException
refreshBeanFactory
in class AbstractApplicationContext
BeansException
- if initialization of the bean factory failedprotected void cancelRefresh(BeansException ex)
AbstractApplicationContext
active
flag
after an exception got thrown.cancelRefresh
in class AbstractApplicationContext
ex
- the exception that led to the cancellationprotected final void closeBeanFactory()
AbstractApplicationContext
AbstractApplicationContext.close()
after all other shutdown work.
Should never throw an exception but rather log shutdown failures.
closeBeanFactory
in class AbstractApplicationContext
protected final boolean hasBeanFactory()
public final ConfigurableListableBeanFactory getBeanFactory()
AbstractApplicationContext
Note: Subclasses should check whether the context is still active before returning the internal bean factory. The internal factory should generally be considered unavailable once the context has been closed.
getBeanFactory
in interface ConfigurableApplicationContext
getBeanFactory
in class AbstractApplicationContext
null
)AbstractApplicationContext.refreshBeanFactory()
,
AbstractApplicationContext.closeBeanFactory()
protected void assertBeanFactoryActive()
getBeanFactory()
serves a strong assertion for an active context anyway.assertBeanFactoryActive
in class AbstractApplicationContext
protected DefaultListableBeanFactory createBeanFactory()
AbstractApplicationContext.refresh()
attempt.
The default implementation creates a
DefaultListableBeanFactory
with the internal bean factory of this
context's parent as parent bean factory. Can be overridden in subclasses,
for example to customize DefaultListableBeanFactory's settings.
DefaultListableBeanFactory.setAllowBeanDefinitionOverriding(boolean)
,
DefaultListableBeanFactory.setAllowEagerClassLoading(boolean)
,
AbstractAutowireCapableBeanFactory.setAllowCircularReferences(boolean)
,
AbstractAutowireCapableBeanFactory.setAllowRawInjectionDespiteWrapping(boolean)
protected void customizeBeanFactory(DefaultListableBeanFactory beanFactory)
AbstractApplicationContext.refresh()
attempt.
The default implementation applies this context's
"allowBeanDefinitionOverriding"
and "allowCircularReferences" settings,
if specified. Can be overridden in subclasses to customize any of
DefaultListableBeanFactory
's settings.
beanFactory
- the newly created bean factory for this contextDefaultListableBeanFactory.setAllowBeanDefinitionOverriding(boolean)
,
AbstractAutowireCapableBeanFactory.setAllowCircularReferences(boolean)
,
AbstractAutowireCapableBeanFactory.setAllowRawInjectionDespiteWrapping(boolean)
,
DefaultListableBeanFactory.setAllowEagerClassLoading(boolean)
protected abstract void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws BeansException, IOException
beanFactory
- the bean factory to load bean definitions intoBeansException
- if parsing of the bean definitions failedIOException
- if loading of bean definition files failedPropertiesBeanDefinitionReader
,
XmlBeanDefinitionReader