org.ehcache.core.spi.store.tiering

Interface LowerCachingTier.Provider

All Superinterfaces:

Service

Enclosing interface:

LowerCachingTier<K,V>

public static interface LowerCachingTier.Provider
extends Service

Service interface for providing LowerCachingTier instances.

Method Summary

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

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

start, stop

Method Detail

createCachingTier

<K,V> LowerCachingTier<K,V> createCachingTier(java.util.Set<ResourceType<?>> resourceTypes,
                                              Store.Configuration<K,V> storeConfig,
                                              ServiceConfiguration<?,?>... serviceConfigs)

Creates a new LowerCachingTier 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 lower caching tier

releaseCachingTier

void releaseCachingTier(LowerCachingTier<?,?> resource)

Releases a LowerCachingTier.

Parameters:

resource - the lower caching tier to release

Throws:

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

initCachingTier

void initCachingTier(LowerCachingTier<?,?> resource)

Initialises a LowerCachingTier.

Parameters:

resource - the lower caching tier to initialise

rankLowerCachingTier

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

Gets the internal ranking for the LowerCachingTier 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