public class

ClassPathXmlApplicationContext

extends AbstractXmlApplicationContext

java.lang.Object
↳	org.springframework.core.io.DefaultResourceLoader
	↳	org.springframework.context.support.AbstractApplicationContext
		↳	org.springframework.context.support.AbstractRefreshableApplicationContext
			↳	org.springframework.context.support.AbstractRefreshableConfigApplicationContext
				↳	org.springframework.context.support.AbstractXmlApplicationContext
					↳	org.springframework.context.support.ClassPathXmlApplicationContext

Class Overview

Standalone XML application context, taking the context definition files from the class path, interpreting plain paths as class path resource names that include the package path (e.g. "mypackage/myresource.txt"). Useful for test harnesses as well as for application contexts embedded within JARs.

The config location defaults can be overridden via getConfigLocations(), Config locations can either denote concrete files like "/myfiles/context.xml" or Ant-style patterns like "/myfiles/*-context.xml" (see the AntPathMatcher javadoc for pattern details).

Note: In case of multiple config locations, later bean definitions will override ones defined in earlier loaded files. This can be leveraged to deliberately override certain bean definitions via an extra XML file.

This is a simple, one-stop shop convenience ApplicationContext. Consider using the GenericApplicationContext class in combination with an XmlBeanDefinitionReader for more flexible context setup.

Summary

[Expand]

Inherited Constants

From class org.springframework.context.support.AbstractApplicationContext

From interface org.springframework.beans.factory.BeanFactory

From interface org.springframework.context.ConfigurableApplicationContext

From interface org.springframework.core.io.ResourceLoader

From interface org.springframework.core.io.support.ResourcePatternResolver

[Expand]

Inherited Fields

From class org.springframework.context.support.AbstractApplicationContext

Public Constructors
	ClassPathXmlApplicationContext() Create a new ClassPathXmlApplicationContext for bean-style configuration.
	ClassPathXmlApplicationContext(ApplicationContext parent) Create a new ClassPathXmlApplicationContext for bean-style configuration.
	ClassPathXmlApplicationContext(String configLocation) Create a new ClassPathXmlApplicationContext, loading the definitions from the given XML file and automatically refreshing the context.
	ClassPathXmlApplicationContext(String... configLocations) Create a new ClassPathXmlApplicationContext, loading the definitions from the given XML files and automatically refreshing the context.
	ClassPathXmlApplicationContext(String[] configLocations, ApplicationContext parent) Create a new ClassPathXmlApplicationContext with the given parent, loading the definitions from the given XML files and automatically refreshing the context.
	ClassPathXmlApplicationContext(String[] configLocations, boolean refresh) Create a new ClassPathXmlApplicationContext, loading the definitions from the given XML files.
	ClassPathXmlApplicationContext(String[] configLocations, boolean refresh, ApplicationContext parent) Create a new ClassPathXmlApplicationContext with the given parent, loading the definitions from the given XML files.
	ClassPathXmlApplicationContext(String path, Class clazz) Create a new ClassPathXmlApplicationContext, loading the definitions from the given XML file and automatically refreshing the context.
	ClassPathXmlApplicationContext(String[] paths, Class clazz) Create a new ClassPathXmlApplicationContext, loading the definitions from the given XML files and automatically refreshing the context.
	ClassPathXmlApplicationContext(String[] paths, Class clazz, ApplicationContext parent) Create a new ClassPathXmlApplicationContext with the given parent, loading the definitions from the given XML files and automatically refreshing the context.

Protected Methods
Resource[]	getConfigResources() Return an array of Resource objects, referring to the XML bean definition files that this context should be built with.

[Expand]

Inherited Methods

From class org.springframework.context.support.AbstractXmlApplicationContext

From class org.springframework.context.support.AbstractRefreshableConfigApplicationContext

void	afterPropertiesSet() Triggers `refresh()` if not refreshed in the concrete context's constructor already.
String[]	getConfigLocations() Return an array of resource locations, referring to the XML bean definition files that this context should be built with.
String[]	getDefaultConfigLocations() Return the default config locations to use, for the case where no explicit config locations have been specified.
String	resolvePath(String path) Resolve the given path, replacing placeholders with corresponding system property values if necessary.
void	setBeanName(String name) Sets the id of this context to the bean name by default, for cases where the context instance is itself defined as a bean.
void	setConfigLocation(String location) Set the config locations for this application context in init-param style, i.e.
void	setConfigLocations(String[] locations) Set the config locations for this application context.
void	setId(String id) Set the unique id of this application context.

