Package org.springframework.test.context.support

Class AbstractGenericContextLoader

java.lang.Object

org.springframework.test.context.support.AbstractContextLoader

org.springframework.test.context.support.AbstractGenericContextLoader

All Implemented Interfaces:

AotContextLoader, ContextLoader, SmartContextLoader

Direct Known Subclasses:

AnnotationConfigContextLoader, GenericXmlContextLoader

public abstract class AbstractGenericContextLoader
extends AbstractContextLoader
implements AotContextLoader

Abstract, generic extension of AbstractContextLoader that loads a GenericApplicationContext.

• If instances of concrete subclasses are invoked via the ContextLoader SPI, the context will be loaded from the locations provided to loadContext(String...).
• If instances of concrete subclasses are invoked via the SmartContextLoader SPI, the context will be loaded from the MergedContextConfiguration provided to loadContext(MergedContextConfiguration). In such cases, a SmartContextLoader will decide whether to load the context from locations or annotated classes.

Concrete subclasses must provide an appropriate implementation of createBeanDefinitionReader(), potentially overriding loadBeanDefinitions() as well.

Since:

2.5

Author:

Sam Brannen, Juergen Hoeller, Phillip Webb

See Also:

• loadContext(MergedContextConfiguration)

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Log	logger

Constructor Summary

Constructors

Constructor	Description
AbstractGenericContextLoader()

Method Summary

Modifier and Type	Method	Description
protected abstract BeanDefinitionReader	createBeanDefinitionReader(GenericApplicationContext context)	Factory method for creating a new BeanDefinitionReader for loading bean definitions into the supplied context.
protected GenericApplicationContext	createContext()	Factory method for creating the GenericApplicationContext used by this ContextLoader.
protected void	customizeBeanFactory(DefaultListableBeanFactory beanFactory)	Customize the internal bean factory of the ApplicationContext created by this ContextLoader.
protected void	customizeContext(GenericApplicationContext context)	Customize the GenericApplicationContext created by this ContextLoader after bean definitions have been loaded into the context but before the context is refreshed.
protected void	loadBeanDefinitions(GenericApplicationContext context, MergedContextConfiguration mergedConfig)	Load bean definitions into the supplied context from the locations or classes in the supplied MergedContextConfiguration.
final ConfigurableApplicationContext	loadContext(String... locations)	Deprecated. as of Spring Framework 6.0, in favor of loadContext(MergedContextConfiguration)
final ApplicationContext	loadContext(MergedContextConfiguration mergedConfig)	Load a GenericApplicationContext for the supplied MergedContextConfiguration.
final GenericApplicationContext	loadContextForAotProcessing(MergedContextConfiguration mergedConfig)	Deprecated, for removal: This API element is subject to removal in a future version. as of Spring Framework 6.2.4, in favor of loadContextForAotProcessing(MergedContextConfiguration, RuntimeHints); to be removed in Spring Framework 8.0
final GenericApplicationContext	loadContextForAotProcessing(MergedContextConfiguration mergedConfig, RuntimeHints runtimeHints)	Load a GenericApplicationContext for AOT build-time processing based on the supplied MergedContextConfiguration.
final GenericApplicationContext	loadContextForAotRuntime(MergedContextConfiguration mergedConfig, ApplicationContextInitializer<ConfigurableApplicationContext> initializer)	Load a GenericApplicationContext for AOT run-time execution based on the supplied MergedContextConfiguration and ApplicationContextInitializer.
protected void	prepareContext(GenericApplicationContext context)	Prepare the GenericApplicationContext created by this ContextLoader.
protected void	validateMergedContextConfiguration(MergedContextConfiguration mergedConfig)	Validate the supplied MergedContextConfiguration with respect to what this context loader supports.

Methods inherited from class org.springframework.test.context.support.AbstractContextLoader

customizeContext, generateDefaultLocations, getResourceSuffix, getResourceSuffixes, isGenerateDefaultLocations, modifyLocations, prepareContext, processContextConfiguration, processLocations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.test.context.SmartContextLoader

processContextConfiguration, processLocations

Field Details

logger

protected static final Log logger

Constructor Details

AbstractGenericContextLoader

public AbstractGenericContextLoader()

Method Details

loadContext

public final ApplicationContext loadContext(MergedContextConfiguration mergedConfig)
                                     throws Exception

Load a GenericApplicationContext for the supplied MergedContextConfiguration.

Implementation details:

