org.ehcache.core.spi.store

Class AbstractWrapperStoreProvider

java.lang.Object

org.ehcache.core.spi.store.AbstractWrapperStoreProvider

All Implemented Interfaces:

Store.Provider, Service

public abstract class AbstractWrapperStoreProvider
extends java.lang.Object
implements Store.Provider

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWrapperStoreProvider(java.lang.Class<? extends ServiceConfiguration<?,?>>... requiredConfigurationTypes)

Method Summary

Modifier and Type	Method and Description
<K,V> Store<K,V>	createStore(Store.Configuration<K,V> storeConfig, ServiceConfiguration<?,?>... serviceConfigs) Creates a new Store instance
protected Store.Provider	getUnderlyingStoreProvider(java.util.Set<ResourceType<?>> resources, java.util.List<ServiceConfiguration<?,?>> configs)
void	initStore(Store<?,?> resource) Informs this Provider, a Store it created is being initialized
int	rank(java.util.Set<ResourceType<?>> resourceTypes, java.util.Collection<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.
void	start(ServiceProvider<Service> serviceProvider) Start this service using the provided configuration and ServiceProvider.
void	stop() Stops this service.
protected abstract <K,V> Store<K,V>	wrap(Store<K,V> store, Store.Configuration<K,V> storeConfig, ServiceConfiguration<?,?>... serviceConfigs)
protected int	wrapperPriority()
protected abstract int	wrapperRank()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractWrapperStoreProvider

@SafeVarargs
protected AbstractWrapperStoreProvider(java.lang.Class<? extends ServiceConfiguration<?,?>>... requiredConfigurationTypes)

Method Detail

createStore

public <K,V> Store<K,V> createStore(Store.Configuration<K,V> storeConfig,
                                    ServiceConfiguration<?,?>... serviceConfigs)

Description copied from interface: Store.Provider

Creates a new Store instance

Specified by:

createStore in interface Store.Provider

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

getUnderlyingStoreProvider

protected Store.Provider getUnderlyingStoreProvider(java.util.Set<ResourceType<?>> resources,
                                                    java.util.List<ServiceConfiguration<?,?>> configs)

rank

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

Description copied from interface: Store.Provider

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.

Specified by:

rank in interface Store.Provider

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

wrapperRank

protected abstract int wrapperRank()

wrapperPriority

protected int wrapperPriority()

wrap

protected abstract <K,V> Store<K,V> wrap(Store<K,V> store,
                                         Store.Configuration<K,V> storeConfig,
                                         ServiceConfiguration<?,?>... serviceConfigs)

releaseStore

public void releaseStore(Store<?,?> resource)

Description copied from interface: Store.Provider

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

Specified by:

releaseStore in interface Store.Provider

Parameters:

resource - the store to release

initStore

public void initStore(Store<?,?> resource)

Description copied from interface: Store.Provider

Informs this Provider, a Store it created is being initialized

Specified by:

initStore in interface Store.Provider

Parameters:

resource - the store to initialize

start

public void start(ServiceProvider<Service> serviceProvider)

Description copied from interface: Service

Start this service using the provided configuration and ServiceProvider.

The service provider allows a service to retrieve and use other services.

A Service retrieved at this stage may not yet be started. The recommended usage pattern therefore, is to keep a reference to the dependent Service but use it only when specific methods are invoked on subtypes.

Specified by:

start in interface Service

Parameters:

serviceProvider - the service provider

stop

public void stop()

Description copied from interface: Service

Stops this service.

Specified by:

stop in interface Service