net.sf.ehcache.distribution
Interface CacheManagerPeerListener

All Superinterfaces:

CacheManagerEventListener

All Known Implementing Classes:

RMICacheManagerPeerListener

public interface CacheManagerPeerListener
extends CacheManagerEventListener

A listener for updates, which controls remote cache peers.

Version:

$Id: CacheManagerPeerListener.java 5594 2012-05-07 16:04:31Z cdennis $

Author:

Greg Luck

Method Summary

void	attemptResolutionOfUniqueResourceConflict() If a conflict is detected in unique resource use, this method signals the listener to attempt automatic resolution of the resource conflict.
List	getBoundCachePeers() All of the caches which are listening for remote changes.
String	getScheme() The replication scheme this listener interacts with.
String	getUniqueResourceIdentifier() A listener will normally have a resource that only one instance can use at the same time, such as a port.

Methods inherited from interface net.sf.ehcache.event.CacheManagerEventListener

dispose, getStatus, init, notifyCacheAdded, notifyCacheRemoved

Method Detail

getBoundCachePeers

List getBoundCachePeers()

All of the caches which are listening for remote changes.

Returns:

a list of CachePeer objects

getUniqueResourceIdentifier

String getUniqueResourceIdentifier()

A listener will normally have a resource that only one instance can use at the same time, such as a port. This identifier is used to tell if it is unique and will not conflict with an existing instance using the resource.

Returns:

a String identifier for the resource

attemptResolutionOfUniqueResourceConflict

void attemptResolutionOfUniqueResourceConflict()
                                               throws IllegalStateException,
                                                      CacheException

If a conflict is detected in unique resource use, this method signals the listener to attempt automatic resolution of the resource conflict.

Throws:

IllegalStateException - if the statis of the listener is not Status.STATUS_UNINITIALISED

CacheException

getScheme

String getScheme()

The replication scheme this listener interacts with. Each peer provider has a scheme name, which can be used by caches to specify for replication and bootstrap purposes.

Returns:

the well-known scheme name, which is determined by the replication provider author.