org.ehcache.spi.service

Interface PersistableResourceService

All Superinterfaces:

MaintainableService, Service

public interface PersistableResourceService
extends MaintainableService

Interface for Services that handle a ResourceType which is persistable.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<ServiceConfiguration<?>>	additionalConfigurationsForPool(java.lang.String alias, ResourcePool pool) Enables this service to add configurations to support the resource pool.
void	create() Creates the persistent storage.
void	destroy(java.lang.String name) Destroys the persistence space with the given name.
void	destroyAll() Destroys all persistence spaces.
boolean	handlesResourceType(ResourceType<?> resourceType) Returns true if this service handles the given resource type.

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

startForMaintenance

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

start, stop

Method Detail

handlesResourceType

boolean handlesResourceType(ResourceType<?> resourceType)

Returns true if this service handles the given resource type.

Parameters:

resourceType - the resource type to check

Returns:

true if this service handles the resource type

additionalConfigurationsForPool

java.util.Collection<ServiceConfiguration<?>> additionalConfigurationsForPool(java.lang.String alias,
                                                                              ResourcePool pool)
                                                                       throws CachePersistenceException

Enables this service to add configurations to support the resource pool.

Parameters:

alias - the alias context

pool - the resource pool

Returns:

a Collection of ServiceConfiguration

Throws:

CachePersistenceException - in case of a persistence related problem

java.lang.IllegalArgumentException - if handlesResourceType(pool.getType) is false

destroy

void destroy(java.lang.String name)
      throws CachePersistenceException

Destroys the persistence space with the given name.

This method can be called without having created the persistence space from this JVM.

Parameters:

name - persistence context name

Throws:

CachePersistenceException - if the persistence space cannot be destroyed

create

void create()
     throws CachePersistenceException

Creates the persistent storage.

Throws:

CachePersistenceException - if the persistence storage cannot be created

destroyAll

void destroyAll()
         throws CachePersistenceException

Destroys all persistence spaces.

Note that this method can be called without having created the persistence spaces from this JVM.

Throws:

CachePersistenceException - if the persistence storage cannot be destroyed