Class AbstractDelegatingSmartContextLoader

java.lang.Object

org.springframework.test.context.support.AbstractDelegatingSmartContextLoader

All Implemented Interfaces:

AotContextLoader, ContextLoader, SmartContextLoader

Direct Known Subclasses:

DelegatingSmartContextLoader, WebDelegatingSmartContextLoader

public abstract class AbstractDelegatingSmartContextLoader
extends Object
implements AotContextLoader

AbstractDelegatingSmartContextLoader serves as an abstract base class for implementations of the SmartContextLoader SPI that delegate to a set of candidate SmartContextLoaders (i.e., one that supports XML configuration files or Groovy scripts and one that supports annotated classes) to determine which context loader is appropriate for a given test class's configuration. Each candidate is given a chance to process the ContextConfigurationAttributes for each class in the test class hierarchy and enclosing class hierarchy that is annotated with @ContextConfiguration, and the candidate that supports the merged, processed configuration will be used to actually load the context.

Any reference to an XML-based loader can be interpreted to mean a context loader that supports only XML configuration files or one that supports both XML configuration files and Groovy scripts simultaneously.

Placing an empty @ContextConfiguration annotation on a test class signals that default resource locations (for example, XML configuration files or Groovy scripts) or default configuration classes should be detected. Furthermore, if a specific ContextLoader or SmartContextLoader is not explicitly declared via @ContextConfiguration, a concrete subclass of AbstractDelegatingSmartContextLoader will be used as the default loader, thus providing automatic support for either path-based resource locations (for example, XML configuration files and Groovy scripts) or annotated classes, but not both simultaneously.

A test class may optionally declare neither path-based resource locations nor annotated classes and instead declare only application context initializers. In such cases, an attempt will still be made to detect defaults, but their absence will not result in an exception.

As of Spring Framework 6.0, this class implements AotContextLoader. Consequently, the candidate getXmlLoader() and getAnnotationConfigLoader() must also implement AotContextLoader in order to provide AOT support.

Since:

3.2

Author:

Sam Brannen, Phillip Webb

See Also:

• SmartContextLoader

Constructor Summary

Constructors

Constructor	Description
AbstractDelegatingSmartContextLoader()

Method Summary

Modifier and Type	Method	Description
protected abstract SmartContextLoader	getAnnotationConfigLoader()	Get the delegate SmartContextLoader that supports annotated classes.
protected abstract SmartContextLoader	getXmlLoader()	Get the delegate SmartContextLoader that supports XML configuration files and/or Groovy scripts.
final ApplicationContext	loadContext(MergedContextConfiguration mergedConfig)	Delegates to an appropriate candidate SmartContextLoader to load an ApplicationContext.
final ApplicationContext	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 ApplicationContext	loadContextForAotProcessing(MergedContextConfiguration mergedConfig, RuntimeHints runtimeHints)	Delegates to an appropriate candidate SmartContextLoader to load an ApplicationContext for AOT processing.
final ApplicationContext	loadContextForAotRuntime(MergedContextConfiguration mergedConfig, ApplicationContextInitializer<ConfigurableApplicationContext> initializer)	Delegates to an appropriate candidate SmartContextLoader to load an ApplicationContext for AOT run-time execution.
void	processContextConfiguration(ContextConfigurationAttributes configAttributes)	Delegates to candidate SmartContextLoaders to process the supplied ContextConfigurationAttributes.

Methods inherited from class Object

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

Methods inherited from interface SmartContextLoader

loadContext, processLocations

Constructor Details

AbstractDelegatingSmartContextLoader

public AbstractDelegatingSmartContextLoader()

Method Details

getXmlLoader

protected abstract SmartContextLoader getXmlLoader()

Get the delegate SmartContextLoader that supports XML configuration files and/or Groovy scripts.

getAnnotationConfigLoader

protected abstract SmartContextLoader getAnnotationConfigLoader()

Get the delegate SmartContextLoader that supports annotated classes.

processContextConfiguration

public void processContextConfiguration(ContextConfigurationAttributes configAttributes)

