|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConfigurableApplicationContext
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.
Field Summary |
---|
Fields inherited from interface org.springframework.beans.factory.BeanFactory |
---|
FACTORY_BEAN_PREFIX |
Fields inherited from interface org.springframework.beans.factory.BeanFactory |
---|
FACTORY_BEAN_PREFIX |
Fields inherited from interface org.springframework.core.io.support.ResourcePatternResolver |
---|
CLASSPATH_ALL_URL_PREFIX |
Fields inherited from interface org.springframework.core.io.ResourceLoader |
---|
CLASSPATH_URL_PREFIX |
Method Summary | |
---|---|
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 |
close()
Close this application context, releasing all resources and locks that the implementation might hold. |
ConfigurableListableBeanFactory |
getBeanFactory()
Return the internal bean factory of this application context. |
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. |
void |
refresh()
Load or refresh the persistent representation of the configuration, which might an XML file, properties file, or relational database schema. |
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 |
setParent(ApplicationContext parent)
Set the parent of this application context. |
Methods inherited from interface org.springframework.context.ApplicationContext |
---|
getAutowireCapableBeanFactory, getDisplayName, getParent, getStartupDate |
Methods inherited from interface org.springframework.beans.factory.ListableBeanFactory |
---|
containsBeanDefinition, getBeanDefinitionCount, getBeanDefinitionNames, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType |
Methods inherited from interface org.springframework.beans.factory.BeanFactory |
---|
containsBean, getAliases, getBean, getBean, getType, isPrototype, isSingleton, isTypeMatch |
Methods inherited from interface org.springframework.beans.factory.HierarchicalBeanFactory |
---|
containsLocalBean, getParentBeanFactory |
Methods inherited from interface org.springframework.beans.factory.BeanFactory |
---|
containsBean, getAliases, getBean, getBean, getType, isPrototype, isSingleton, isTypeMatch |
Methods inherited from interface org.springframework.context.MessageSource |
---|
getMessage, getMessage, getMessage |
Methods inherited from interface org.springframework.context.ApplicationEventPublisher |
---|
publishEvent |
Methods inherited from interface org.springframework.core.io.support.ResourcePatternResolver |
---|
getResources |
Methods inherited from interface org.springframework.core.io.ResourceLoader |
---|
getClassLoader, getResource |
Methods inherited from interface org.springframework.context.Lifecycle |
---|
isRunning, start, stop |
Method Detail |
---|
void setParent(ApplicationContext parent)
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.
parent
- the parent contextConfigurableWebApplicationContext
void addBeanFactoryPostProcessor(BeanFactoryPostProcessor beanFactoryPostProcessor)
beanFactoryPostProcessor
- the factory processor to registervoid addApplicationListener(ApplicationListener listener)
Note that any ApplicationListener registered here will be applied on refresh of this context. If a listener is added after the initial refresh, it will be applied on next refresh of the context.
listener
- the ApplicationListener to registerContextRefreshedEvent
,
ContextClosedEvent
void refresh() throws BeansException, IllegalStateException
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 that method, either all or no singletons at all should be instantiated.
BeansException
- if the bean factory could not be initialized
IllegalStateException
- if already initialized and multiple refresh
attempts are not supportedvoid registerShutdownHook()
This method can be called multiple times. Only one shutdown hook (at max) will be registered for each context instance.
void close()
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.
boolean isActive()
refresh()
,
close()
,
getBeanFactory()
ConfigurableListableBeanFactory getBeanFactory() throws IllegalStateException
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, inbetween refresh()
and close()
.
The isActive()
flag can be used to check whether the context
is in an appropriate state.
IllegalStateException
- if the context does not hold an internal
bean factory (usually if refresh()
hasn't been called yet or
if close()
has already been called)isActive()
,
refresh()
,
close()
,
addBeanFactoryPostProcessor(org.springframework.beans.factory.config.BeanFactoryPostProcessor)
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |