org.mule.util.store
Class ManagedObjectStore<T extends Serializable>

java.lang.Object
  org.mule.util.store.ManagedObjectStore<T>

All Implemented Interfaces:

MuleContextAware, ListableObjectStore<T>, ObjectStore<T>

public class ManagedObjectStore<T extends Serializable>
extends Object
implements ListableObjectStore<T>, MuleContextAware

Constructor Summary

ManagedObjectStore()

Method Summary

List<Serializable>	allKeys()
void	close() Close the underlying store.
boolean	contains(Serializable key) Check whether the given Object is already registered with this store.
int	getEntryTTL()
int	getExpirationInterval()
int	getMaxEntries()
String	getStoreName()
boolean	isPersistent() Is this store persistent?
void	open() Open the underlying store.
T	remove(Serializable key) Remove the object with key.
T	retrieve(Serializable key) Retrieve the given Object.
void	setEntryTTL(int entryTTL)
void	setExpirationInterval(int expirationInterval)
void	setMaxEntries(int maxEntries)
void	setMuleContext(MuleContext context)
void	setPersistent(boolean isPersistent)
void	setStoreName(String storeName)
void	store(Serializable key, T value) Store the given Object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedObjectStore

public ManagedObjectStore()

Method Detail

getStoreName

public String getStoreName()

setStoreName

public void setStoreName(String storeName)

isPersistent

public boolean isPersistent()

Description copied from interface: ObjectStore

Is this store persistent?

Specified by:

isPersistent in interface ObjectStore<T extends Serializable>

Returns:

true if this store is persistent

setPersistent

public void setPersistent(boolean isPersistent)

getMaxEntries

public int getMaxEntries()

setMaxEntries

public void setMaxEntries(int maxEntries)

getEntryTTL

public int getEntryTTL()

setEntryTTL

public void setEntryTTL(int entryTTL)

getExpirationInterval

public int getExpirationInterval()

setExpirationInterval

public void setExpirationInterval(int expirationInterval)

contains

public boolean contains(Serializable key)
                 throws ObjectStoreException

Description copied from interface: ObjectStore

Check whether the given Object is already registered with this store.

Specified by:

contains in interface ObjectStore<T extends Serializable>

Parameters:

key - the identifier of the object to check

Returns:

true if the key is stored or false no value was stored for the key.

Throws:

ObjectStoreException - if the given key is null.

ObjectStoreNotAvaliableException - if any implementation-specific error occured, e.g. when the store is not available

store

public void store(Serializable key,
                  T value)
           throws ObjectStoreException

Description copied from interface: ObjectStore

Store the given Object.

Specified by:

store in interface ObjectStore<T extends Serializable>

Parameters:

key - the identifier for value

value - the Object to store with key

Throws:

ObjectStoreException - if the given key cannot be stored or is null.

ObjectStoreNotAvaliableException - if the store is not available or any other implementation-specific error occured.

ObjectAlreadyExistsException - if an attempt is made to store an object for a key that already has an object associated.

retrieve

public T retrieve(Serializable key)
                                throws ObjectStoreException

Description copied from interface: ObjectStore

Retrieve the given Object.

Specified by:

retrieve in interface ObjectStore<T extends Serializable>

Parameters:

key - the identifier of the object to retrieve.

Returns:

the object associated with the given key. If no object for the given key was found this method throws an ObjectDoesNotExistException.

Throws:

ObjectStoreException - if the given key is null.

ObjectStoreNotAvaliableException - if the store is not available or any other implementation-specific error occured.

ObjectDoesNotExistException - if no value for the given key was previously stored.

remove

public T remove(Serializable key)
                              throws ObjectStoreException

Description copied from interface: ObjectStore

Remove the object with key.

Specified by:

remove in interface ObjectStore<T extends Serializable>

Parameters:

key - the identifier of the object to remove.

Returns:

the object that was previously stored for the given key

Throws:

ObjectStoreException - if the given key is null or if the store is not available or any other implementation-specific error occured

ObjectDoesNotExistException - if no value for the given key was previously stored.

open

public void open()
          throws ObjectStoreException

Description copied from interface: ListableObjectStore

Open the underlying store.

Specified by:

open in interface ListableObjectStore<T extends Serializable>

Throws:

ObjectStoreException - if an exception occurred while opening the underlying store.

close

public void close()
           throws ObjectStoreException

Description copied from interface: ListableObjectStore

Close the underlying store.

Specified by:

close in interface ListableObjectStore<T extends Serializable>

Throws:

ObjectStoreException - if an exception occurred while closing the underlying store.

allKeys

public List<Serializable> allKeys()
                           throws ObjectStoreException

Specified by:

allKeys in interface ListableObjectStore<T extends Serializable>

Returns:

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

Throws:

ObjectStoreException - if an exception occurred while collecting the list of all keys.

setMuleContext

public void setMuleContext(MuleContext context)

Specified by:

setMuleContext in interface MuleContextAware