Package org.springframework.test.context.web

Class AbstractGenericWebContextLoader

java.lang.Object

org.springframework.test.context.support.AbstractContextLoader

org.springframework.test.context.web.AbstractGenericWebContextLoader

All Implemented Interfaces:

AotContextLoader, ContextLoader, SmartContextLoader

Direct Known Subclasses:

AnnotationConfigWebContextLoader, GenericXmlWebContextLoader

public abstract class AbstractGenericWebContextLoader
extends AbstractContextLoader
implements AotContextLoader

Abstract, generic extension of AbstractContextLoader that loads a GenericWebApplicationContext.

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. Note that AbstractGenericWebContextLoader does not support the loadContext(String... locations) method from the legacy ContextLoader SPI.

Concrete subclasses must provide an appropriate implementation of loadBeanDefinitions(org.springframework.web.context.support.GenericWebApplicationContext, org.springframework.test.context.web.WebMergedContextConfiguration).

Since:

3.2

Author:

Sam Brannen, Phillip Webb

See Also:

• loadContext(MergedContextConfiguration)
• loadContext(String...)

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Log	logger

Constructor Summary

Constructors

Constructor	Description
AbstractGenericWebContextLoader()

Method Summary

Modifier and Type	Method	Description
protected void	configureWebResources(GenericWebApplicationContext context, WebMergedContextConfiguration webMergedConfig)	Configures web resources for the supplied web application context (WAC).
protected GenericWebApplicationContext	createContext()	Factory method for creating the GenericWebApplicationContext used by this ContextLoader.
protected void	customizeBeanFactory(DefaultListableBeanFactory beanFactory, WebMergedContextConfiguration webMergedConfig)	Customize the internal bean factory of the WebApplicationContext created by this context loader.
protected void	customizeContext(GenericWebApplicationContext context, WebMergedContextConfiguration webMergedConfig)	Customize the GenericWebApplicationContext created by this context loader after bean definitions have been loaded into the context but before the context is refreshed.
protected abstract void	loadBeanDefinitions(GenericWebApplicationContext context, WebMergedContextConfiguration webMergedConfig)	Load bean definitions into the supplied context from the locations or classes in the supplied WebMergedContextConfiguration.
final ApplicationContext	loadContext(String... locations)	AbstractGenericWebContextLoader should be used as a SmartContextLoader, not as a legacy ContextLoader.
final ApplicationContext	loadContext(MergedContextConfiguration mergedConfig)	Load a GenericWebApplicationContext for the supplied MergedContextConfiguration.
final GenericWebApplicationContext	loadContextForAotProcessing(MergedContextConfiguration mergedConfig)	Load a GenericWebApplicationContext for AOT build-time processing based on the supplied MergedContextConfiguration.
final GenericWebApplicationContext	loadContextForAotRuntime(MergedContextConfiguration mergedConfig, ApplicationContextInitializer<ConfigurableApplicationContext> initializer)	Load a GenericWebApplicationContext for AOT run-time execution based on the supplied MergedContextConfiguration and ApplicationContextInitializer.
protected void	validateMergedContextConfiguration(WebMergedContextConfiguration mergedConfig)	Validate the supplied WebMergedContextConfiguration 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

AbstractGenericWebContextLoader

public AbstractGenericWebContextLoader()

Method Details

loadContext

public final ApplicationContext loadContext(MergedContextConfiguration mergedConfig)
                                     throws Exception

Load a GenericWebApplicationContext for the supplied MergedContextConfiguration.

Implementation details:

• Calls validateMergedContextConfiguration(WebMergedContextConfiguration) to allow subclasses to validate the supplied configuration before proceeding.
• Creates a GenericWebApplicationContext 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.
• Delegates to configureWebResources(org.springframework.web.context.support.GenericWebApplicationContext, org.springframework.test.context.web.WebMergedContextConfiguration) to create the MockServletContext and set it in the WebApplicationContext.
• Calls AbstractContextLoader.prepareContext(org.springframework.context.ConfigurableApplicationContext, org.springframework.test.context.MergedContextConfiguration) to allow for customizing the context before bean definitions are loaded.
• Calls customizeBeanFactory(org.springframework.beans.factory.support.DefaultListableBeanFactory, org.springframework.test.context.web.WebMergedContextConfiguration) to allow for customizing the context's DefaultListableBeanFactory.
• Delegates to loadBeanDefinitions(org.springframework.web.context.support.GenericWebApplicationContext, org.springframework.test.context.web.WebMergedContextConfiguration) to populate the context from the locations or classes in the supplied MergedContextConfiguration.
• Delegates to AnnotationConfigUtils for registering annotation configuration processors.
• Calls customizeContext(org.springframework.web.context.support.GenericWebApplicationContext, org.springframework.test.context.web.WebMergedContextConfiguration) 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 web application context

