Class AbstractDelegatingSmartContextLoader
- All Implemented Interfaces:
ContextLoader
,SmartContextLoader
- Direct Known Subclasses:
DelegatingSmartContextLoader
,WebDelegatingSmartContextLoader
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 (e.g., 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
(e.g., XML configuration files and Groovy scripts) or annotated classes,
but not both simultaneously.
As of Spring 3.2, 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.
- Since:
- 3.2
- Author:
- Sam Brannen, Phillip Webb
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract SmartContextLoader
Get the delegateSmartContextLoader
that supports annotated classes.protected abstract SmartContextLoader
Get the delegateSmartContextLoader
that supports XML configuration files and/or Groovy scripts.final ApplicationContext
loadContext
(String... locations) AbstractDelegatingSmartContextLoader
does not support theContextLoader.loadContext(String...)
method.loadContext
(MergedContextConfiguration mergedConfig) Delegates to an appropriate candidateSmartContextLoader
to load anApplicationContext
.void
processContextConfiguration
(ContextConfigurationAttributes configAttributes) Delegates to candidateSmartContextLoaders
to process the suppliedContextConfigurationAttributes
.final String[]
processLocations
(Class<?> clazz, String... locations) AbstractDelegatingSmartContextLoader
does not support theContextLoader.processLocations(Class, String...)
method.
-
Constructor Details
-
AbstractDelegatingSmartContextLoader
public AbstractDelegatingSmartContextLoader()
-
-
Method Details
-
getXmlLoader
Get the delegateSmartContextLoader
that supports XML configuration files and/or Groovy scripts. -
getAnnotationConfigLoader
Get the delegateSmartContextLoader
that supports annotated classes. -
processLocations
AbstractDelegatingSmartContextLoader
does not support theContextLoader.processLocations(Class, String...)
method. CallprocessContextConfiguration(ContextConfigurationAttributes)
instead.- Specified by:
processLocations
in interfaceContextLoader
- Parameters:
clazz
- the class with which the locations are associated: used to determine how to process the supplied locationslocations
- the unmodified locations to use for loading the application context (can benull
or empty)- Returns:
- an array of application context resource locations
- Throws:
UnsupportedOperationException
- in this implementation
-
loadContext
AbstractDelegatingSmartContextLoader
does not support theContextLoader.loadContext(String...)
method. CallloadContext(MergedContextConfiguration)
instead.- Specified by:
loadContext
in interfaceContextLoader
- Parameters:
locations
- the resource locations to use to load the application context- Returns:
- a new application context
- Throws:
UnsupportedOperationException
- in this implementationException
- if context loading failed
-
processContextConfiguration
Delegates to candidateSmartContextLoaders
to process the suppliedContextConfigurationAttributes
.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 interfaceSmartContextLoader
- Parameters:
configAttributes
- the context configuration attributes to process- Throws:
IllegalArgumentException
- if the supplied configuration attributes arenull
, or if the supplied configuration attributes include both resource locations and annotated classesIllegalStateException
- 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
- If the resource locations or annotated classes in the supplied
-
loadContext
Delegates to an appropriate candidateSmartContextLoader
to load anApplicationContext
.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 theApplicationContext
. - If the annotated classes in the supplied
MergedContextConfiguration
are not empty and the resource locations are empty, the annotation-based loader will load theApplicationContext
.
- Specified by:
loadContext
in interfaceSmartContextLoader
- 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 isnull
IllegalStateException
- if neither candidate loader is capable of loading anApplicationContext
from the supplied merged context configurationException
- if context loading failed- See Also:
- If the resource locations in the supplied
-