• Calls validateMergedContextConfiguration(MergedContextConfiguration) to allow subclasses to validate the supplied configuration before proceeding.
• Calls createContext() to create a GenericApplicationContext instance.
• If the supplied MergedContextConfiguration references a parent configuration, the corresponding ApplicationContext will be retrieved and set as the parent for the context created by this method.
• Calls prepareContext(GenericApplicationContext) for backwards compatibility with the ContextLoader SPI.
• Calls AbstractContextLoader.prepareContext(ConfigurableApplicationContext, MergedContextConfiguration) to allow for customizing the context before bean definitions are loaded.
• Calls customizeBeanFactory(DefaultListableBeanFactory) to allow for customizing the context's DefaultListableBeanFactory.
• Delegates to loadBeanDefinitions(GenericApplicationContext, MergedContextConfiguration) to populate the context from the locations or classes in the supplied MergedContextConfiguration.
• Delegates to AnnotationConfigUtils for registering annotation configuration processors.
• Calls customizeContext(GenericApplicationContext) to allow for customizing the context before it is refreshed.
• Calls AbstractContextLoader.customizeContext(ConfigurableApplicationContext, MergedContextConfiguration) to allow for customizing the context before it is refreshed.
• Refreshes the context and registers a JVM shutdown hook for it.

Specified by:

loadContext in interface SmartContextLoader

Parameters:

mergedConfig - the merged context configuration to use to load the application context

Returns:

a new application context

Throws:

ContextLoadException - if context loading failed

Exception

See Also:

• SmartContextLoader.loadContext(MergedContextConfiguration)

loadContextForAotProcessing

@Deprecated(since="6.2.4",
            forRemoval=true)
public final GenericApplicationContext loadContextForAotProcessing(MergedContextConfiguration mergedConfig)
                                                            throws Exception

Deprecated, for removal: This API element is subject to removal in a future version.

as of Spring Framework 6.2.4, in favor of loadContextForAotProcessing(MergedContextConfiguration, RuntimeHints); to be removed in Spring Framework 8.0

Load a GenericApplicationContext for AOT build-time processing based on the supplied MergedContextConfiguration.

In contrast to loadContext(MergedContextConfiguration), this method does not refresh the ApplicationContext or register a JVM shutdown hook for it. Otherwise, this method implements behavior identical to loadContext(MergedContextConfiguration).

Specified by:

loadContextForAotProcessing in interface AotContextLoader

Parameters:

mergedConfig - the merged context configuration to use to load the application context

Returns:

a new application context

Throws:

Exception - if context loading failed

Since:

6.0

See Also:

• AotContextLoader.loadContextForAotProcessing(MergedContextConfiguration)

loadContextForAotProcessing

public final GenericApplicationContext loadContextForAotProcessing(MergedContextConfiguration mergedConfig,
 RuntimeHints runtimeHints)
                                                            throws Exception

Load a GenericApplicationContext for AOT build-time processing based on the supplied MergedContextConfiguration.

In contrast to loadContext(MergedContextConfiguration), this method does not refresh the ApplicationContext or register a JVM shutdown hook for it. Otherwise, this method implements behavior identical to loadContext(MergedContextConfiguration).

Specified by:

loadContextForAotProcessing in interface AotContextLoader

Parameters:

mergedConfig - the merged context configuration to use to load the application context

runtimeHints - the runtime hints

Returns:

a new application context

Throws:

Exception - if context loading failed

Since:

6.2.4

See Also:

• AotContextLoader.loadContextForAotProcessing(MergedContextConfiguration, RuntimeHints)

loadContextForAotRuntime

public final GenericApplicationContext loadContextForAotRuntime(MergedContextConfiguration mergedConfig,
 ApplicationContextInitializer<ConfigurableApplicationContext> initializer)
                                                         throws Exception

Load a GenericApplicationContext for AOT run-time execution based on the supplied MergedContextConfiguration and ApplicationContextInitializer.

Specified by:

loadContextForAotRuntime in interface AotContextLoader

Parameters:

mergedConfig - the merged context configuration to use to load the application context

initializer - the ApplicationContextInitializer that should be applied to the context in order to recreate bean definitions

Returns:

a new application context

Throws:

Exception - if context loading failed

Since:

6.0

See Also:

• AotContextLoader.loadContextForAotRuntime(MergedContextConfiguration, ApplicationContextInitializer)

validateMergedContextConfiguration

protected void validateMergedContextConfiguration(MergedContextConfiguration mergedConfig)

Validate the supplied MergedContextConfiguration with respect to what this context loader supports.

The default implementation is a no-op but can be overridden by subclasses as appropriate.

Parameters:

mergedConfig - the merged configuration to validate

Throws:

IllegalStateException - if the supplied configuration is not valid for this context loader

Since:

4.0.4

loadContext

@Deprecated(since="6.0")
public final ConfigurableApplicationContext loadContext(String... locations)
                                                 throws Exception

Deprecated.

as of Spring Framework 6.0, in favor of loadContext(MergedContextConfiguration)

Load a Spring ApplicationContext from the supplied locations.

Implementation details:

