com.mulesoft.mule.runtime.gw.api.expirable.os

Class ExpirableObjectStore<T extends Serializable>

java.lang.Object

com.mulesoft.mule.runtime.gw.api.expirable.os.ExpirableObjectStore<T>

Type Parameters:

T - type of entry.

All Implemented Interfaces:

org.mule.runtime.api.store.ObjectStore<T>

public class ExpirableObjectStore<T extends Serializable>
extends Object
implements org.mule.runtime.api.store.ObjectStore<T>

Decorates an ObjectStore, ensuring that when any message is answered, the requested entry has not yet expired.

NOTE (I): Mule API already provides an ExpirableObjectStore. This implementation differs from that in that each entry can be expired at a different pace by delegating the expiration configuration in the ExpirableObjectFactory. NOTE (II): This implementation is NOT thread safe.

Constructor Summary

Constructors

Constructor and Description
ExpirableObjectStore(org.mule.runtime.api.store.ObjectStore<Expirable<T>> innerOS, ExpirableObjectFactory<T> expirableObjectFactory)

Method Summary

Modifier and Type	Method and Description
List<String>	allKeys()
void	clear()
void	close()
boolean	contains(String key)
protected org.mule.runtime.api.store.ObjectDoesNotExistException	expiredEntryException(Serializable key)
boolean	isPersistent()
void	open()
T	remove(String key)
T	retrieve(String key)
Map<String,T>	retrieveAll()
void	store(String key, T value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExpirableObjectStore

public ExpirableObjectStore(org.mule.runtime.api.store.ObjectStore<Expirable<T>> innerOS,
                            ExpirableObjectFactory<T> expirableObjectFactory)

Method Detail

contains

public boolean contains(String key)
                 throws org.mule.runtime.api.store.ObjectStoreException

If entry exists but has expired, this method will return false.

Specified by:

contains in interface org.mule.runtime.api.store.ObjectStore<T extends Serializable>

Throws:

org.mule.runtime.api.store.ObjectStoreException

store

public void store(String key,
                  T value)
           throws org.mule.runtime.api.store.ObjectStoreException

Storing multiple times values for the same key will result in overwriting the previous values.

Specified by:

store in interface org.mule.runtime.api.store.ObjectStore<T extends Serializable>

Throws:

org.mule.runtime.api.store.ObjectStoreException

retrieve

public T retrieve(String key)
           throws org.mule.runtime.api.store.ObjectStoreException

If the entry exists but has expired, it will be removed from is internal ObjectStore and an ObjectDoesNotExistException will be thrown.

Specified by:

retrieve in interface org.mule.runtime.api.store.ObjectStore<T extends Serializable>

Throws:

org.mule.runtime.api.store.ObjectStoreException

remove

public T remove(String key)
         throws org.mule.runtime.api.store.ObjectStoreException

Entry will be always removed, but if it has expired, an ObjectDoesNotExistException will be thrown.

Specified by:

remove in interface org.mule.runtime.api.store.ObjectStore<T extends Serializable>

Throws:

org.mule.runtime.api.store.ObjectStoreException

isPersistent

public boolean isPersistent()

Specified by:

isPersistent in interface org.mule.runtime.api.store.ObjectStore<T extends Serializable>

clear

public void clear()
           throws org.mule.runtime.api.store.ObjectStoreException

Specified by:

clear in interface org.mule.runtime.api.store.ObjectStore<T extends Serializable>

Throws:

org.mule.runtime.api.store.ObjectStoreException

open

public void open()
          throws org.mule.runtime.api.store.ObjectStoreException

Specified by:

open in interface org.mule.runtime.api.store.ObjectStore<T extends Serializable>

Throws:

org.mule.runtime.api.store.ObjectStoreException

close

public void close()
           throws org.mule.runtime.api.store.ObjectStoreException

Specified by:

close in interface org.mule.runtime.api.store.ObjectStore<T extends Serializable>

Throws:

org.mule.runtime.api.store.ObjectStoreException

allKeys

public List<String> allKeys()
                     throws org.mule.runtime.api.store.ObjectStoreException

Specified by:

allKeys in interface org.mule.runtime.api.store.ObjectStore<T extends Serializable>

Throws:

org.mule.runtime.api.store.ObjectStoreException

retrieveAll

public Map<String,T> retrieveAll()
                          throws org.mule.runtime.api.store.ObjectStoreException

As every entry must be processed, this ObjectStore will clean up expired entries before returning them. Beware that an entry can expire between when is processed and this method returns.

Specified by:

retrieveAll in interface org.mule.runtime.api.store.ObjectStore<T extends Serializable>

Returns:

All non-expired objects.

Throws:

org.mule.runtime.api.store.ObjectStoreException

expiredEntryException

protected org.mule.runtime.api.store.ObjectDoesNotExistException expiredEntryException(Serializable key)