org.ehcache.core.spi.store.tiering

Interface CachingTier.Provider

All Superinterfaces:

Service

Enclosing interface:

CachingTier<K,V>

public static interface CachingTier.Provider
extends Service

Service interface for providing CachingTier instances.

Multiple providers may exist in a single CacheManager.

Method Summary

Modifier and Type	Method and Description
<K,V> CachingTier<K,V>	createCachingTier(Store.Configuration<K,V> storeConfig, ServiceConfiguration<?,?>... serviceConfigs) Creates a new CachingTier instance using the provided configuration
void	initCachingTier(CachingTier<?,?> resource) Initialises a CachingTier.
int	rankCachingTier(java.util.Set<ResourceType<?>> resourceTypes, java.util.Collection<ServiceConfiguration<?,?>> serviceConfigs) Gets the internal ranking for the CachingTier instances provided by this Provider of the caching tier's ability to handle the specified resources.
void	releaseCachingTier(CachingTier<?,?> resource) Releases a CachingTier.

Methods inherited from interface org.ehcache.spi.service.Service

start, stop

Method Detail

createCachingTier

<K,V> CachingTier<K,V> createCachingTier(Store.Configuration<K,V> storeConfig,
                                         ServiceConfiguration<?,?>... serviceConfigs)

Creates a new CachingTier instance using the provided configuration

Type Parameters:

K - the key type for this tier

V - the value type for this tier

Parameters:

storeConfig - the Store configuration

serviceConfigs - a collection of service configurations

Returns:

the new caching tier

releaseCachingTier

void releaseCachingTier(CachingTier<?,?> resource)

Releases a CachingTier.

Parameters:

resource - the caching tier to release

Throws:

java.lang.IllegalArgumentException - if this provider does not know about this caching tier

initCachingTier

void initCachingTier(CachingTier<?,?> resource)

Initialises a CachingTier.

Parameters:

resource - the caching tier to initialise

rankCachingTier

int rankCachingTier(java.util.Set<ResourceType<?>> resourceTypes,
                    java.util.Collection<ServiceConfiguration<?,?>> serviceConfigs)

Gets the internal ranking for the CachingTier instances provided by this Provider of the caching tier's ability to handle the specified resources.

A higher rank value indicates a more capable CachingTier.

Parameters:

resourceTypes - the set of ResourceTypes for the store to handle

serviceConfigs - the collection of ServiceConfiguration instances that may contribute to the ranking

Returns:

a non-negative rank indicating the ability of a CachingTier created by this Provider to handle the resource types specified by resourceTypes; a rank of 0 indicates the caching tier can not handle the type specified in resourceTypes