• Calls createContext() to create a GenericApplicationContext instance.
• Calls prepareContext(GenericApplicationContext) to allow for customizing the context before bean definitions are loaded.
• Calls customizeBeanFactory(DefaultListableBeanFactory) to allow for customizing the context's DefaultListableBeanFactory.
• Delegates to createBeanDefinitionReader(GenericApplicationContext) to create a BeanDefinitionReader which is then used to populate the context from the specified locations.
• Delegates to AnnotationConfigUtils for registering annotation configuration processors.
• Calls customizeContext(GenericApplicationContext) to allow for customizing the context before it is refreshed.
• Refreshes the context and registers a JVM shutdown hook for it.

Note: this method does not provide a means to set active bean definition profiles for the loaded context. See loadContext(MergedContextConfiguration) and AbstractContextLoader.prepareContext(ConfigurableApplicationContext, MergedContextConfiguration) for an alternative.

Specified by:

loadContext in interface ContextLoader

Specified by:

loadContext in interface SmartContextLoader

Parameters:

locations - the resource locations to use to load the application context

Returns:

a new application context

Throws:

Exception - if context loading failed

Since:

2.5

See Also:

• ContextLoader.loadContext(java.lang.String...)
• GenericApplicationContext
• loadContext(MergedContextConfiguration)

createContext

protected GenericApplicationContext createContext()

Factory method for creating the GenericApplicationContext used by this ContextLoader.

The default implementation creates a GenericApplicationContext using the default constructor. This method may be overridden — for example, to use a custom context subclass or to create a GenericApplicationContext with a custom DefaultListableBeanFactory implementation.

Returns:

a newly instantiated GenericApplicationContext

Since:

5.2.9

prepareContext

protected void prepareContext(GenericApplicationContext context)

Prepare the GenericApplicationContext created by this ContextLoader. Called before bean definitions are read.

The default implementation is empty. Can be overridden in subclasses to customize GenericApplicationContext's standard settings.

Parameters:

context - the context that should be prepared

Since:

2.5

See Also:

• loadContext(MergedContextConfiguration)
• GenericApplicationContext.setAllowBeanDefinitionOverriding(boolean)
• GenericApplicationContext.setResourceLoader(org.springframework.core.io.ResourceLoader)
• AbstractApplicationContext.setId(java.lang.String)
• AbstractContextLoader.prepareContext(ConfigurableApplicationContext, MergedContextConfiguration)

customizeBeanFactory

protected void customizeBeanFactory(DefaultListableBeanFactory beanFactory)

Customize the internal bean factory of the ApplicationContext created by this ContextLoader.

The default implementation is empty but can be overridden in subclasses to customize DefaultListableBeanFactory's standard settings.

Parameters:

beanFactory - the bean factory created by this ContextLoader

Since:

2.5

See Also:

• loadContext(MergedContextConfiguration)
• DefaultListableBeanFactory.setAllowBeanDefinitionOverriding(boolean)
• DefaultListableBeanFactory.setAllowEagerClassLoading(boolean)
• AbstractAutowireCapableBeanFactory.setAllowCircularReferences(boolean)
• AbstractAutowireCapableBeanFactory.setAllowRawInjectionDespiteWrapping(boolean)

loadBeanDefinitions

protected void loadBeanDefinitions(GenericApplicationContext context,
 MergedContextConfiguration mergedConfig)

Load bean definitions into the supplied context from the locations or classes in the supplied MergedContextConfiguration.

The default implementation delegates to the BeanDefinitionReader returned by createBeanDefinitionReader(GenericApplicationContext) to load the bean definitions.

Subclasses must provide an appropriate implementation of createBeanDefinitionReader(GenericApplicationContext). Alternatively subclasses may provide a no-op implementation of createBeanDefinitionReader() and override this method to provide a custom strategy for loading or registering bean definitions.

Parameters:

context - the context into which the bean definitions should be loaded

mergedConfig - the merged context configuration

Since:

3.1

See Also:

• loadContext(MergedContextConfiguration)

createBeanDefinitionReader

protected abstract BeanDefinitionReader createBeanDefinitionReader(GenericApplicationContext context)

Factory method for creating a new BeanDefinitionReader for loading bean definitions into the supplied context.

Parameters:

context - the context for which the BeanDefinitionReader should be created

Returns:

a BeanDefinitionReader for the supplied context

Since:

2.5

See Also:

• loadContext(MergedContextConfiguration)
• loadBeanDefinitions(org.springframework.context.support.GenericApplicationContext, org.springframework.test.context.MergedContextConfiguration)
• BeanDefinitionReader

customizeContext

protected void customizeContext(GenericApplicationContext context)

Customize the GenericApplicationContext created by this ContextLoader after bean definitions have been loaded into the context but before the context is refreshed.

The default implementation is empty but can be overridden in subclasses to customize the application context.

Parameters:

context - the newly created application context

Since:

2.5

See Also:

• loadContext(MergedContextConfiguration)
• AbstractContextLoader.customizeContext(ConfigurableApplicationContext, MergedContextConfiguration)