com.atlassian.vcache.internal

Interface VCacheLifecycleManager

All Known Subinterfaces:

PartitionAwareVCacheLifecycleManager, PartitionlessVCacheLifecycleManager

public interface VCacheLifecycleManager

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

Handlers need to be provided to applicationSetup(String, Function, Function). These handlers 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 time-to-live.
• 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
void	applicationSetup(String productIdentifier, Function<JvmCacheDetails,JvmCacheSettings> jvmCacheCreationHandler, Function<ExternalCacheDetails,ExternalCacheSettings> externalCacheCreationHandler) To be called when the host application is being setup.
void	applicationTeardown() To be called when the host application is being shutdown.
int	currentRequestCount() Returns the current number of requests in progress.
boolean	isRequestInProgress() Returns whether a request is currently in progress for this thread.
CacheMetrics	requestTeardown() To be called after a thread has performed a request (unit of work).

Method Detail

applicationSetup

void applicationSetup(String productIdentifier,
                      Function<JvmCacheDetails,JvmCacheSettings> jvmCacheCreationHandler,
                      Function<ExternalCacheDetails,ExternalCacheSettings> externalCacheCreationHandler)

To be called when the host application is being setup. It should only be called once.

Throws:

IllegalStateException - if this method is called multiple times.

applicationTeardown

void applicationTeardown()

To be called when the host application is being shutdown. This method will block until there are more executing requests, before shutting down. This method should only be called once. If the caller does not want to block, then call currentRequestCount() beforehand to check whether any requests are currently in progress.

currentRequestCount

int currentRequestCount()

Returns the current number of requests in progress.

Returns:

the current number of requests in progress.

isRequestInProgress

boolean isRequestInProgress()

Returns whether a request is currently in progress for this thread.

Returns:

whether a request is currently in progress for this thread.

requestTeardown

@Nonnull
CacheMetrics requestTeardown()

To be called after a thread has performed a request (unit of work). Duplicate calls are ignored (a warning may be logged by the implementation).

Returns:

the cache metrics for the request