org.mule.runtime.api.store

Interface PartitionableExpirableObjectStore<T extends Serializable>

Type Parameters:

T - the generic type of the objects to be stored

All Superinterfaces:

ExpirableObjectStore<T>, ObjectStore<T>, PartitionableObjectStore<T>

public interface PartitionableExpirableObjectStore<T extends Serializable>
extends ExpirableObjectStore<T>, PartitionableObjectStore<T>

A PartitionableObjectStore which is also an ExpirableObjectStore

Since:

1.0

Field Summary

Fields inherited from interface org.mule.runtime.api.store.PartitionableObjectStore

DEFAULT_PARTITION_NAME

Method Summary

Modifier and Type	Method and Description
void	expire(long entryTTL, int maxEntries, String partitionName) Expires eligible entries in the given partitionName.

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

expire

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

allKeys, allPartitions, clear, close, contains, disposePartition, open, remove, retrieve, retrieveAll, store

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,
            String partitionName)
     throws ObjectStoreException

Expires eligible entries in the given partitionName. 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

partitionName - the name of the partition to expire

Throws:

ObjectStoreException - in case of failure