org.springframework.context.support: public class: ClassPathXmlApplicationContext

org.springframework.context.support
public class: ClassPathXmlApplicationContext [javadoc | source]

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

All Implemented Interfaces:
BeanNameAware, InitializingBean, ConfigurableApplicationContext, DisposableBean, ResourceLoader

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 org.springframework.util.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 org.springframework.beans.factory.xml.XmlBeanDefinitionReader for more flexible context setup.

Also see:

getResource

getResourceByPath

GenericApplicationContext

author: Rod - Johnson

author: Juergen - Hoeller

Fields inherited from org.springframework.context.support.AbstractApplicationContext:
MESSAGE_SOURCE_BEAN_NAME, APPLICATION_EVENT_MULTICASTER_BEAN_NAME, logger

Constructor:

Constructor:
public ClassPathXmlApplicationContext() { } Create a new ClassPathXmlApplicationContext for bean-style configuration. Also see: setConfigLocation setConfigLocations afterPropertiesSet()
public ClassPathXmlApplicationContext(ApplicationContext parent) { super(parent); } Create a new ClassPathXmlApplicationContext for bean-style configuration. Parameters: `parent` - the parent context Also see: setConfigLocation setConfigLocations afterPropertiesSet()
public ClassPathXmlApplicationContext(String configLocation) throws BeansException { this(new String[] {configLocation}, true, null); } 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) throws BeansException { this(configLocations, true, null); } 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) throws BeansException { this(configLocations, true, 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) throws BeansException { this(configLocations, refresh, null); } 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 Also see: refresh()
public ClassPathXmlApplicationContext(String path, Class clazz) throws BeansException { this(new String[] {path}, 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 Also see: org.springframework.core.io.ClassPathResource#ClassPathResource(String, Class) org.springframework.context.support.GenericApplicationContext org.springframework.beans.factory.xml.XmlBeanDefinitionReader
public ClassPathXmlApplicationContext(String[] paths, Class clazz) throws BeansException { this(paths, clazz, null); } 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 Also see: org.springframework.core.io.ClassPathResource#ClassPathResource(String, Class) org.springframework.context.support.GenericApplicationContext org.springframework.beans.factory.xml.XmlBeanDefinitionReader
public ClassPathXmlApplicationContext(String[] configLocations, boolean refresh, ApplicationContext parent) throws BeansException { super(parent); setConfigLocations(configLocations); if (refresh) { refresh(); } } 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 Also see: refresh()
public ClassPathXmlApplicationContext(String[] paths, Class clazz, ApplicationContext parent) throws BeansException { super(parent); Assert.notNull(paths, "Path array must not be null"); Assert.notNull(clazz, "Class argument must not be null"); this.configResources = new Resource[paths.length]; for (int i = 0; i < paths.length; i++) { this.configResources[i] = new ClassPathResource(paths[i], clazz); } refresh(); } 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 Also see: org.springframework.core.io.ClassPathResource#ClassPathResource(String, Class) org.springframework.context.support.GenericApplicationContext org.springframework.beans.factory.xml.XmlBeanDefinitionReader

 public ClassPathXmlApplicationContext() {

}

Create a new ClassPathXmlApplicationContext for bean-style configuration.

Also see:

setConfigLocation

setConfigLocations

afterPropertiesSet()

 public ClassPathXmlApplicationContext(ApplicationContext parent) {
		super(parent);
}

Create a new ClassPathXmlApplicationContext for bean-style configuration.

Parameters:

parent - the parent context

Also see:

setConfigLocation

setConfigLocations

afterPropertiesSet()

 public ClassPathXmlApplicationContext(String configLocation) throws BeansException {
		this(new String[] {configLocation}, true, null);
}

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) throws BeansException {
		this(configLocations, true, null);
}

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) throws BeansException {
		this(configLocations, true, 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) throws BeansException {
		this(configLocations, refresh, null);
}

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

Also see:

refresh()

 public ClassPathXmlApplicationContext(String path,
    Class clazz) throws BeansException {
		this(new String[] {path}, clazz);
}

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

Also see:

org.springframework.core.io.ClassPathResource#ClassPathResource(String, Class)

org.springframework.context.support.GenericApplicationContext

org.springframework.beans.factory.xml.XmlBeanDefinitionReader

 public ClassPathXmlApplicationContext(String[] paths,
    Class clazz) throws BeansException {
		this(paths, clazz, null);
}

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

Also see:

org.springframework.core.io.ClassPathResource#ClassPathResource(String, Class)

org.springframework.context.support.GenericApplicationContext

org.springframework.beans.factory.xml.XmlBeanDefinitionReader

 public ClassPathXmlApplicationContext(String[] configLocations,
    boolean refresh,
    ApplicationContext parent) throws BeansException {
		super(parent);
		setConfigLocations(configLocations);
		if (refresh) {
			refresh();
		}
}

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

Also see:

refresh()

 public ClassPathXmlApplicationContext(String[] paths,
    Class clazz,
    ApplicationContext parent) throws BeansException {
		super(parent);
		Assert.notNull(paths, "Path array must not be null");
		Assert.notNull(clazz, "Class argument must not be null");
		this.configResources = new Resource[paths.length];
		for (int i = 0; i <  paths.length; i++) {
			this.configResources[i] = new ClassPathResource(paths[i], clazz);
		}
		refresh();
}

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

Also see:

org.springframework.core.io.ClassPathResource#ClassPathResource(String, Class)

org.springframework.context.support.GenericApplicationContext

org.springframework.beans.factory.xml.XmlBeanDefinitionReader

Method from org.springframework.context.support.ClassPathXmlApplicationContext Summary:
getConfigResources

Methods from org.springframework.context.support.AbstractXmlApplicationContext:
getConfigResources, initBeanDefinitionReader, loadBeanDefinitions, loadBeanDefinitions

Methods from org.springframework.context.support.AbstractRefreshableConfigApplicationContext:
afterPropertiesSet, getConfigLocations, getDefaultConfigLocations, resolvePath, setBeanName, setConfigLocation, setConfigLocations, setId

Methods from org.springframework.context.support.AbstractRefreshableApplicationContext:
closeBeanFactory, createBeanFactory, customizeBeanFactory, getBeanFactory, hasBeanFactory, loadBeanDefinitions, refreshBeanFactory, setAllowBeanDefinitionOverriding, setAllowCircularReferences

Methods from org.springframework.context.support.AbstractApplicationContext:
addApplicationListener, addBeanFactoryPostProcessor, addListener, cancelRefresh, close, closeBeanFactory, containsBean, containsBeanDefinition, containsLocalBean, destroy, destroyBeans, doClose, finishBeanFactoryInitialization, finishRefresh, getAliases, getApplicationListeners, getAutowireCapableBeanFactory, getBean, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanFactory, getBeanFactoryPostProcessors, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType, getDisplayName, getId, getInternalParentBeanFactory, getInternalParentMessageSource, getMessage, getMessage, getMessage, getParent, getParentBeanFactory, getResourcePatternResolver, getResources, getStartupDate, getType, initApplicationEventMulticaster, initMessageSource, invokeBeanFactoryPostProcessors, isActive, isPrototype, isRunning, isSingleton, isTypeMatch, obtainFreshBeanFactory, onClose, onRefresh, postProcessBeanFactory, prepareBeanFactory, prepareRefresh, publishEvent, refresh, refreshBeanFactory, registerBeanPostProcessors, registerListeners, registerShutdownHook, setDisplayName, setId, setParent, start, stop, toString

Methods from org.springframework.context.support.AbstractApplicationContext:

addApplicationListener, addBeanFactoryPostProcessor, addListener, cancelRefresh, close, closeBeanFactory, containsBean, containsBeanDefinition, containsLocalBean, destroy, destroyBeans, doClose, finishBeanFactoryInitialization, finishRefresh, getAliases, getApplicationListeners, getAutowireCapableBeanFactory, getBean, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanFactory, getBeanFactoryPostProcessors, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType, getDisplayName, getId, getInternalParentBeanFactory, getInternalParentMessageSource, getMessage, getMessage, getMessage, getParent, getParentBeanFactory, getResourcePatternResolver, getResources, getStartupDate, getType, initApplicationEventMulticaster, initMessageSource, invokeBeanFactoryPostProcessors, isActive, isPrototype, isRunning, isSingleton, isTypeMatch, obtainFreshBeanFactory, onClose, onRefresh, postProcessBeanFactory, prepareBeanFactory, prepareRefresh, publishEvent, refresh, refreshBeanFactory, registerBeanPostProcessors, registerListeners, registerShutdownHook, setDisplayName, setId, setParent, start, stop, toString

Methods from org.springframework.core.io.DefaultResourceLoader:
getClassLoader, getResource, getResourceByPath, setClassLoader

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.springframework.context.support.ClassPathXmlApplicationContext Detail:
protected Resource[] getConfigResources() { return this.configResources; }