Save This Page
Home » spring-framework-2.5.5-with-dependencies » org.springframework » context » [javadoc | source]
org.springframework.context
public interface: ConfigurableApplicationContext [javadoc | source]

All Implemented Interfaces:
    ApplicationContext, Lifecycle

All Known Implementing Classes:
    XmlWebApplicationContext, StaticApplicationContext, ClassPathXmlApplicationContext, GenericApplicationContext, AbstractXmlApplicationContext, GenericWebApplicationContext, ResourceAdapterApplicationContext, AbstractRefreshableWebApplicationContext, FileSystemXmlApplicationContext, AbstractRefreshableConfigApplicationContext, ConfigurableWebApplicationContext, StaticPortletApplicationContext, StaticWebApplicationContext, AbstractApplicationContext, AbstractRefreshableApplicationContext, AbstractRefreshablePortletApplicationContext, XmlPortletApplicationContext, ConfigurablePortletApplicationContext

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 org.springframework.context.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
 String CONFIG_LOCATION_DELIMITERS    Any number of these characters are considered delimiters between multiple context config paths in a single String value.
    Also see:
    org.springframework.context.support.AbstractXmlApplicationContext#setConfigLocation
    org.springframework.web.context.ContextLoader#CONFIG_LOCATION_PARAM
    org.springframework.web.servlet.FrameworkServlet#setContextConfigLocation
 
 String 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. 
Method from org.springframework.context.ConfigurableApplicationContext Summary:
addApplicationListener,   addBeanFactoryPostProcessor,   close,   getBeanFactory,   isActive,   refresh,   registerShutdownHook,   setParent
Method from org.springframework.context.ConfigurableApplicationContext Detail:
 public  void addApplicationListener(ApplicationListener listener)
    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 of this context. If a listener is added after the initial
refresh, it will be applied on next refresh of the context.
 public  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. To be invoked during context configuration.
 public  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.
 public ConfigurableListableBeanFactory getBeanFactory() throws IllegalStateException
    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, inbetween #refresh()  and #close() .
The #isActive()  flag can be used to check whether the context
is in an appropriate state.
 public 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.
 public  void refresh() throws IllegalStateException, BeansException
    Load or refresh the persistent representation of the configuration,
which might an XML file, properties file, or relational database schema.

    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.
 public  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.
 public  void setParent(ApplicationContext parent)
    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.