org.mule.runtime.api.store

Interface ExpirableObjectStore<T extends Serializable>

Type Parameters:

T - the generic type of the objects to be stored

All Superinterfaces:

ObjectStore<T>

All Known Subinterfaces:

PartitionableExpirableObjectStore<T>

public interface ExpirableObjectStore<T extends Serializable>
extends ObjectStore<T>

An ObjectStore capable of expiring entries when the expire(long, int) method is invoked

Since:

1.0

Method Summary

Modifier and Type	Method and Description
void	expire(long entryTTL, int maxEntries) Expires eligible entries.

Methods inherited from interface org.mule.runtime.api.store.ObjectStore

allKeys, clear, close, contains, isPersistent, open, remove, retrieve, retrieveAll, store

Method Detail

expire

void expire(long entryTTL,
            int maxEntries)
     throws ObjectStoreException

Expires eligible entries. This method is required to be thread safe and atomic, meaning that while running, all other methods must wait for it to finish

Parameters:

entryTTL - expire all entries which were inserted after this number of milliseconds. If lower or equal than zero, no items will be expired on a TTL basis

maxEntries - The max number of entries that this store is allowed to have. If the store has more entries than this, it will start removing entries until the boundary is met. The selection criteria is up to each implementation

Throws:

ObjectStoreException - in case of failure