org.ehcache.core.spi.store

Interface Store.Provider

All Superinterfaces:

org.ehcache.spi.service.Service

All Known Subinterfaces:

Store.ElementalProvider

All Known Implementing Classes:

AbstractWrapperStoreProvider

Enclosing interface:

Store<K,V>

public static interface Store.Provider
extends org.ehcache.spi.service.Service

The Service used to create Stores. Implementation of Store.Provider have to be thread-safe.

Method Summary

Modifier and Type	Method and Description
<K,V> Store<K,V>	createStore(Store.Configuration<K,V> storeConfig, org.ehcache.spi.service.ServiceConfiguration<?,?>... serviceConfigs) Creates a new Store instance
void	initStore(Store<?,?> resource) Informs this Provider, a Store it created is being initialized
int	rank(java.util.Set<org.ehcache.config.ResourceType<?>> resourceTypes, java.util.Collection<org.ehcache.spi.service.ServiceConfiguration<?,?>> serviceConfigs) Gets the internal ranking for the Store instances provided by this Provider of the store's ability to handle the specified resources.
void	releaseStore(Store<?,?> resource) Informs this Provider, a Store it created is being disposed (i.e.

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

start, stop

Method Detail

createStore

<K,V> Store<K,V> createStore(Store.Configuration<K,V> storeConfig,
                             org.ehcache.spi.service.ServiceConfiguration<?,?>... serviceConfigs)

Creates a new Store instance

Parameters:

storeConfig - the basic configuration for the Store

serviceConfigs - the configurations the Provider may need to configure the Store

Returns:

the Store honoring the configurations passed in

releaseStore

void releaseStore(Store<?,?> resource)

Informs this Provider, a Store it created is being disposed (i.e. closed)

Parameters:

resource - the store to release

initStore

void initStore(Store<?,?> resource)

Informs this Provider, a Store it created is being initialized

Parameters:

resource - the store to initialize

rank

int rank(java.util.Set<org.ehcache.config.ResourceType<?>> resourceTypes,
         java.util.Collection<org.ehcache.spi.service.ServiceConfiguration<?,?>> serviceConfigs)

Gets the internal ranking for the Store instances provided by this Provider of the store's ability to handle the specified resources. A higher rank value indicates a more capable Store.

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 Store created by this Provider to handle the resource types specified by resourceTypes; a rank of 0 indicates the store can not handle all types specified in resourceTypes