org.cache2k.storage

Interface PurgeableStorage

All Known Implementing Classes:

ClearStorageBuffer

public interface PurgeableStorage

Author:

Jens Wilke; created: 2014-06-21

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PurgeableStorage.PurgeAction
static interface	PurgeableStorage.PurgeContext
static interface	PurgeableStorage.PurgeResult Statistics

Method Summary

Methods

Modifier and Type	Method and Description
PurgeableStorage.PurgeResult	purge(PurgeableStorage.PurgeContext ctx, long _valueExpiryTime, long _entryExpiryTime) Removes all entries which have an expiry time before or equal to the given time.

Method Detail

purge

PurgeableStorage.PurgeResult purge(PurgeableStorage.PurgeContext ctx,
                                 long _valueExpiryTime,
                                 long _entryExpiryTime)
                                   throws Exception

Removes all entries which have an expiry time before or equal to the given time. The time for the value expiry may be not identical to the current time, if the cache wants to keep some entries that are recently expired, e.g. if a CacheSource is present and a scheme like if-modified-since is supported by it.

The storage implementation may choose to implement only one or no expiry variant by time.

Parameters:

ctx - Provides a multi-threaded context. Thread resources for purge operations may be more limited or may have lower priority.

_valueExpiryTime - request to remove entries with lower value of StorageEntry.getValueExpiryTime()

_entryExpiryTime - request to remove entries with with lower value of StorageEntry.getEntryExpiryTime()

Returns:

statistical result of the operation, if nothing was done null.

Throws:

Exception