DefaultCacheAwareContextLoaderDelegate (Spring Framework 5.1.0.RELEASE API)

java.lang.Object
- org.springframework.test.context.cache.DefaultCacheAwareContextLoaderDelegate

All Implemented Interfaces:

CacheAwareContextLoaderDelegate
```
public class DefaultCacheAwareContextLoaderDelegate
extends java.lang.Object
implements CacheAwareContextLoaderDelegate
```
Default implementation of the CacheAwareContextLoaderDelegate interface.
To use a static DefaultContextCache, invoke the DefaultCacheAwareContextLoaderDelegate() constructor; otherwise, invoke the DefaultCacheAwareContextLoaderDelegate(ContextCache) and provide a custom ContextCache implementation.

Since:

4.1

Author:

Sam Brannen

Constructor Summary

Constructors
Constructor and Description
`DefaultCacheAwareContextLoaderDelegate()` Construct a new `DefaultCacheAwareContextLoaderDelegate` using a static `DefaultContextCache`.
`DefaultCacheAwareContextLoaderDelegate(ContextCache contextCache)` Construct a new `DefaultCacheAwareContextLoaderDelegate` using the supplied `ContextCache`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`closeContext(MergedContextConfiguration mergedContextConfiguration, DirtiesContext.HierarchyMode hierarchyMode)` Remove the application context for the supplied `MergedContextConfiguration` from the `ContextCache` and close it if it is an instance of `ConfigurableApplicationContext`.
`protected ContextCache`	`getContextCache()` Get the `ContextCache` used by this context loader delegate.
`ApplicationContext`	`loadContext(MergedContextConfiguration mergedContextConfiguration)` Load the application context for the supplied `MergedContextConfiguration` by delegating to the `ContextLoader` configured in the given `MergedContextConfiguration`.
`protected ApplicationContext`	`loadContextInternal(MergedContextConfiguration mergedContextConfiguration)` Load the `ApplicationContext` for the supplied merged context configuration.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultCacheAwareContextLoaderDelegate
```
public DefaultCacheAwareContextLoaderDelegate()
```
    Construct a new DefaultCacheAwareContextLoaderDelegate using a static DefaultContextCache.
    This default cache is static so that each context can be cached and reused for all subsequent tests that declare the same unique context configuration within the same JVM process.
    
    See Also:
    
    DefaultCacheAwareContextLoaderDelegate(ContextCache)
  - DefaultCacheAwareContextLoaderDelegate
```
public DefaultCacheAwareContextLoaderDelegate(ContextCache contextCache)
```
    Construct a new DefaultCacheAwareContextLoaderDelegate using the supplied ContextCache.
    
    See Also:
    
    DefaultCacheAwareContextLoaderDelegate()
- Method Detail
  - getContextCache
```
protected ContextCache getContextCache()
```
    Get the ContextCache used by this context loader delegate.
  - loadContextInternal
```
protected ApplicationContext loadContextInternal(MergedContextConfiguration mergedContextConfiguration)
                                          throws java.lang.Exception
```
    Load the ApplicationContext for the supplied merged context configuration.
    Supports both the SmartContextLoader and ContextLoader SPIs.
    
    Throws:
    
    java.lang.Exception - if an error occurs while loading the application context
  - loadContext
```
public ApplicationContext loadContext(MergedContextConfiguration mergedContextConfiguration)
```
    Description copied from interface: CacheAwareContextLoaderDelegate
    
    Load the application context for the supplied MergedContextConfiguration by delegating to the ContextLoader configured in the given MergedContextConfiguration.
    If the context is present in the ContextCache it will simply be returned; otherwise, it will be loaded, stored in the cache, and returned.
    The cache statistics should be logged by invoking ContextCache.logStatistics().
    
    Specified by:
    
    loadContext in interface CacheAwareContextLoaderDelegate
    
    Parameters:
    
    mergedContextConfiguration - the merged context configuration to use to load the application context; never null
    
    Returns:
    
    the application context
  - closeContext
```
public void closeContext(MergedContextConfiguration mergedContextConfiguration,
                         @Nullable
                         DirtiesContext.HierarchyMode hierarchyMode)
```
    Description copied from interface: CacheAwareContextLoaderDelegate
    
    Remove the application context for the supplied MergedContextConfiguration from the ContextCache and close it if it is an instance of ConfigurableApplicationContext.
    The semantics of the supplied HierarchyMode must be honored when removing the context from the cache. See the Javadoc for DirtiesContext.HierarchyMode for details.
    Generally speaking, this method should only be called if the state of a singleton bean has been changed (potentially affecting future interaction with the context) or if the context needs to be prematurely removed from the cache.
    
    Specified by:
    
    closeContext in interface CacheAwareContextLoaderDelegate
    
    Parameters:
    
    mergedContextConfiguration - the merged context configuration for the application context to close; never null
    
    hierarchyMode - the hierarchy mode; may be null if the context is not part of a hierarchy

Class DefaultCacheAwareContextLoaderDelegate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultCacheAwareContextLoaderDelegate

DefaultCacheAwareContextLoaderDelegate

Method Detail

getContextCache

loadContextInternal

loadContext

closeContext