com.atlassian.vcache.internal

Interface VCacheCreationHandler

All Known Implementing Classes:

DefaultVCacheCreationHandler

public interface VCacheCreationHandler

Specifies the interface for a handler that is called before a cache is created.

The implementation is passed the proposed cache details and must return the ultimate cache settings that will be used. None of the returned settings are allowed to be Optional.empty(). The implementation should throw a VCacheException if the cache should not be created.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
ExternalCacheSettings	externalCacheCreation(ExternalCacheDetails details) Validates the settings for a ExternalCache.
JvmCacheSettings	jvmCacheCreation(JvmCacheDetails details) Validates the settings for a JvmCache.
void	requestCacheCreation(String name) Validates the settings for a RequestCache.

Method Detail

jvmCacheCreation

JvmCacheSettings jvmCacheCreation(JvmCacheDetails details)
                           throws VCacheException

Validates the settings for a JvmCache.

Parameters:

details - the proposed details for the cache.

Returns:

the complete settings to be used.

Throws:

VCacheException - if the cache should not be created

requestCacheCreation

void requestCacheCreation(String name)

Validates the settings for a RequestCache.

Parameters:

name - the proposed name for the cache.

Throws:

VCacheException - if the cache should not be created

externalCacheCreation

ExternalCacheSettings externalCacheCreation(ExternalCacheDetails details)

Validates the settings for a ExternalCache.

Parameters:

details - the proposed details for the cache.

Returns:

the complete settings to be used.

Throws:

VCacheException - if the cache should not be created