org.ehcache.core.spi.store.tiering

Interface HigherCachingTier.Provider

All Superinterfaces:

Service

Enclosing interface:

HigherCachingTier<K,V>

public static interface HigherCachingTier.Provider
extends Service

Service interface for providing HigherCachingTier instances.

Method Summary

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

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

start, stop

Method Detail

createHigherCachingTier

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

Creates a new HigherCachingTier 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 higher caching tier

releaseHigherCachingTier

void releaseHigherCachingTier(HigherCachingTier<?,?> resource)

Releases a HigherCachingTier.

Parameters:

resource - the higher caching tier to release

Throws:

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

initHigherCachingTier

void initHigherCachingTier(HigherCachingTier<?,?> resource)

Initialises a HigherCachingTier.

Parameters:

resource - the higher caching tier to initialise

rankHigherCachingTier

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

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