com.atlassian.vcache.internal

Interface VCacheLifecycleManager

All Known Implementing Classes:

AbstractVCacheService, GuavaVCacheService, LegacyVCacheService, MemcachedVCacheService, RedisVCacheService

public interface VCacheLifecycleManager

The lifecycle management interface that contains methods that need to be called, by the host application, at different stages.

Handlers need to be provided that are called whenever a cache is about to be configured by the VCache implementation. Using these hooks, the host application can:

• Override the current cache settings. For example, enforcing an application wide maximum timeout.
• Log a warning (or whatever) based on it's policy (e.g. an unknown JvmCache is being created.
• Prevent a cache from being created, based on it's policy, by throwing a RuntimeException. The VCache implementation will propagate these exceptions to the original caller.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
RequestMetrics	metrics(RequestContext context) Return the cache metrics for the supplied context.
Set<String>	transactionDiscard(RequestContext context) Discard the TransactionalExternalCache's that are associated with the supplied context.
void	transactionSync(RequestContext context) Synchronise the TransactionalExternalCache's that are associated with the supplied context.

Method Detail

transactionSync

void transactionSync(RequestContext context)

Synchronise the TransactionalExternalCache's that are associated with the supplied context.

Parameters:

context - the request context to synchronise.

transactionDiscard

Set<String> transactionDiscard(RequestContext context)

Discard the TransactionalExternalCache's that are associated with the supplied context.

Parameters:

context - the request context to discard.

Returns:

names of the caches that have operations being discarded.

metrics

RequestMetrics metrics(RequestContext context)

Return the cache metrics for the supplied context.

Parameters:

context - the request context to obtain metrics for.

Returns:

the cache metrics for the request