Interface ConfigurableApplicationContext
- All Superinterfaces:
ApplicationContext
,ApplicationEventPublisher
,AutoCloseable
,BeanFactory
,Closeable
,EnvironmentCapable
,HierarchicalBeanFactory
,Lifecycle
,ListableBeanFactory
,MessageSource
,ResourceLoader
,ResourcePatternResolver
- All Known Subinterfaces:
ConfigurableWebApplicationContext
- All Known Implementing Classes:
AbstractApplicationContext
,AbstractRefreshableApplicationContext
,AbstractRefreshableConfigApplicationContext
,AbstractRefreshableWebApplicationContext
,AbstractXmlApplicationContext
,AnnotationConfigApplicationContext
,AnnotationConfigWebApplicationContext
,ClassPathXmlApplicationContext
,FileSystemXmlApplicationContext
,GenericApplicationContext
,GenericGroovyApplicationContext
,GenericWebApplicationContext
,GenericXmlApplicationContext
,GroovyWebApplicationContext
,StaticApplicationContext
,StaticWebApplicationContext
,XmlWebApplicationContext
ApplicationContext
interface.
Configuration and lifecycle methods are encapsulated here to avoid making them obvious to ApplicationContext client code. The present methods should only be used by startup and shutdown code.
- Since:
- 03.11.2003
- Author:
- Juergen Hoeller, Chris Beams, Sam Brannen
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Name of theApplicationStartup
bean in the factory.static final String
The name of thebootstrap executor
bean in the context.static final String
Any number of these characters are considered delimiters between multiple context config paths in a single String value.static final String
Name of the ConversionService bean in the factory.static final String
Name of theEnvironment
bean in the factory.static final String
Name of the LoadTimeWeaver bean in the factory.static final String
Name
of the shutdown hook thread: "SpringContextShutdownHook".static final String
Name of the System environment bean in the factory.static final String
Name of the System properties bean in the factory.Fields inherited from interface org.springframework.beans.factory.BeanFactory
FACTORY_BEAN_PREFIX
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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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.void
addProtocolResolver
(ProtocolResolver resolver) Register the given protocol resolver with this application context, allowing for additional resource protocols to be handled.void
close()
Close this application context, releasing all resources and locks that the implementation might hold.Return theApplicationStartup
for this application context.Return the internal bean factory of this application context.Return theEnvironment
for this application context in configurable form, allowing for further customization.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
isClosed()
Return whether this context has been closed already, that is, whetherclose()
has been called on an active context in order to initiate its shutdown.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.void
Register a shutdown hook 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 viaaddApplicationListener(org.springframework.context.ApplicationListener<?>)
before.void
setApplicationStartup
(ApplicationStartup applicationStartup) Set theApplicationStartup
for this application context.void
setClassLoader
(ClassLoader classLoader) Specify the ClassLoader to load class path resources and bean classes with.void
setEnvironment
(ConfigurableEnvironment environment) Set theEnvironment
for this application context.void
Set the unique id of this application context.void
setParent
(ApplicationContext parent) Set the parent of this application context.Methods inherited from interface org.springframework.context.ApplicationContext
getApplicationName, getAutowireCapableBeanFactory, getDisplayName, getId, getParent, getStartupDate
Methods inherited from interface org.springframework.context.ApplicationEventPublisher
publishEvent, publishEvent
Methods inherited from interface org.springframework.beans.factory.BeanFactory
containsBean, getAliases, getBean, getBean, getBean, getBean, getBean, getBeanProvider, getBeanProvider, getType, getType, isPrototype, isSingleton, isTypeMatch, isTypeMatch
Methods inherited from interface org.springframework.beans.factory.HierarchicalBeanFactory
containsLocalBean, getParentBeanFactory
Methods inherited from interface org.springframework.beans.factory.ListableBeanFactory
containsBeanDefinition, findAllAnnotationsOnBean, findAnnotationOnBean, findAnnotationOnBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanProvider, getBeanProvider, getBeansOfType, getBeansOfType, getBeansWithAnnotation
Methods inherited from interface org.springframework.context.MessageSource
getMessage, getMessage, getMessage
Methods inherited from interface org.springframework.core.io.ResourceLoader
getClassLoader, getResource
Methods inherited from interface org.springframework.core.io.support.ResourcePatternResolver
getResources
-
Field Details
-
CONFIG_LOCATION_DELIMITERS
Any number of these characters are considered delimiters between multiple context config paths in a single String value. -
BOOTSTRAP_EXECUTOR_BEAN_NAME
The name of thebootstrap executor
bean in the context. If none is supplied, no background bootstrapping will be active. -
CONVERSION_SERVICE_BEAN_NAME
Name of the ConversionService bean in the factory. If none is supplied, default conversion rules apply.- Since:
- 3.0
- See Also:
-
LOAD_TIME_WEAVER_BEAN_NAME
Name of the LoadTimeWeaver bean in the factory. If such a bean is supplied, the context will use a temporary ClassLoader for type matching, in order to allow the LoadTimeWeaver to process all actual bean classes.- Since:
- 2.5
- See Also:
-
ENVIRONMENT_BEAN_NAME
Name of theEnvironment
bean in the factory.- Since:
- 3.1
- See Also:
-
SYSTEM_PROPERTIES_BEAN_NAME
Name of the System properties bean in the factory.- See Also:
-
SYSTEM_ENVIRONMENT_BEAN_NAME
Name of the System environment bean in the factory.- See Also:
-
APPLICATION_STARTUP_BEAN_NAME
Name of theApplicationStartup
bean in the factory.- Since:
- 5.3
- See Also:
-
SHUTDOWN_HOOK_THREAD_NAME
Name
of the shutdown hook thread: "SpringContextShutdownHook".- Since:
- 5.2
- See Also:
-
-
Method Details
-
setId
Set the unique id of this application context.- Since:
- 3.0
-
setParent
Set the parent of this application context.Note that the parent shouldn't be changed: It should only be set outside a constructor if it isn't available when an object of this class is created, for example in case of WebApplicationContext setup.
- Parameters:
parent
- the parent context- See Also:
-
setEnvironment
Set theEnvironment
for this application context.- Parameters:
environment
- the new environment- Since:
- 3.1
-
getEnvironment
ConfigurableEnvironment getEnvironment()Return theEnvironment
for this application context in configurable form, allowing for further customization.- Specified by:
getEnvironment
in interfaceEnvironmentCapable
- Since:
- 3.1
-
setApplicationStartup
Set theApplicationStartup
for this application context.This allows the application context to record metrics during startup.
- Parameters:
applicationStartup
- the new context event factory- Since:
- 5.3
-
getApplicationStartup
ApplicationStartup getApplicationStartup()Return theApplicationStartup
for this application context.- Since:
- 5.3
-
addBeanFactoryPostProcessor
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. To be invoked during context configuration.- Parameters:
postProcessor
- the factory processor to register
-
addApplicationListener
Add a new ApplicationListener that will be notified on context events such as context refresh and context shutdown.Note that any ApplicationListener registered here will be applied on refresh if the context is not active yet, or on the fly with the current event multicaster in case of a context that is already active.
- Parameters:
listener
- the ApplicationListener to register- See Also:
-
removeApplicationListener
Remove the given ApplicationListener from this context's set of listeners, assuming it got registered viaaddApplicationListener(org.springframework.context.ApplicationListener<?>)
before.- Parameters:
listener
- the ApplicationListener to deregister- Since:
- 6.0
-
setClassLoader
Specify the ClassLoader to load class path resources and bean classes with.This context class loader will be passed to the internal bean factory.
-
addProtocolResolver
Register the given protocol resolver with this application context, allowing for additional resource protocols to be handled.Any such resolver will be invoked ahead of this context's standard resolution rules. It may therefore also override any default rules.
- Since:
- 4.3
-
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.As this is a startup method, it should destroy already created singletons if it fails, to avoid dangling resources. In other words, after invocation of this method, either all or no singletons at all should be instantiated.
- Throws:
BeansException
- if the bean factory could not be initializedIllegalStateException
- if already initialized and multiple refresh attempts are not supported
-
registerShutdownHook
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.This method can be called multiple times. Only one shutdown hook (at max) will be registered for each context instance.
The name of the shutdown hook thread should be
SHUTDOWN_HOOK_THREAD_NAME
. -
close
void close()Close this application context, releasing all resources and locks that the implementation might hold. This includes destroying all cached singleton beans.Note: Does not invoke
close
on a parent context; parent contexts have their own, independent lifecycle.This method can be called multiple times without side effects: Subsequent
close
calls on an already closed context will be ignored.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
-
isClosed
boolean isClosed()Return whether this context has been closed already, that is, whetherclose()
has been called on an active context in order to initiate its shutdown.Note: This does not indicate whether context shutdown has completed. Use
isActive()
for differentiating between those scenarios: a context becomes inactive once it has been fully shut down and the originalclose()
call has returned.- Since:
- 6.2
-
isActive
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.- Returns:
- whether the context is still active
- See Also:
-
getBeanFactory
Return the internal bean factory of this application context. Can be used to access specific functionality of the underlying factory.Note: Do not use this to post-process the bean factory; singletons will already have been instantiated before. Use a BeanFactoryPostProcessor to intercept the BeanFactory setup process before beans get touched.
Generally, this internal factory will only be accessible while the context is active, that is, in-between
refresh()
andclose()
. TheisActive()
flag can be used to check whether the context is in an appropriate state.- Returns:
- the underlying bean factory
- Throws:
IllegalStateException
- if the context does not hold an internal bean factory (usually ifrefresh()
hasn't been called yet or ifclose()
has already been called)- See Also:
-