From class org.springframework.context.support.AbstractRefreshableApplicationContext

void	cancelRefresh(BeansException ex) Cancel this context's refresh attempt, resetting the `active` flag after an exception got thrown.
final void	closeBeanFactory() Subclasses must implement this method to release their internal bean factory.
DefaultListableBeanFactory	createBeanFactory() Create an internal bean factory for this context.
void	customizeBeanFactory(DefaultListableBeanFactory beanFactory) Customize the internal bean factory used by this context.
final ConfigurableListableBeanFactory	getBeanFactory() Subclasses must return their internal bean factory here.
final boolean	hasBeanFactory() Determine whether this context currently holds a bean factory, i.e.
abstract void	loadBeanDefinitions(DefaultListableBeanFactory beanFactory) Load bean definitions into the given bean factory, typically through delegating to one or more bean definition readers.
final 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.

From class org.springframework.context.support.AbstractApplicationContext

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	addListener(ApplicationListener<?> listener) This method is deprecated. as of Spring 3.0, in favor of `addApplicationListener(ApplicationListener)`
void	cancelRefresh(BeansException ex) Cancel this context's refresh attempt, resetting the `active` flag after an exception got thrown.
void	close() Close this application context, destroying all beans in its bean factory.
abstract void	closeBeanFactory() Subclasses must implement this method to release their internal bean factory.
boolean	containsBean(String name) Does this bean factory contain a bean with the given name? More specifically, is `getBean(Class)` able to obtain a bean instance for the given name? Translates aliases back to the corresponding canonical bean name.
boolean	containsBeanDefinition(String beanName) Check if this bean factory contains a bean definition with the given name.
boolean	containsLocalBean(String name) Return whether the local bean factory contains a bean of the given name, ignoring beans defined in ancestor contexts.
ConfigurableEnvironment	createEnvironment() Create and return a new `DefaultEnvironment`.
void	destroy() DisposableBean callback for destruction of this instance.
void	destroyBeans() Template method for destroying all beans that this context manages.
void	doClose() Actually performs context closing: publishes a ContextClosedEvent and destroys the singletons in the bean factory of this application context.
<A extends Annotation> A	findAnnotationOnBean(String beanName, Class<A> annotationType) Find a `Annotation` of `annotationType` on the specified bean, traversing its interfaces and super classes if no annotation can be found on the given class itself.
void	finishBeanFactoryInitialization(ConfigurableListableBeanFactory beanFactory) Finish the initialization of this context's bean factory, initializing all remaining singleton beans.
void	finishRefresh() Finish the refresh of this context, invoking the LifecycleProcessor's onRefresh() method and publishing the `ContextRefreshedEvent`.
String[]	getAliases(String name) Return the aliases for the given bean name, if any.
Collection<ApplicationListener<?>>	getApplicationListeners() Return the list of statically specified ApplicationListeners.
AutowireCapableBeanFactory	getAutowireCapableBeanFactory() Return this context's internal bean factory as AutowireCapableBeanFactory, if already available.
<T> T	getBean(Class<T> requiredType) Return the bean instance that uniquely matches the given object type, if any.
Object	getBean(String name, Object... args) Return an instance, which may be shared or independent, of the specified bean.
<T> T	getBean(String name, Class<T> requiredType) Return an instance, which may be shared or independent, of the specified bean.
Object	getBean(String name) Return an instance, which may be shared or independent, of the specified bean.
int	getBeanDefinitionCount() Return the number of beans defined in the factory.
String[]	getBeanDefinitionNames() Return the names of all beans defined in this factory.
abstract ConfigurableListableBeanFactory	getBeanFactory() Subclasses must return their internal bean factory here.
List<BeanFactoryPostProcessor>	getBeanFactoryPostProcessors() Return the list of BeanFactoryPostProcessors that will get applied to the internal BeanFactory.
String[]	getBeanNamesForType(Class<?> type, boolean includeNonSingletons, boolean allowEagerInit) Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
String[]	getBeanNamesForType(Class<?> type) Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
<T> Map<String, T>	getBeansOfType(Class<T> type, boolean includeNonSingletons, boolean allowEagerInit) Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
<T> Map<String, T>	getBeansOfType(Class<T> type) Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
Map<String, Object>	getBeansWithAnnotation(Class<? extends Annotation> annotationType) Find all beans whose `Class` has the supplied `Annotation` type.
String	getDisplayName() Return a friendly name for this context.
ConfigurableEnvironment	getEnvironment() Return the Environment for this application context in configurable form.
String	getId() Return the unique id of this application context.
BeanFactory	getInternalParentBeanFactory() Return the internal bean factory of the parent context if it implements ConfigurableApplicationContext; else, return the parent context itself.
MessageSource	getInternalParentMessageSource() Return the internal message source of the parent context if it is an AbstractApplicationContext too; else, return the parent context itself.
String	getMessage(MessageSourceResolvable resolvable, Locale locale) Try to resolve the message using all the attributes contained within the `MessageSourceResolvable` argument that was passed in.
String	getMessage(String code, Object[] args, Locale locale) Try to resolve the message.
String	getMessage(String code, Object[] args, String defaultMessage, Locale locale) Try to resolve the message.
ApplicationContext	getParent() Return the parent context, or `null` if there is no parent (that is, this context is the root of the context hierarchy).
BeanFactory	getParentBeanFactory() Return the parent bean factory, or `null` if there is none.
ResourcePatternResolver	getResourcePatternResolver() Return the ResourcePatternResolver to use for resolving location patterns into Resource instances.
Resource[]	getResources(String locationPattern) Resolve the given location pattern into Resource objects.
long	getStartupDate() Return the timestamp (ms) when this context was first loaded.
Class<?>	getType(String name) Determine the type of the bean with the given name.
void	initApplicationEventMulticaster() Initialize the ApplicationEventMulticaster.
void	initLifecycleProcessor() Initialize the LifecycleProcessor.
void	initMessageSource() Initialize the MessageSource.
void	initPropertySources() Replace any stub property sources with actual instances.
void	invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory beanFactory) Instantiate and invoke all registered BeanFactoryPostProcessor beans, respecting explicit order if given.
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	isPrototype(String name) Is this bean a prototype? That is, will `getBean(Class)` always return independent instances? Note: This method returning `false` does not clearly indicate a singleton object.
boolean	isRunning() Check whether this component is currently running.
boolean	isSingleton(String name) Is this bean a shared singleton? That is, will `getBean(Class)` always return the same instance? Note: This method returning `false` does not clearly indicate independent instances.
boolean	isTypeMatch(String name, Class<?> targetType) Check whether the bean with the given name matches the specified type.
ConfigurableListableBeanFactory	obtainFreshBeanFactory() Tell the subclass to refresh the internal bean factory.
void	onClose() Template method which can be overridden to add context-specific shutdown work.
void	onRefresh() Template method which can be overridden to add context-specific refresh work.
void	postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) Modify the application context's internal bean factory after its standard initialization.
void	prepareBeanFactory(ConfigurableListableBeanFactory beanFactory) Configure the factory's standard context characteristics, such as the context's ClassLoader and post-processors.
void	prepareRefresh() Prepare this context for refreshing, setting its startup date and active flag as well as performing any initialization of property sources.
void	publishEvent(ApplicationEvent event) Publish the given event to all listeners.
void	refresh() Load or refresh the persistent representation of the configuration, which might an XML file, properties file, or relational database schema.
abstract void	refreshBeanFactory() Subclasses must implement this method to perform the actual configuration load.
void	registerBeanPostProcessors(ConfigurableListableBeanFactory beanFactory) Instantiate and invoke all registered BeanPostProcessor beans, respecting explicit order if given.
void	registerListeners() Add beans that implement ApplicationListener as listeners.
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	setDisplayName(String displayName) Set a friendly name for this context.
void	setEnvironment(ConfigurableEnvironment environment) Set the `Environment` for this application context. Default value is determined by `createEnvironment()`.
void	setId(String id) Set the unique id of this application context.
void	setParent(ApplicationContext parent) Set the parent of this application context.
void	start() Start this component.
void	stop() Stop this component.
String	toString() Return information about this context.

