org.mule.util.store

Class ProvidedPartitionableObjectStoreWrapper<T extends Serializable>

java.lang.Object

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

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

All Implemented Interfaces:

Disposable, ListableObjectStore<T>, ObjectStore<T>, PartitionableObjectStore<T>

public class ProvidedPartitionableObjectStoreWrapper<T extends Serializable>
extends ProvidedObjectStoreWrapper<T>
implements PartitionableObjectStore<T>

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
ProvidedPartitionableObjectStoreWrapper(PartitionableObjectStore<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
List<Serializable>	allKeys()
List<Serializable>	allKeys(String partitionName)
List<String>	allPartitions()
void	clear(String partitionName)
void	close() Close the underlying store.
void	close(String partitionName)
boolean	contains(Serializable key, String partitionName)
void	disposePartition(String partitionName)
protected PartitionableObjectStore<T>	getWrapped()
void	open() Open the underlying store.
void	open(String partitionName)
T	remove(Serializable key, String partitionName)
T	retrieve(Serializable key, String partitionName)
void	store(Serializable key, T value, String partitionName)

Methods inherited from class org.mule.util.store.ProvidedObjectStoreWrapper

clear, contains, dispose, isPersistent, remove, retrieve, store

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.api.store.ObjectStore

clear, contains, isPersistent, remove, retrieve, store

Constructor Detail

ProvidedPartitionableObjectStoreWrapper

public ProvidedPartitionableObjectStoreWrapper(PartitionableObjectStore<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

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.

contains

public boolean contains(Serializable key,
               String partitionName)
                 throws ObjectStoreException

Specified by:

contains in interface PartitionableObjectStore<T extends Serializable>

Throws:

ObjectStoreException

store

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

Specified by:

store in interface PartitionableObjectStore<T extends Serializable>

Throws:

ObjectStoreException

retrieve

public T retrieve(Serializable key,
         String partitionName)
                                throws ObjectStoreException

Specified by:

retrieve in interface PartitionableObjectStore<T extends Serializable>

Throws:

ObjectStoreException

remove

public T remove(Serializable key,
       String partitionName)
                              throws ObjectStoreException

Specified by:

remove in interface PartitionableObjectStore<T extends Serializable>

Throws:

ObjectStoreException

allKeys

public List<Serializable> allKeys(String partitionName)
                           throws ObjectStoreException

Specified by:

allKeys in interface PartitionableObjectStore<T extends Serializable>

Throws:

ObjectStoreException

allPartitions

public List<String> allPartitions()
                           throws ObjectStoreException

Specified by:

allPartitions in interface PartitionableObjectStore<T extends Serializable>

Throws:

ObjectStoreException

open

public void open(String partitionName)
          throws ObjectStoreException

Specified by:

open in interface PartitionableObjectStore<T extends Serializable>

Throws:

ObjectStoreException

close

public void close(String partitionName)
           throws ObjectStoreException

Specified by:

close in interface PartitionableObjectStore<T extends Serializable>

Throws:

ObjectStoreException

disposePartition

public void disposePartition(String partitionName)
                      throws ObjectStoreException

Specified by:

disposePartition in interface PartitionableObjectStore<T extends Serializable>

Throws:

ObjectStoreException

clear

public void clear(String partitionName)
           throws ObjectStoreException

Specified by:

clear in interface PartitionableObjectStore<T extends Serializable>

Throws:

ObjectStoreException

getWrapped

protected PartitionableObjectStore<T> getWrapped()

Overrides:

getWrapped in class ProvidedObjectStoreWrapper<T extends Serializable>