org.infinispan.registry

Interface ClusterRegistry<S,K,V>

All Known Implementing Classes:

ClusterRegistryImpl

public interface ClusterRegistry<S,K,V>

A registry of scoped key-values available to all the nodes in the cluster. Intended as a general purpose tool for sharing metadata: small amounts of information that is not frequently updated. It is not intended to be used for sharing large amount of information nor to be exposed to users.

The registry is a global component, i.e. it is shared by all the caches in the cluster. In order to avoid collisions each key-value entry is scoped (the scope parameter). For scoping one can use fully qualified names of the specific classes/packages that make use of the ClusterRegistry.

A reference to the ClusterRegistry can be obtained either through the \@Inject annotation:

    \@Inject
    void setup(ClusterRegistry cs) {
       ..hold the reference
    }
 

or directly form the GlobalComponentRegistry:

    EmbeddedCacheManager:getGlobalComponentRegistry():getGlobalComponent(ClusterRegistry.class)
 

Since:

6.0

Author:

Mircea Markus

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(S scope, KeyFilter keyFilter, Object listener) Adds a listener that is notified of changes to keys in a given scope and which match a given KeyFilter.
void	addListener(S scope, Object listener) Adds a listener that is notified of changes to keys in a given scope.
void	clear(S scope)
void	clearAll()
boolean	containsKey(S scope, K key)
V	get(S scope, K key)
Set<K>	keys(S scope)
V	put(S scope, K key, V value)
V	remove(S scope, K key)
void	removeListener(Object listener) Detaches a listener instance.

Method Detail

put

V put(S scope,
    K key,
    V value)

remove

V remove(S scope,
       K key)

get

V get(S scope,
    K key)

containsKey

boolean containsKey(S scope,
                  K key)

keys

Set<K> keys(S scope)

clear

void clear(S scope)

clearAll

void clearAll()

addListener

void addListener(S scope,
               Object listener)

Adds a listener that is notified of changes to keys in a given scope.

Parameters:

scope - the scope to watch

listener - a properly annotated listener instance

addListener

void addListener(S scope,
               KeyFilter keyFilter,
               Object listener)

Adds a listener that is notified of changes to keys in a given scope and which match a given KeyFilter.

Parameters:

scope - the scope to watch

listener - a properly annotated listener instance

removeListener

void removeListener(Object listener)

Detaches a listener instance.

Parameters:

listener - the listener to detach