org.springframework.context.access
Class ContextSingletonBeanFactoryLocator

java.lang.Object
  extended by org.springframework.beans.factory.access.SingletonBeanFactoryLocator
      extended by org.springframework.context.access.ContextSingletonBeanFactoryLocator
All Implemented Interfaces:
BeanFactoryLocator

public class ContextSingletonBeanFactoryLocator
extends SingletonBeanFactoryLocator

Variant of SingletonBeanFactoryLocator which creates its internal bean factory reference definition as an ApplicationContext instead of SingletonBeanFactoryLocator's BeanFactory. For almost all usage scenarios, this will not make a difference, since withing that ApplicationContext or BeanFactory you are still free to create either BeanFactories or ApplicationContexts. The main reason one would need to use this class is if BeanPostProcessing (or other ApplicationContext specific features are needed in the bean reference definition itself.

Note: This class uses classpath*:beanRefContext.xml as the default name for the bean factory reference definition. It is not possible nor legal to share definitions with SingletonBeanFactoryLocator at the same time.

Author:
Colin Sampaleanu
See Also:
DefaultLocatorFactory

Field Summary
 
Fields inherited from class org.springframework.beans.factory.access.SingletonBeanFactoryLocator
logger
 
Constructor Summary
protected ContextSingletonBeanFactoryLocator()
          Constructor which uses the default "classpath*:beanRefContext.xml", as the name of the definition file(s).
protected ContextSingletonBeanFactoryLocator(String resourceName)
          Constructor which uses the the specified name as the name of the definition file(s).
 
Method Summary
protected  BeanFactory createDefinition(String resourceName, String factoryKey)
          Overrides default method to create definition object as an ApplicationContext instead of the default BeanFactory.
protected  void destroyDefinition(BeanFactory groupDef, String resourceName)
          Overrides default method to work with ApplicationContext
static BeanFactoryLocator getInstance()
          Returns an instance which uses the default "classpath*:beanRefContext.xml", as the name of the definition file(s).
static BeanFactoryLocator getInstance(String selector)
          Returns an instance which uses the the specified selector, as the name of the definition file(s).
protected  void initializeDefinition(BeanFactory groupDef)
          Overrides default method to initialize definition object, which this method assumes is a ConfigurableApplicationContext.
 
Methods inherited from class org.springframework.beans.factory.access.SingletonBeanFactoryLocator
useBeanFactory
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ContextSingletonBeanFactoryLocator

protected ContextSingletonBeanFactoryLocator()
Constructor which uses the default "classpath*:beanRefContext.xml", as the name of the definition file(s). All resources returned by the definition classloader's getResources() method with this name will be combined to create a definition.


ContextSingletonBeanFactoryLocator

protected ContextSingletonBeanFactoryLocator(String resourceName)
Constructor which uses the the specified name as the name of the definition file(s). All resources returned by the definition classloader's getResources() method with this name will be combined to create a definition.

Method Detail

getInstance

public static BeanFactoryLocator getInstance()
                                      throws BeansException
Returns an instance which uses the default "classpath*:beanRefContext.xml", as the name of the definition file(s). All resources returned by the current thread's context classloader's getResources() method with this name will be combined to create a definition, which is just a BeanFactory.

Throws:
BeansException

getInstance

public static BeanFactoryLocator getInstance(String selector)
                                      throws BeansException
Returns an instance which uses the the specified selector, as the name of the definition file(s). In the case of a name with a Spring "classpath*:" prefix, or with no prefix, which is treated the same, the current thread's context class loader's getResources method will be called with this value to get all resources having that name. These resources will then be combined to form a definition. In the case where the name uses a Spring "classpath:" prefix, or a standard URL prefix, then only one resource file will be loaded as the definition.

Parameters:
selector - the name of the resource(s) which will be read and combine to form the definition for the SingletonBeanFactoryLocator instance. The one file or multiple fragments with this name must form a valid ApplicationContext definition.
Throws:
BeansException

createDefinition

protected BeanFactory createDefinition(String resourceName,
                                       String factoryKey)
                                throws BeansException
Overrides default method to create definition object as an ApplicationContext instead of the default BeanFactory. This does not affect what can actually be loaded by that definition.

Overrides:
createDefinition in class SingletonBeanFactoryLocator
Throws:
BeansException

initializeDefinition

protected void initializeDefinition(BeanFactory groupDef)
                             throws BeansException
Overrides default method to initialize definition object, which this method assumes is a ConfigurableApplicationContext. This implementation simply invokes ConfigurableApplicationContext.refresh().

Overrides:
initializeDefinition in class SingletonBeanFactoryLocator
Parameters:
groupDef - the factory returned by createDefinition()
Throws:
BeansException

destroyDefinition

protected void destroyDefinition(BeanFactory groupDef,
                                 String resourceName)
                          throws BeansException
Overrides default method to work with ApplicationContext

Overrides:
destroyDefinition in class SingletonBeanFactoryLocator
Throws:
BeansException


Copyright (c) 2002-2007 The Spring Framework Project.