org.springframework.context.support
Class ClassPathXmlApplicationContext

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

All Implemented Interfaces:

BeanFactory, DisposableBean, HierarchicalBeanFactory, ListableBeanFactory, ApplicationContext, ApplicationEventPublisher, ConfigurableApplicationContext, Lifecycle, MessageSource, ResourceLoader, ResourcePatternResolver

public class ClassPathXmlApplicationContext
extends AbstractXmlApplicationContext

Standalone XML application context, taking the context definition files from the class path. Mainly useful for test harnesses, but also for application contexts embedded within JARs.

Treats resource paths as class path resources, when using getResource. Only supports full class path resource names that include the package path, like "mypackage/myresource.dat".

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 PathMatcher 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.

Author:

Rod Johnson, Juergen Hoeller

See Also:

DefaultResourceLoader.getResource(java.lang.String), DefaultResourceLoader.getResourceByPath(java.lang.String), PathMatchingResourcePatternResolver, GenericApplicationContext, XmlBeanDefinitionReader

Field Summary

Fields inherited from class org.springframework.context.support.AbstractApplicationContext

APPLICATION_EVENT_MULTICASTER_BEAN_NAME, logger, MESSAGE_SOURCE_BEAN_NAME

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

Constructor Summary

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[] 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.

ClassPathXmlApplicationContext(String path, Class clazz)
Create a new ClassPathXmlApplicationContext, loading the definitions from the given XML file and automatically refreshing the context.

Method Summary

protected String[]	getConfigLocations() Return an array of resource locations, referring to the XML bean definition files that this context should be built with.
protected Resource[]	getConfigResources() Return an array of Resource objects, referring to the XML bean definition files that this context should be built with.

Methods inherited from class org.springframework.context.support.AbstractXmlApplicationContext

initBeanDefinitionReader, loadBeanDefinitions, loadBeanDefinitions

Methods inherited from class org.springframework.context.support.AbstractRefreshableApplicationContext

closeBeanFactory, createBeanFactory, getBeanFactory, refreshBeanFactory

Methods inherited from class org.springframework.context.support.AbstractApplicationContext

addBeanFactoryPostProcessor, addListener, close, containsBean, containsBeanDefinition, containsLocalBean, destroy, doClose, getAliases, getAutowireCapableBeanFactory, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanFactoryPostProcessors, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType, getDisplayName, getInternalParentBeanFactory, getInternalParentMessageSource, getLifecycleBeans, getMessage, getMessage, getMessage, getParent, getParentBeanFactory, getResourcePatternResolver, getResources, getStartupDate, getType, isActive, isRunning, isSingleton, isTypeMatch, onClose, onRefresh, postProcessBeanFactory, publishEvent, refresh, registerShutdownHook, setDisplayName, setParent, start, stop, toString

Methods inherited from class org.springframework.core.io.DefaultResourceLoader

getClassLoader, getResource, getResourceByPath, setClassLoader

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.core.io.ResourceLoader

getClassLoader, getResource

Constructor Detail

ClassPathXmlApplicationContext

public ClassPathXmlApplicationContext(String configLocation)
                               throws BeansException

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

Parameters:

configLocation - resource location

Throws:

BeansException

ClassPathXmlApplicationContext

public ClassPathXmlApplicationContext(String[] configLocations)
                               throws BeansException

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

ClassPathXmlApplicationContext

public ClassPathXmlApplicationContext(String[] configLocations,
                                      ApplicationContext parent)
                               throws BeansException

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

ClassPathXmlApplicationContext

public ClassPathXmlApplicationContext(String[] configLocations,
                                      boolean refresh)
                               throws BeansException

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

See Also:

AbstractApplicationContext.refresh()

ClassPathXmlApplicationContext

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

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

See Also:

AbstractApplicationContext.refresh()

ClassPathXmlApplicationContext

public ClassPathXmlApplicationContext(String path,
                                      Class clazz)
                               throws BeansException

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

See Also:

ClassPathResource.ClassPathResource(String, Class), GenericApplicationContext, XmlBeanDefinitionReader

ClassPathXmlApplicationContext

public ClassPathXmlApplicationContext(String[] paths,
                                      Class clazz)
                               throws BeansException

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

See Also:

ClassPathResource.ClassPathResource(String, Class), GenericApplicationContext, XmlBeanDefinitionReader

ClassPathXmlApplicationContext

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

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

See Also:

ClassPathResource.ClassPathResource(String, Class), GenericApplicationContext, XmlBeanDefinitionReader

Method Detail

getConfigResources

protected Resource[] getConfigResources()

Description copied from class: AbstractXmlApplicationContext

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

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

Overrides:

getConfigResources in class AbstractXmlApplicationContext

Returns:

an array of Resource objects, or null if none

See Also:

AbstractXmlApplicationContext.getConfigLocations()

getConfigLocations

protected String[] getConfigLocations()

Description copied from class: AbstractXmlApplicationContext

Return an array of resource locations, referring to the XML bean definition files that this context should be built with. Can also include location patterns, which will get resolved via a ResourcePatternResolver.

Default implementation returns null. Subclasses can override this to provide a set of resource locations to load bean definitions from.

Overrides:

getConfigLocations in class AbstractXmlApplicationContext

Returns:

an array of resource locations, or null if none

See Also:

AbstractApplicationContext.getResources(java.lang.String), AbstractApplicationContext.getResourcePatternResolver()