Package org.springframework.test.context.aot

Interface AotContextLoader

All Superinterfaces:

ContextLoader, SmartContextLoader

All Known Implementing Classes:

AbstractDelegatingSmartContextLoader, AbstractGenericContextLoader, AbstractGenericWebContextLoader, AnnotationConfigContextLoader, AnnotationConfigWebContextLoader, DelegatingSmartContextLoader, GenericGroovyXmlContextLoader, GenericGroovyXmlWebContextLoader, GenericXmlContextLoader, GenericXmlWebContextLoader, WebDelegatingSmartContextLoader

public interface AotContextLoader
extends SmartContextLoader

Strategy interface for loading an ApplicationContext for build-time AOT processing as well as run-time AOT execution for an integration test managed by the Spring TestContext Framework.

AotContextLoader is an extension of the SmartContextLoader SPI that allows a context loader to optionally provide ahead-of-time (AOT) support.

As of Spring Framework 6.0, AOT infrastructure requires that an AotContextLoader create a GenericApplicationContext for both build-time processing and run-time execution.

Since:

6.0

Author:

Sam Brannen

Method Summary

Modifier and Type	Method	Description
ApplicationContext	loadContextForAotProcessing(MergedContextConfiguration mergedConfig)	Load a new ApplicationContext for AOT build-time processing based on the supplied MergedContextConfiguration, configure the context, and return the context.
ApplicationContext	loadContextForAotRuntime(MergedContextConfiguration mergedConfig, ApplicationContextInitializer<ConfigurableApplicationContext> initializer)	Load a new ApplicationContext for AOT run-time execution based on the supplied MergedContextConfiguration and ApplicationContextInitializer.

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

loadContext, loadContext, processContextConfiguration, processLocations

Method Details

loadContextForAotProcessing

ApplicationContext loadContextForAotProcessing(MergedContextConfiguration mergedConfig)
                                        throws Exception

Load a new ApplicationContext for AOT build-time processing based on the supplied MergedContextConfiguration, configure the context, and return the context.

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

Parameters:

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

Returns:

a new GenericApplicationContext

Throws:

Exception - if context loading failed

See Also:

• loadContextForAotRuntime(MergedContextConfiguration, ApplicationContextInitializer)

loadContextForAotRuntime

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

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

This method must instantiate, initialize, and refresh the ApplicationContext.

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 GenericApplicationContext

Throws:

Exception - if context loading failed

See Also:

• loadContextForAotProcessing(MergedContextConfiguration)