org.ehcache.core.spi.service

Interface LocalPersistenceService

All Superinterfaces:

MaintainableService, Service

public interface LocalPersistenceService
extends MaintainableService

Service that provides isolated persistence spaces to any service that requires it under the local root directory.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LocalPersistenceService.SafeSpaceIdentifier Identifier to the logical safe space

Nested classes/interfaces inherited from interface org.ehcache.spi.service.MaintainableService

MaintainableService.MaintenanceScope

Method Summary

Modifier and Type	Method and Description
void	createSafeSpace(LocalPersistenceService.SafeSpaceIdentifier safeSpaceId) Creates the safe space represented by safeSpaceId, if it does not exist in the underlying physical space.
LocalPersistenceService.SafeSpaceIdentifier	createSafeSpaceIdentifier(java.lang.String owner, java.lang.String name) Creates a logical safe directory space for the owner and returns an identifying space Id.
void	destroyAll(java.lang.String owner) Destroys all safe spaces provided to this owner.
void	destroySafeSpace(LocalPersistenceService.SafeSpaceIdentifier safeSpaceId, boolean verbose) Destroys the safe space.
boolean	isClean() Return the cleanliness of the state stored in this service.

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

startForMaintenance

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

start, stop

Method Detail

createSafeSpaceIdentifier

LocalPersistenceService.SafeSpaceIdentifier createSafeSpaceIdentifier(java.lang.String owner,
                                                                      java.lang.String name)

Creates a logical safe directory space for the owner and returns an identifying space Id.

Parameters:

owner - Service owner that owns the safe space.

name - Identifying name for the space.

Returns:

Opaque Identifier that can be used to identify the safe space.

createSafeSpace

void createSafeSpace(LocalPersistenceService.SafeSpaceIdentifier safeSpaceId)
              throws CachePersistenceException

Creates the safe space represented by safeSpaceId, if it does not exist in the underlying physical space.

Parameters:

safeSpaceId - Identifier to the created logical space on which the physical space needs to be created

Throws:

CachePersistenceException - If the space cannot be created or found, due to system errors

destroySafeSpace

void destroySafeSpace(LocalPersistenceService.SafeSpaceIdentifier safeSpaceId,
                      boolean verbose)

Destroys the safe space.

Parameters:

safeSpaceId - Safe space identifier.

verbose - Log more information.

destroyAll

void destroyAll(java.lang.String owner)

Destroys all safe spaces provided to this owner.

Parameters:

owner - owner of safe spaces.

isClean

boolean isClean()

Return the cleanliness of the state stored in this service.

Stored state is assumed to be clean if the service detects that the last started instantiation of this service was shutdown successfully.

Returns:

true if the state is clean

Throws:

java.lang.IllegalStateException - if the service is not started