From class org.springframework.core.io.DefaultResourceLoader

From class java.lang.Object

From interface org.springframework.beans.factory.BeanFactory

abstract boolean	containsBean(String name) Does this bean factory contain a bean with the given name? More specifically, is `getBean(Class)` able to obtain a bean instance for the given name? Translates aliases back to the corresponding canonical bean name.
abstract String[]	getAliases(String name) Return the aliases for the given bean name, if any.
abstract Object	getBean(String name) Return an instance, which may be shared or independent, of the specified bean.
abstract Object	getBean(String name, Object... args) Return an instance, which may be shared or independent, of the specified bean.
abstract <T> T	getBean(Class<T> requiredType) Return the bean instance that uniquely matches the given object type, if any.
abstract <T> T	getBean(String name, Class<T> requiredType) Return an instance, which may be shared or independent, of the specified bean.
abstract Class<?>	getType(String name) Determine the type of the bean with the given name.
abstract boolean	isPrototype(String name) Is this bean a prototype? That is, will `getBean(Class)` always return independent instances? Note: This method returning `false` does not clearly indicate a singleton object.
abstract boolean	isSingleton(String name) Is this bean a shared singleton? That is, will `getBean(Class)` always return the same instance? Note: This method returning `false` does not clearly indicate independent instances.
abstract boolean	isTypeMatch(String name, Class<?> targetType) Check whether the bean with the given name matches the specified type.

