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

org.springframework.context.support
public class: FileSystemXmlApplicationContext [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.FileSystemXmlApplicationContext

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

Standalone XML application context, taking the context definition files from the file system or from URLs, interpreting plain paths as relative file system locations (e.g. "mydir/myfile.txt"). Useful for test harnesses as well as for standalone environments.

NOTE: Plain paths will always be interpreted as relative to the current VM working directory, even if they start with a slash. (This is consistent with the semantics in a Servlet container.) Use an explicit "file:" prefix to enforce an absolute file path.

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 FileSystemXmlApplicationContext() { } Create a new FileSystemXmlApplicationContext for bean-style configuration. Also see: setConfigLocation setConfigLocations afterPropertiesSet()
public FileSystemXmlApplicationContext(ApplicationContext parent) { super(parent); } Create a new FileSystemXmlApplicationContext for bean-style configuration. Parameters: `parent` - the parent context Also see: setConfigLocation setConfigLocations afterPropertiesSet()
public FileSystemXmlApplicationContext(String configLocation) throws BeansException { this(new String[] {configLocation}, true, null); } Create a new FileSystemXmlApplicationContext, loading the definitions from the given XML file and automatically refreshing the context. Parameters: `configLocation` - file path Throws: `BeansException` - if context creation failed
public FileSystemXmlApplicationContext(String[] configLocations) throws BeansException { this(configLocations, true, null); } Create a new FileSystemXmlApplicationContext, loading the definitions from the given XML files and automatically refreshing the context. Parameters: `configLocations` - array of file paths Throws: `BeansException` - if context creation failed
public FileSystemXmlApplicationContext(String[] configLocations, ApplicationContext parent) throws BeansException { this(configLocations, true, parent); } Create a new FileSystemXmlApplicationContext with the given parent, loading the definitions from the given XML files and automatically refreshing the context. Parameters: `configLocations` - array of file paths `parent` - the parent context Throws: `BeansException` - if context creation failed
public FileSystemXmlApplicationContext(String[] configLocations, boolean refresh) throws BeansException { this(configLocations, refresh, null); } Create a new FileSystemXmlApplicationContext, loading the definitions from the given XML files. Parameters: `configLocations` - array of file paths `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 FileSystemXmlApplicationContext(String[] configLocations, boolean refresh, ApplicationContext parent) throws BeansException { super(parent); setConfigLocations(configLocations); if (refresh) { refresh(); } } Create a new FileSystemXmlApplicationContext with the given parent, loading the definitions from the given XML files. Parameters: `configLocations` - array of file paths `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 FileSystemXmlApplicationContext() {

}

Create a new FileSystemXmlApplicationContext for bean-style configuration.

Also see:

setConfigLocation

setConfigLocations

afterPropertiesSet()

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

Create a new FileSystemXmlApplicationContext for bean-style configuration.

Parameters:

parent - the parent context

Also see:

setConfigLocation

setConfigLocations

afterPropertiesSet()

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

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

Parameters:

configLocation - file path

Throws:

BeansException - if context creation failed

 public FileSystemXmlApplicationContext(String[] configLocations) throws BeansException {
		this(configLocations, true, null);
}

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

Parameters:

configLocations - array of file paths

Throws:

BeansException - if context creation failed

 public FileSystemXmlApplicationContext(String[] configLocations,
    ApplicationContext parent) throws BeansException {
		this(configLocations, true, parent);
}

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

Parameters:

configLocations - array of file paths

parent - the parent context

Throws:

BeansException - if context creation failed

 public FileSystemXmlApplicationContext(String[] configLocations,
    boolean refresh) throws BeansException {
		this(configLocations, refresh, null);
}

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

Parameters:

configLocations - array of file paths

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 FileSystemXmlApplicationContext(String[] configLocations,
    boolean refresh,
    ApplicationContext parent) throws BeansException {
		super(parent);
		setConfigLocations(configLocations);
		if (refresh) {
			refresh();
		}
}

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

Parameters:

configLocations - array of file paths

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()

Method from org.springframework.context.support.FileSystemXmlApplicationContext Summary:
getResourceByPath

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.FileSystemXmlApplicationContext Detail:
protected Resource getResourceByPath(String path) { if (path != null && path.startsWith("/")) { path = path.substring(1); } return new FileSystemResource(path); } Resolve resource paths as file system paths. Note: Even if a given path starts with a slash, it will get interpreted as relative to the current VM working directory. This is consistent with the semantics in a Servlet container.

Method from org.springframework.context.support.FileSystemXmlApplicationContext Detail:

 protected Resource getResourceByPath(String path) {
		if (path != null && path.startsWith("/")) {
			path = path.substring(1);
		}
		return new FileSystemResource(path);
}

Note: Even if a given path starts with a slash, it will get interpreted as relative to the current VM working directory. This is consistent with the semantics in a Servlet container.