org.jboss.ha.framework.interfaces
Interface DistributedState

Deprecated. Use JBoss Cache for distributed caching

public interface DistributedState

DistributedState is a service on top of HAPartition that provides a cluster-wide distributed state. The DistributedState (DS) service provides a <String category, Serializable key, Serializable value> 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 subscribe to DS events to be notified when values are modified/removed/added in a particular category.

Version:

$Revision: 74879 $

Author:

Sacha Labourey., Scott.Stark@jboss.org

See Also:

HAPartition

Nested Class Summary

static interface	DistributedState.DSListener Deprecated. use the DSListenerEx instead
static interface	DistributedState.DSListenerEx Deprecated. A generalization of the DSListener that supports the Serializable key type.

Method Summary

Serializable	get(String category, Serializable key) Deprecated. Read in a value associated to a key in the given category.
Collection	getAllCategories() Deprecated. Return a list of all categories.
Collection	getAllKeys(String category) Deprecated. Return a list of all keys in a category.
Collection	getAllValues(String category) Deprecated. Return a list of all values in a category.
void	registerDSListener(String category, DistributedState.DSListener subscriber) Deprecated. Subscribes to receive DistributedState.DSListener events
void	registerDSListenerEx(String category, DistributedState.DSListenerEx subscriber) Deprecated. Subscribes to receive DistributedState.DSListenerEx events
Serializable	remove(String category, Serializable key) Deprecated. Remove the key from the ReplicationService in the given category
Serializable	remove(String category, Serializable key, boolean asynchronousCall) Deprecated. Same as remove(String, String) but caller can choose if the call is made synchronously or asynchronously.
void	set(String category, Serializable key, Serializable value) Deprecated. Associates a value to a key in a specific category
void	set(String category, Serializable key, Serializable value, boolean asynchronousCall) Deprecated. Same as set(String, String) but caller can choose if the call is made synchronously or asynchronously.
void	unregisterDSListener(String category, DistributedState.DSListener subscriber) Deprecated. Unsubscribes from DistributedState.DSListener events
void	unregisterDSListenerEx(String category, DistributedState.DSListenerEx subscriber) Deprecated. Unsubscribes from DistributedState.DSListenerEx events

Method Detail

registerDSListenerEx

void registerDSListenerEx(String category,
                          DistributedState.DSListenerEx subscriber)

Deprecated.

Subscribes to receive DistributedState.DSListenerEx events

Parameters:

category - Name of the private-space to watch for

subscriber - Object that will receive callbacks.

unregisterDSListenerEx

void unregisterDSListenerEx(String category,
                            DistributedState.DSListenerEx subscriber)

Deprecated.

Unsubscribes from DistributedState.DSListenerEx events

Parameters:

category - Name of the private-space dictionary currently observed

subscriber - Object currently observing this category

registerDSListener

void registerDSListener(String category,
                        DistributedState.DSListener subscriber)

Deprecated.

Subscribes to receive DistributedState.DSListener events

Parameters:

category - Name of the private-space to watch for

subscriber - Object that will receive callbacks.

unregisterDSListener

void unregisterDSListener(String category,
                          DistributedState.DSListener subscriber)

Deprecated.

Unsubscribes from DistributedState.DSListener events

Parameters:

category - Name of the private-space dictionary currently observed

subscriber - Object currently observing this category

set

void set(String category,
         Serializable key,
         Serializable value)
         throws Exception

Deprecated.

Associates a value to a key in a specific category

Parameters:

category - Name of the private naming-space

key - Name of the data to set

value - Value of the data to set

Throws:

Exception - If a network exception occurs

set

void set(String category,
         Serializable key,
         Serializable value,
         boolean asynchronousCall)
         throws Exception

Deprecated.

Same as set(String, String) but caller can choose if the call is made synchronously or asynchronously. By default, calls are asynchronous.

Parameters:

category - Name of the private naming-space

key - Name of the data to set

value - Value of the data to set

asynchronousCall - True if the call should be asynchronous

Throws:

Exception - If a network exception occurs

get

Serializable get(String category,
                 Serializable key)

Deprecated.

Read in a value associated to a key in the given category. Read is performed locally.

Parameters:

category - Name of the private naming-space

key - The key of the value to read

Returns:

The value of the key in the given category

getAllCategories

Collection getAllCategories()

Deprecated.

Return a list of all categories. Call managed locally: no network access.

Returns:

A collection of String representing the existing categories in the DS service.

getAllKeys

Collection getAllKeys(String category)

Deprecated.

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

Returns:

A collection of all keys in the give category

getAllValues

Collection getAllValues(String category)

Deprecated.

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

Returns:

A collection of all values in the give category

remove

Serializable remove(String category,
                    Serializable key)
                    throws Exception

Deprecated.

Remove the key from the ReplicationService in the given category

Parameters:

category - Name of the category

key - Key to be removed

Returns:

The value of the removed key

Throws:

Exception - if a network exception occurs while removing the entry.

remove

Serializable remove(String category,
                    Serializable key,
                    boolean asynchronousCall)
                    throws Exception

Deprecated.

Same as remove(String, String) but caller can choose if the call is made synchronously or asynchronously. By default, calls are asynchronous.

Parameters:

category - Name of the category

key - Key to be removed

asynchronousCall - True if the call should be asynchronous

Returns:

The value of the removed key

Throws:

Exception - if a network exception occurs while removing the entry.