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

public interface ConfigurableApplicationContext
extends ApplicationContext, Lifecycle, Closeable

SPI interface to be implemented by most if not all application contexts. Provides facilities to configure an application context in addition to the application context client methods in the 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

Fields

Modifier and Type	Field	Description
static final String	APPLICATION_STARTUP_BEAN_NAME	Name of the ApplicationStartup bean in the factory: "applicationStartup".
static final String	BOOTSTRAP_EXECUTOR_BEAN_NAME	The name of the bootstrap executor bean in the context: "bootstrapExecutor".
static final String	CONFIG_LOCATION_DELIMITERS	Any number of these characters are considered delimiters between multiple context config paths in a single String value: ",; \t\n".
static final String	CONVERSION_SERVICE_BEAN_NAME	Name of the ConversionService bean in the factory: "conversionService".
static final String	ENVIRONMENT_BEAN_NAME	Name of the Environment bean in the factory: "environment".
static final String	LOAD_TIME_WEAVER_BEAN_NAME	Name of the LoadTimeWeaver bean in the factory: "loadTimeWeaver".
static final String	SHUTDOWN_HOOK_THREAD_NAME	Name of the shutdown hook thread: "SpringContextShutdownHook".
static final String	SYSTEM_ENVIRONMENT_BEAN_NAME	Name of the Operating System environment bean in the factory: "systemEnvironment".
static final String	SYSTEM_PROPERTIES_BEAN_NAME	Name of the JVM System properties bean in the factory: "systemProperties".

Fields inherited from interface BeanFactory

FACTORY_BEAN_PREFIX, FACTORY_BEAN_PREFIX_CHAR

Fields inherited from interface ResourceLoader

CLASSPATH_URL_PREFIX

Fields inherited from interface ResourcePatternResolver

CLASSPATH_ALL_URL_PREFIX

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.
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.
ApplicationStartup	getApplicationStartup()	Return the ApplicationStartup for this application context.
ConfigurableListableBeanFactory	getBeanFactory()	Return the internal bean factory of this application context.
ConfigurableEnvironment	getEnvironment()	Return the Environment 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, whether close() has been called on an active context in order to initiate its shutdown.
void	pause()	Stop all beans in this application context unless they explicitly opt out of pausing through SmartLifecycle.isPauseable() returning false.
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	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	removeApplicationListener(ApplicationListener<?> listener)	Remove the given ApplicationListener from this context's set of listeners, assuming it got registered via addApplicationListener(ApplicationListener) before.
void	restart()	Pause all beans in this application context if necessary, and subsequently restart all auto-startup beans, effectively restoring the lifecycle state after refresh() (typically after a preceding pause() call when a full Lifecycle.start() of even lazy-starting beans is to be avoided).
void	setApplicationStartup(ApplicationStartup applicationStartup)	Set the ApplicationStartup 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 the Environment for this application context.
void	setId(String id)	Set the unique ID of this application context.
void	setParent(@Nullable ApplicationContext parent)	Set the parent of this application context.

Methods inherited from interface ApplicationContext

getApplicationName, getAutowireCapableBeanFactory, getDisplayName, getId, getParent, getStartupDate

Methods inherited from interface ApplicationEventPublisher

publishEvent, publishEvent

Methods inherited from interface BeanFactory

containsBean, getAliases, getBean, getBean, getBean, getBean, getBean, getBeanProvider, getBeanProvider, getBeanProvider, getType, getType, isPrototype, isSingleton, isTypeMatch, isTypeMatch

Methods inherited from interface HierarchicalBeanFactory

containsLocalBean, getParentBeanFactory

Methods inherited from interface Lifecycle

isRunning, start, stop

Methods inherited from interface ListableBeanFactory

containsBeanDefinition, findAllAnnotationsOnBean, findAnnotationOnBean, findAnnotationOnBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanProvider, getBeanProvider, getBeansOfType, getBeansOfType, getBeansWithAnnotation

Methods inherited from interface MessageSource

getMessage, getMessage, getMessage

Methods inherited from interface