org.mule.util.store

Class ProvidedObjectStoreWrapper<T extends Serializable>

java.lang.Object

org.mule.util.store.ProvidedObjectStoreWrapper<T>

All Implemented Interfaces:

Disposable, ObjectStore<T>

Direct Known Subclasses:

ProvidedPartitionableObjectStoreWrapper

public class ProvidedObjectStoreWrapper<T extends Serializable>
extends Object
implements ObjectStore<T>, Disposable

Will wrap a provided object store or a newly created one with the provided factory, with the provided having precedence if present.

In the case the factory is used and a fresh object store is created, its lifecycle management will be delegated by this wrapper.

Field Summary

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
ProvidedObjectStoreWrapper(ObjectStore<T> providedObjectStore, org.apache.commons.collections.Factory objectStoreFactory) Wraps the providedObjectStore if given, or uses the objectStoreFactory to create one.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all items of this store without disposing it, meaning that after performing a clear(), you should still be able perform other operations.
boolean	contains(Serializable key) Check whether the given Object is already registered with this store.
void	dispose() A lifecycle method where implementor should free up any resources.
protected ObjectStore<T>	getWrapped()
boolean	isPersistent() Is this store persistent?
T	remove(Serializable key) Remove the object with key.
T	retrieve(Serializable key) Retrieve the given Object.
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

ProvidedObjectStoreWrapper

public ProvidedObjectStoreWrapper(ObjectStore<T> providedObjectStore,
                          org.apache.commons.collections.Factory objectStoreFactory)

Wraps the providedObjectStore if given, or uses the objectStoreFactory to create one.

Parameters:

providedObjectStore - the objectStroe provided through config to use. May be null.

objectStoreFactory - the factory to use to build an object store if providedObjectStore is null.

Method Detail

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.

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

clear

public void clear()
           throws ObjectStoreException

Description copied from interface: ObjectStore

Removes all items of this store without disposing it, meaning that after performing a clear(), you should still be able perform other operations. Implementations of this method have to remove all items in the fastest way possible. No assumptions should be made regarding thread safeness. If the store implementation is thread-safe, then this method should also be. If the implementation does not guarantee thread-safeness, then you shouldn't expect that from this method either.

Specified by:

clear in interface ObjectStore<T extends Serializable>

Throws:

ObjectStoreException - if the operation fails

dispose

public void dispose()

Description copied from interface: Disposable

A lifecycle method where implementor should free up any resources. If an exception is thrown it should just be logged and processing should continue. This method should not throw Runtime exceptions.

Specified by:

dispose in interface Disposable

getWrapped

protected ObjectStore<T> getWrapped()