From interface org.springframework.beans.factory.BeanNameAware

From interface org.springframework.beans.factory.DisposableBean

From interface org.springframework.beans.factory.HierarchicalBeanFactory

From interface org.springframework.beans.factory.InitializingBean

From interface org.springframework.beans.factory.ListableBeanFactory

abstract boolean	containsBeanDefinition(String beanName) Check if this bean factory contains a bean definition with the given name.
abstract <A extends Annotation> A	findAnnotationOnBean(String beanName, Class<A> annotationType) Find a `Annotation` of `annotationType` on the specified bean, traversing its interfaces and super classes if no annotation can be found on the given class itself.
abstract int	getBeanDefinitionCount() Return the number of beans defined in the factory.
abstract String[]	getBeanDefinitionNames() Return the names of all beans defined in this factory.
abstract String[]	getBeanNamesForType(Class<?> type, boolean includeNonSingletons, boolean allowEagerInit) Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
abstract String[]	getBeanNamesForType(Class<?> type) Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
abstract <T> Map<String, T>	getBeansOfType(Class<T> type) Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
abstract <T> Map<String, T>	getBeansOfType(Class<T> type, boolean includeNonSingletons, boolean allowEagerInit) Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value of `getObjectType` in the case of FactoryBeans.
abstract Map<String, Object>	getBeansWithAnnotation(Class<? extends Annotation> annotationType) Find all beans whose `Class` has the supplied `Annotation` type.

From interface org.springframework.context.ApplicationContext

From interface org.springframework.context.ApplicationEventPublisher

From interface org.springframework.context.ConfigurableApplicationContext

abstract void	addApplicationListener(ApplicationListener<?> listener) Add a new ApplicationListener that will be notified on context events such as context refresh and context shutdown.
abstract 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.
abstract void	close() Close this application context, releasing all resources and locks that the implementation might hold.
abstract ConfigurableListableBeanFactory	getBeanFactory() Return the internal bean factory of this application context.
abstract ConfigurableEnvironment	getEnvironment() Return the Environment for this application context in configurable form.
abstract 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.
abstract void	refresh() Load or refresh the persistent representation of the configuration, which might an XML file, properties file, or relational database schema.
abstract 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.
abstract void	setEnvironment(ConfigurableEnvironment environment) Set the `Environment` for this application context.
abstract void	setId(String id) Set the unique id of this application context.
abstract void	setParent(ApplicationContext parent) Set the parent of this application context.

From interface org.springframework.context.Lifecycle

From interface org.springframework.context.MessageSource

From interface org.springframework.core.env.EnvironmentCapable

From interface org.springframework.core.io.ResourceLoader

From interface org.springframework.core.io.support.ResourcePatternResolver

Public Constructors

public ClassPathXmlApplicationContext ()

Create a new ClassPathXmlApplicationContext for bean-style configuration.

public ClassPathXmlApplicationContext (ApplicationContext parent)

Create a new ClassPathXmlApplicationContext for bean-style configuration.

Parameters

parent	the parent context

