|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PersistableResourceService
Interface for Service
s that handle a ResourceType
which is
persistable
.
Nested Class Summary | |
---|---|
static interface |
PersistableResourceService.PersistenceSpaceIdentifier<T extends PersistableResourceService>
An identifier for an existing persistable resource. |
Method Summary | |
---|---|
void |
destroy(java.lang.String name)
Destroys the persistence space with the given name. |
void |
destroyAll()
Destroys all persistence spaces. |
PersistableResourceService.PersistenceSpaceIdentifier<?> |
getPersistenceSpaceIdentifier(java.lang.String name,
CacheConfiguration<?,?> config)
Returns a PersistableResourceService.PersistenceSpaceIdentifier for the space associated to the provided arguments. |
StateRepository |
getStateRepositoryWithin(PersistableResourceService.PersistenceSpaceIdentifier<?> identifier,
java.lang.String name)
Returns a named state repository in the context of the given
identifier . |
boolean |
handlesResourceType(ResourceType<?> resourceType)
Returns true if this service handles the given resource type. |
void |
releasePersistenceSpaceIdentifier(PersistableResourceService.PersistenceSpaceIdentifier<?> identifier)
Releases a previously obtained PersistableResourceService.PersistenceSpaceIdentifier . |
Methods inherited from interface org.ehcache.spi.service.MaintainableService |
---|
startForMaintenance |
Methods inherited from interface org.ehcache.spi.service.Service |
---|
start, stop |
Method Detail |
---|
boolean handlesResourceType(ResourceType<?> resourceType)
true
if this service handles the given resource type.
resourceType
- the resource type to check
true
if this service handles the resource typePersistableResourceService.PersistenceSpaceIdentifier<?> getPersistenceSpaceIdentifier(java.lang.String name, CacheConfiguration<?,?> config) throws CachePersistenceException
PersistableResourceService.PersistenceSpaceIdentifier
for the space associated to the provided arguments.
This method may create a new persistence space or load one. The returned identifier is the only way to interact with the persistence space.
name
- the name of the persistence contextconfig
- the configuration for the associated cache
CachePersistenceException
- if the persistence space cannot be createdgetStateRepositoryWithin(PersistenceSpaceIdentifier, String)
void releasePersistenceSpaceIdentifier(PersistableResourceService.PersistenceSpaceIdentifier<?> identifier) throws CachePersistenceException
PersistableResourceService.PersistenceSpaceIdentifier
.
This indicates to the persistence space that resource linked to the given identifier are no longer needed and thus enables cleaning up any transient state left.
identifier
- the PersistenceSpaceIdentifier
to release
CachePersistenceException
- If the identifier is not knownStateRepository getStateRepositoryWithin(PersistableResourceService.PersistenceSpaceIdentifier<?> identifier, java.lang.String name) throws CachePersistenceException
state repository
in the context of the given
identifier
.
If the StateRepository
already existed, this method returns it in a fully available state.
identifier
- the space identifiername
- the state repository name
StateRepository
CachePersistenceException
- if the StateRepository
cannot be created or recovered.void destroy(java.lang.String name) throws CachePersistenceException
This method can be called without having created the persistence space from this JVM.
name
- persistence context name
CachePersistenceException
- if the persistence space cannot be destroyedvoid destroyAll() throws CachePersistenceException
Note that this method can be called without having created the persistence spaces from this JVM.
CachePersistenceException
- if the persistence storage cannot be destroyed
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |