程序包 cn.taketoday.test.context

接口 CacheAwareContextLoaderDelegate

所有已知实现类:

DefaultCacheAwareContextLoaderDelegate

public interface CacheAwareContextLoaderDelegate

A CacheAwareContextLoaderDelegate is responsible for loading and closing application contexts, interacting transparently with a ContextCache behind the scenes.

Note: CacheAwareContextLoaderDelegate does not extend the ContextLoader or SmartContextLoader interface.

从以下版本开始:

4.0

作者:

Sam Brannen, Harry Yang

字段概要

字段

修饰符和类型	字段	说明
static final String	CONTEXT_FAILURE_THRESHOLD_PROPERTY_NAME	System property used to configure the failure threshold for errors encountered while attempting to load an application context: "infra.test.context.failure.threshold".
static final String	DEFAULT_CACHE_AWARE_CONTEXT_LOADER_DELEGATE_PROPERTY_NAME	System property used to configure the fully qualified class name of the default CacheAwareContextLoaderDelegate.
static final int	DEFAULT_CONTEXT_FAILURE_THRESHOLD	The default failure threshold for errors encountered while attempting to load an application context: 1.

方法概要

修饰符和类型	方法	说明
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.
default boolean	isContextLoaded(MergedContextConfiguration mergedContextConfiguration)	Determine if the application context for the supplied MergedContextConfiguration has been loaded (i.e., is present in the ContextCache).
cn.taketoday.context.ApplicationContext	loadContext(MergedContextConfiguration mergedConfig)	Load the application context for the supplied MergedContextConfiguration by delegating to the ContextLoader configured in the given MergedContextConfiguration.

字段详细资料

DEFAULT_CONTEXT_FAILURE_THRESHOLD

static final int DEFAULT_CONTEXT_FAILURE_THRESHOLD

The default failure threshold for errors encountered while attempting to load an application context: 1.

另请参阅:

• CONTEXT_FAILURE_THRESHOLD_PROPERTY_NAME
• 常量字段值

CONTEXT_FAILURE_THRESHOLD_PROPERTY_NAME

static final String CONTEXT_FAILURE_THRESHOLD_PROPERTY_NAME

System property used to configure the failure threshold for errors encountered while attempting to load an application context: "infra.test.context.failure.threshold".

May alternatively be configured via the TodayStrategies mechanism.

Implementations of CacheAwareContextLoaderDelegate are not required to support this feature. Consult the documentation of the corresponding implementation for details. Note, however, that the standard CacheAwareContextLoaderDelegate implementation in Infra supports this feature.

另请参阅:

• DEFAULT_CONTEXT_FAILURE_THRESHOLD
• loadContext(MergedContextConfiguration)
• 常量字段值

DEFAULT_CACHE_AWARE_CONTEXT_LOADER_DELEGATE_PROPERTY_NAME

static final String DEFAULT_CACHE_AWARE_CONTEXT_LOADER_DELEGATE_PROPERTY_NAME

System property used to configure the fully qualified class name of the default CacheAwareContextLoaderDelegate.

May alternatively be configured via the TodayStrategies mechanism.

If this property is not defined, the DefaultCacheAwareContextLoaderDelegate will be used as the default.

另请参阅:

• 常量字段值

方法详细资料

isContextLoaded

default boolean isContextLoaded(MergedContextConfiguration mergedContextConfiguration)

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 Infra overrides this method appropriately.

参数:

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

返回:

true if the application context has been loaded

另请参阅:

• loadContext(cn.taketoday.test.context.MergedContextConfiguration)
• closeContext(cn.taketoday.test.context.MergedContextConfiguration, cn.taketoday.test.annotation.DirtiesContext.HierarchyMode)

loadContext

cn.taketoday.context.ApplicationContext loadContext(MergedContextConfiguration mergedConfig)

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.

Implementations of this method should load ApplicationContextFailureProcessor implementations via the TodayStrategies mechanism, catch any exception thrown by the ContextLoader, and delegate to each of the configured failure processors to process the context load failure if the exception is an instance of ContextLoadException.

Implementations of this method are encouraged to support the failure threshold feature. Specifically, if repeated attempts are made to load an application context and that application context consistently fails to load — for example, due to a configuration error that prevents the context from successfully loading — this method should preemptively throw an IllegalStateException if the configured failure threshold has been exceeded. Note that the ContextCache provides support for tracking and incrementing the failure count for a given context cache key.

The cache statistics should be logged by invoking ContextCache.logStatistics().

参数:

mergedConfig - the merged context configuration to use to load the application context; never null

返回:

the application context (never null)

抛出:

IllegalStateException - if an error occurs while retrieving or loading the application context

另请参阅:

• isContextLoaded(cn.taketoday.test.context.MergedContextConfiguration)
• closeContext(cn.taketoday.test.context.MergedContextConfiguration, cn.taketoday.test.annotation.DirtiesContext.HierarchyMode)

closeContext

void closeContext(MergedContextConfiguration mergedContextConfiguration,
 @Nullable
 DirtiesContext.HierarchyMode hierarchyMode)

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.

参数:

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

另请参阅:

• isContextLoaded(cn.taketoday.test.context.MergedContextConfiguration)
• loadContext(cn.taketoday.test.context.MergedContextConfiguration)