public ClassPathXmlApplicationContext (String configLocation)

Create a new ClassPathXmlApplicationContext, loading the definitions from the given XML file and automatically refreshing the context.

Parameters

configLocation	resource location

Throws

BeansException	if context creation failed

public ClassPathXmlApplicationContext (String... configLocations)

Create a new ClassPathXmlApplicationContext, loading the definitions from the given XML files and automatically refreshing the context.

Parameters

configLocations	array of resource locations

Throws

BeansException	if context creation failed

public ClassPathXmlApplicationContext (String[] configLocations, ApplicationContext parent)

Create a new ClassPathXmlApplicationContext with the given parent, loading the definitions from the given XML files and automatically refreshing the context.

Parameters

configLocations	array of resource locations
parent	the parent context

Throws

BeansException	if context creation failed

public ClassPathXmlApplicationContext (String[] configLocations, boolean refresh)

Create a new ClassPathXmlApplicationContext, loading the definitions from the given XML files.

Parameters

configLocations	array of resource locations
refresh	whether to automatically refresh the context, loading all bean definitions and creating all singletons. Alternatively, call refresh manually after further configuring the context.

Throws

BeansException	if context creation failed

public ClassPathXmlApplicationContext (String[] configLocations, boolean refresh, ApplicationContext parent)

Create a new ClassPathXmlApplicationContext with the given parent, loading the definitions from the given XML files.

Parameters

configLocations	array of resource locations
refresh	whether to automatically refresh the context, loading all bean definitions and creating all singletons. Alternatively, call refresh manually after further configuring the context.
parent	the parent context

Throws

BeansException	if context creation failed

public ClassPathXmlApplicationContext (String path, Class clazz)

Create a new ClassPathXmlApplicationContext, loading the definitions from the given XML file and automatically refreshing the context.

This is a convenience method to load class path resources relative to a given Class. For full flexibility, consider using a GenericApplicationContext with an XmlBeanDefinitionReader and a ClassPathResource argument.

Parameters

path	relative (or absolute) path within the class path
clazz	the class to load resources with (basis for the given paths)

Throws

BeansException	if context creation failed

public ClassPathXmlApplicationContext (String[] paths, Class clazz)

Create a new ClassPathXmlApplicationContext, loading the definitions from the given XML files and automatically refreshing the context.

Parameters

paths	array of relative (or absolute) paths within the class path
clazz	the class to load resources with (basis for the given paths)

Throws

BeansException	if context creation failed

public ClassPathXmlApplicationContext (String[] paths, Class clazz, ApplicationContext parent)

Create a new ClassPathXmlApplicationContext with the given parent, loading the definitions from the given XML files and automatically refreshing the context.

Parameters

paths	array of relative (or absolute) paths within the class path
clazz	the class to load resources with (basis for the given paths)
parent	the parent context

Throws

BeansException	if context creation failed

Protected Methods

protected Resource[] getConfigResources ()

Return an array of Resource objects, referring to the XML bean definition files that this context should be built with.

The default implementation returns null. Subclasses can override this to provide pre-built Resource objects rather than location Strings.

Returns

an array of Resource objects, or null if none

Classes

ClassPathXmlApplicationContext

Class Overview

See Also

Summary

Public Constructors

public ClassPathXmlApplicationContext ()

See Also

public ClassPathXmlApplicationContext (ApplicationContext parent)

Parameters

See Also

public ClassPathXmlApplicationContext (String configLocation)

Parameters

Throws

public ClassPathXmlApplicationContext (String... configLocations)

Parameters

Throws

public ClassPathXmlApplicationContext (String[] configLocations, ApplicationContext parent)

Parameters

Throws

public ClassPathXmlApplicationContext (String[] configLocations, boolean refresh)

Parameters

Throws

See Also

public ClassPathXmlApplicationContext (String[] configLocations, boolean refresh, ApplicationContext parent)

Parameters

Throws

See Also

public ClassPathXmlApplicationContext (String path, Class clazz)

Parameters

Throws

See Also

public ClassPathXmlApplicationContext (String[] paths, Class clazz)

Parameters

Throws

See Also

public ClassPathXmlApplicationContext (String[] paths, Class clazz, ApplicationContext parent)

Parameters

Throws

See Also

Protected Methods

protected Resource[] getConfigResources ()

Returns