Throws:

ContextLoadException - if context loading failed

Exception

See Also:

• SmartContextLoader.loadContext(MergedContextConfiguration)

loadContextForAotProcessing

public final GenericWebApplicationContext loadContextForAotProcessing(MergedContextConfiguration mergedConfig)
                                                               throws Exception

Load a GenericWebApplicationContext 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 web application context

Throws:

Exception - if context loading failed

Since:

6.0

See Also:

• AotContextLoader.loadContextForAotProcessing(MergedContextConfiguration)

loadContextForAotRuntime

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

Load a GenericWebApplicationContext 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 web application context

Throws:

Exception - if context loading failed

Since:

6.0

See Also:

• AotContextLoader.loadContextForAotRuntime(MergedContextConfiguration, ApplicationContextInitializer)

validateMergedContextConfiguration

protected void validateMergedContextConfiguration(WebMergedContextConfiguration mergedConfig)

Validate the supplied WebMergedContextConfiguration 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

createContext

protected GenericWebApplicationContext createContext()

Factory method for creating the GenericWebApplicationContext used by this ContextLoader.

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

Returns:

a newly instantiated GenericWebApplicationContext

Since:

5.3.23

configureWebResources

protected void configureWebResources(GenericWebApplicationContext context,
 WebMergedContextConfiguration webMergedConfig)

Configures web resources for the supplied web application context (WAC).

Implementation Details

If the supplied WAC has no parent or its parent is not a WAC, the supplied WAC will be configured as the Root WAC (see "Root WAC Configuration" below).

Otherwise the context hierarchy of the supplied WAC will be traversed to find the top-most WAC (i.e., the root); and the ServletContext of the Root WAC will be set as the ServletContext for the supplied WAC.

Root WAC Configuration

• The resource base path is retrieved from the supplied WebMergedContextConfiguration.
• A ResourceLoader is instantiated for the MockServletContext: if the resource base path is prefixed with "classpath:", a DefaultResourceLoader will be used; otherwise, a FileSystemResourceLoader will be used.
• A MockServletContext will be created using the resource base path and resource loader.
• The supplied GenericWebApplicationContext is then stored in the MockServletContext under the WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE key.
• Finally, the MockServletContext is set in the WebApplicationContext.

Parameters:

context - the web application context for which to configure the web resources

webMergedConfig - the merged context configuration to use to load the web application context

customizeBeanFactory

protected void customizeBeanFactory(DefaultListableBeanFactory beanFactory,
 WebMergedContextConfiguration webMergedConfig)

Customize the internal bean factory of the WebApplicationContext created by this context loader.

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 context loader

webMergedConfig - the merged context configuration to use to load the web application context

See Also:

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

loadBeanDefinitions

protected abstract void loadBeanDefinitions(GenericWebApplicationContext context,
 WebMergedContextConfiguration webMergedConfig)

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

Concrete subclasses must provide an appropriate implementation.

Parameters:

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

webMergedConfig - the merged context configuration to use to load the web application context

See Also:

• loadContext(MergedContextConfiguration)

customizeContext

protected void customizeContext(GenericWebApplicationContext context,
 WebMergedContextConfiguration webMergedConfig)

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

The default implementation simply delegates to AbstractContextLoader.customizeContext(ConfigurableApplicationContext, MergedContextConfiguration).

Parameters:

context - the newly created web application context

webMergedConfig - the merged context configuration to use to load the web application context

See Also:

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

loadContext

public final ApplicationContext loadContext(String... locations)
                                     throws Exception

AbstractGenericWebContextLoader should be used as a SmartContextLoader, not as a legacy ContextLoader. Consequently, this method is not supported.

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:

UnsupportedOperationException - in this implementation

Exception - if context loading failed

See Also:

• ContextLoader.loadContext(java.lang.String[])