Delegates to candidate SmartContextLoaders to process the supplied ContextConfigurationAttributes.

Delegation is based on explicit knowledge of the implementations of the default loaders for XML configuration files and Groovy scripts and annotated classes. Specifically, the delegation algorithm is as follows:

• If the resource locations or annotated classes in the supplied ContextConfigurationAttributes are not empty, the appropriate candidate loader will be allowed to process the configuration as is, without any checks for detection of defaults.
• Otherwise, the XML-based loader will be allowed to process the configuration in order to detect default resource locations. If the XML-based loader detects default resource locations, an info message will be logged.
• Subsequently, the annotation-based loader will be allowed to process the configuration in order to detect default configuration classes. If the annotation-based loader detects default configuration classes, an info message will be logged.

Specified by:

processContextConfiguration in interface SmartContextLoader

Parameters:

configAttributes - the context configuration attributes to process

Throws:

IllegalArgumentException - if the supplied configuration attributes are null, or if the supplied configuration attributes include both resource locations and annotated classes

IllegalStateException - if the XML-based loader detects default configuration classes; if the annotation-based loader detects default resource locations; if neither candidate loader detects defaults for the supplied context configuration; or if both candidate loaders detect defaults for the supplied context configuration

loadContext

public final ApplicationContext loadContext(MergedContextConfiguration mergedConfig)
                                     throws Exception

Delegates to an appropriate candidate SmartContextLoader to load an ApplicationContext.

Delegation is based on explicit knowledge of the implementations of the default loaders for XML configuration files and Groovy scripts and annotated classes. Specifically, the delegation algorithm is as follows:

• If the resource locations in the supplied MergedContextConfiguration are not empty and the annotated classes are empty, the XML-based loader will load the ApplicationContext.
• If the annotated classes in the supplied MergedContextConfiguration are not empty and the resource locations are empty, the annotation-based loader will load the ApplicationContext.

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:

IllegalStateException - if neither candidate loader is capable of loading an ApplicationContext from the supplied merged context configuration

Exception

See Also:

• SmartContextLoader.processContextConfiguration(ContextConfigurationAttributes)
• AnnotationConfigUtils.registerAnnotationConfigProcessors(org.springframework.beans.factory.support.BeanDefinitionRegistry)
• ConfigurableApplicationContext.getEnvironment()

loadContextForAotProcessing

@Deprecated(since="6.2.4",
            forRemoval=true)
public final ApplicationContext 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

Delegates to an appropriate candidate SmartContextLoader to load an ApplicationContext for AOT processing.

Delegation is based on explicit knowledge of the implementations of the default loaders. See loadContext(MergedContextConfiguration) for details.

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:

IllegalArgumentException - if the supplied merged configuration is null

IllegalStateException - if neither candidate loader is capable of loading an ApplicationContext from the supplied merged context configuration

Exception

Since:

6.0

See Also:

• AotContextLoader.loadContextForAotProcessing(MergedContextConfiguration)

loadContextForAotProcessing

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

Delegates to an appropriate candidate SmartContextLoader to load an ApplicationContext for AOT processing.

Delegation is based on explicit knowledge of the implementations of the default loaders. See loadContext(MergedContextConfiguration) for details.

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:

IllegalArgumentException - if the supplied merged configuration is null

IllegalStateException - if neither candidate loader is capable of loading an ApplicationContext from the supplied merged context configuration

Exception

Since:

6.2.4

See Also:

• AotContextLoader.loadContextForAotProcessing(MergedContextConfiguration, RuntimeHints)

loadContextForAotRuntime

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

Delegates to an appropriate candidate SmartContextLoader to load an ApplicationContext for AOT run-time execution.

Delegation is based on explicit knowledge of the implementations of the default loaders. See loadContext(MergedContextConfiguration) for details.

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:

IllegalStateException - if neither candidate loader is capable of loading an ApplicationContext from the supplied merged context configuration

Exception

Since:

6.0

See Also:

• AotContextLoader.loadContextForAotRuntime(MergedContextConfiguration, ApplicationContextInitializer)