Class DefaultCacheAwareContextLoaderDelegate

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 Exception

  Load the ApplicationContext for the supplied merged context configuration.

  Supports both the SmartContextLoader and ContextLoader SPIs.

  Throws:

  Exception - if an error occurs while loading the application context

• isContextLoaded

  public boolean isContextLoaded​(MergedContextConfiguration mergedContextConfiguration)

  Description copied from interface: CacheAwareContextLoaderDelegate
  Determine if the application context for the supplied MergedContextConfiguration has been loaded (i.e., is present in the ContextCache).

  Implementations of this method must not load the application context as a side effect. In addition, implementations of this method should not log the cache statistics via ContextCache.logStatistics().

  The default implementation of this method always returns false. Custom CacheAwareContextLoaderDelegate implementations are therefore highly encouraged to override this method with a more meaningful implementation. Note that the standard CacheAwareContextLoaderDelegate implementation in Spring overrides this method appropriately.

  Specified by:

  isContextLoaded in interface CacheAwareContextLoaderDelegate

  Parameters:

  mergedContextConfiguration - the merged context configuration used to load the application context; never null

  Returns:

  true if the application context has been loaded

  See Also:

  CacheAwareContextLoaderDelegate.loadContext(org.springframework.test.context.MergedContextConfiguration), CacheAwareContextLoaderDelegate.closeContext(org.springframework.test.context.MergedContextConfiguration, org.springframework.test.annotation.DirtiesContext.HierarchyMode)

• 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 (never null)

  See Also:

  CacheAwareContextLoaderDelegate.isContextLoaded(org.springframework.test.context.MergedContextConfiguration), CacheAwareContextLoaderDelegate.closeContext(org.springframework.test.context.MergedContextConfiguration, org.springframework.test.annotation.DirtiesContext.HierarchyMode)

• 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

  See Also:

  CacheAwareContextLoaderDelegate.isContextLoaded(org.springframework.test.context.MergedContextConfiguration), CacheAwareContextLoaderDelegate.loadContext(org.springframework.test.context.MergedContextConfiguration)