| org.jboss.ha.framework.interfaces.DistributedState
All known Subclasses: org.jboss.cache.invalidation.bridges.JGCacheInvalidationBridge,
| DistributedState | | public interface DistributedState (Code) | | DistributedState is a service on top of HAPartition that provides a
cluster-wide distributed state. The DistributedState (DS) service
provides a tuple
map. Thus, any service, application, container, ... can request its own DS
"private space" by working* in its own category (a string name).
You work in a category like a Dictionary: you set values by key within a
category. Each time a value is added/modified/removed, the modification
is made cluster-wide, on all other nodes.
Reading values is always made locally (no network access!)
Objects can also subscribes to DS events to be notified when some values gets
modified/removed/added in a particular category.
author:
Sacha Labourey.
author:
Scott.Stark@jboss.org
version:
$Revision: 57188 $
See Also: HAPartition |
| Inner Class :public interface DSListener | |
| Inner Class :public interface DSListenerEx | |
| Method Summary | |
| public Serializable | get(String category, Serializable key)
Read in a value associated to a key in the given category. | | public Collection | getAllCategories()
Return a list of all categories. | | public Collection | getAllKeys(String category)
Return a list of all keys in a category. | | public Collection | getAllValues(String category)
Return a list of all values in a category. | | public void | registerDSListener(String category, DSListener subscriber)
Subscribes to receive
DistributedState.DSListener events
Parameters:
category - Name of the private-space to watch for
Parameters:
subscriber - Object that will receive callbacks. | | public void | registerDSListenerEx(String category, DSListenerEx subscriber)
Subscribes to receive
DistributedState.DSListenerEx events
Parameters:
category - Name of the private-space to watch for
Parameters:
subscriber - Object that will receive callbacks. | | public Serializable | remove(String category, Serializable key)
| | public Serializable | remove(String category, Serializable key, boolean asynchronousCall)
Same as remove(String, String) but caller can choose if the call is made
synchronously or asynchronously. | | public void | set(String category, Serializable key, Serializable value)
| | public void | set(String category, Serializable key, Serializable value, boolean asynchronousCall)
Same as set(String, String) but caller can choose if the call is made
synchronously or asynchronously. | | public void | unregisterDSListener(String category, DSListener subscriber)
| | public void | unregisterDSListenerEx(String category, DSListenerEx subscriber)
|
| get | | public Serializable get(String category, Serializable key)(Code) | | Read in a value associated to a key in the given category. Read is performed locally.
Parameters:
category - Name of the private naming-space
Parameters:
key - The key of the value to read The value of the key in the given category |
| getAllCategories | | public Collection getAllCategories()(Code) | | Return a list of all categories. Call managed locally: no network access.
A collection of String representing the existing categories in the DS service. |
| getAllKeys | | public Collection getAllKeys(String category)(Code) | | Return a list of all keys in a category. Call managed locally: no network access.
Parameters:
category - The category under which to look for keys A collection of all keys in the give category |
| getAllValues | | public Collection getAllValues(String category)(Code) | | Return a list of all values in a category. Call managed locally: no network access.
Parameters:
category - The category name under which to look for values A collection of all values in the give category |
| registerDSListener | | public void registerDSListener(String category, DSListener subscriber)(Code) | | Subscribes to receive
DistributedState.DSListener events
Parameters:
category - Name of the private-space to watch for
Parameters:
subscriber - Object that will receive callbacks. This |
| registerDSListenerEx | | public void registerDSListenerEx(String category, DSListenerEx subscriber)(Code) | | Subscribes to receive
DistributedState.DSListenerEx events
Parameters:
category - Name of the private-space to watch for
Parameters:
subscriber - Object that will receive callbacks. This |
| remove | | public Serializable remove(String category, Serializable key) throws Exception(Code) | | Remove the key from the ReplicationService in the given category
Parameters:
category - Name of the category
Parameters:
key - Key to be removed
throws:
Exception - if a network exception occurs while removing the entry. |
| remove | | public Serializable remove(String category, Serializable key, boolean asynchronousCall) throws Exception(Code) | | Same as remove(String, String) but caller can choose if the call is made
synchronously or asynchronously. By default, calls are asynchronous.
|
| set | | public void set(String category, Serializable key, Serializable value) throws Exception(Code) | | Associates a value to a key in a specific category
Parameters:
category - Name of the private naming-space
Parameters:
key - Name of the data to set
Parameters:
value - Value of the data to set
throws:
Exception - If a network communication occurs |
| set | | public void set(String category, Serializable key, Serializable value, boolean asynchronousCall) throws Exception(Code) | | Same as set(String, String) but caller can choose if the call is made
synchronously or asynchronously. By default, calls are asynchronous.
|
| unregisterDSListener | | public void unregisterDSListener(String category, DSListener subscriber)(Code) | | Subscribes from
DistributedState.DSListener events
Parameters:
category - Name of the private-space dictionary currently observed
Parameters:
subscriber - object currently observing this category |
| unregisterDSListenerEx | | public void unregisterDSListenerEx(String category, DSListenerEx subscriber)(Code) | | Subscribes from
DistributedState.DSListenerEx events
Parameters:
category - Name of the private-space dictionary currently observed
Parameters:
subscriber - object currently observing this category |
|
|