org.mule.runtime.core.util.store

Class MonitoredObjectStoreWrapper<T extends Serializable>

java.lang.Object

org.mule.runtime.core.util.store.MonitoredObjectStoreWrapper<T>

All Implemented Interfaces:

Runnable, org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.store.ObjectStore<T>, MuleContextAware, ListableObjectStore<T>

public class MonitoredObjectStoreWrapper<T extends Serializable>
extends Object
implements ListableObjectStore<T>, Runnable, MuleContextAware, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Disposable

The MonitoredObjectStoreWrapper wraps an ObjectStore which does not support direct expiry and adds this behavior

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MonitoredObjectStoreWrapper.StoredObject<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected MuleContext	context
protected long	entryTTL The time-to-live for each message ID, specified in milliseconds, or -1 for entries that should never expire.
protected long	expirationInterval The interval for periodic bounded size enforcement and entry expiration, specified in milliseconds.
protected int	maxEntries the maximum number of entries that this store keeps around.
protected String	name A name for this store, can be used for logging and identification purposes.

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
MonitoredObjectStoreWrapper(ListableObjectStore<MonitoredObjectStoreWrapper.StoredObject<T>> baseStore)
MonitoredObjectStoreWrapper(ListableObjectStore<MonitoredObjectStoreWrapper.StoredObject<T>> baseStore, int maxEntries, long entryTTL, long expirationInterval)

Method Summary

Modifier and Type	Method and Description
List<Serializable>	allKeys()
void	clear()
void	close() Close the underlying store.
boolean	contains(Serializable key)
void	dispose()
void	expire()
void	initialise()
boolean	isPersistent()
void	open() Open the underlying store.
T	remove(Serializable key)
T	retrieve(Serializable key)
void	run()
void	setMuleContext(MuleContext context)
void	store(Serializable key, T value)

Methods inherited from class java.lang.Object

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

Field Detail

context

protected MuleContext context

maxEntries

protected int maxEntries

the maximum number of entries that this store keeps around. Specify -1 if the store is supposed to be "unbounded".

entryTTL

protected long entryTTL

The time-to-live for each message ID, specified in milliseconds, or -1 for entries that should never expire. DO NOT combine this with an unbounded store!

expirationInterval

protected long expirationInterval

The interval for periodic bounded size enforcement and entry expiration, specified in milliseconds. Arbitrary positive values between 1 millisecond and several hours or days are possible, but should be chosen carefully according to the expected message rate to prevent out of memory conditions.

name

protected String name

A name for this store, can be used for logging and identification purposes.

Constructor Detail

MonitoredObjectStoreWrapper

public MonitoredObjectStoreWrapper(ListableObjectStore<MonitoredObjectStoreWrapper.StoredObject<T>> baseStore)

MonitoredObjectStoreWrapper

public MonitoredObjectStoreWrapper(ListableObjectStore<MonitoredObjectStoreWrapper.StoredObject<T>> baseStore,
                                   int maxEntries,
                                   long entryTTL,
                                   long expirationInterval)

Method Detail

contains

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

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(Serializable key,
                  T value)
           throws org.mule.runtime.api.store.ObjectStoreException

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(Serializable key)
           throws org.mule.runtime.api.store.ObjectStoreException

Specified by:

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

Throws:

org.mule.runtime.api.store.ObjectStoreException

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

remove

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

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>

open

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

Description copied from interface: ListableObjectStore

Open the underlying store.

Specified by:

open in interface ListableObjectStore<T extends Serializable>

Throws:

org.mule.runtime.api.store.ObjectStoreException - if an exception occurred while opening the underlying store.

close

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

Description copied from interface: ListableObjectStore

Close the underlying store.

Specified by:

close in interface ListableObjectStore<T extends Serializable>

Throws:

org.mule.runtime.api.store.ObjectStoreException - if an exception occurred while closing the underlying store.

allKeys

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

Specified by:

allKeys in interface ListableObjectStore<T extends Serializable>

Returns:

list containing all keys that this object store currently holds values for.

Throws:

org.mule.runtime.api.store.ObjectStoreException - if an exception occurred while collecting the list of all keys.

setMuleContext

public void setMuleContext(MuleContext context)

Specified by:

setMuleContext in interface MuleContextAware

Parameters:

context - the Mule node.

run

public void run()

Specified by:

run in interface Runnable

expire

public void expire()

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException