ehcache

net.sf.ehcache.distribution
Interface CacheManagerPeerListener

All Superinterfaces:
CacheManagerEventListener
All Known Implementing Classes:
JNDIRMICacheManagerPeerListener, RMICacheManagerPeerListener

public interface CacheManagerPeerListener
extends CacheManagerEventListener

A listener for updates, which controls remote cache peers.

Version:
$Id: CacheManagerPeerListener.java 108 2006-06-04 12:44:06Z gregluck $
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.
 void dispose()
          Stop the listener and free any resources.
 java.util.List getBoundCachePeers()
          All of the caches which are listenting for remote changes.
 Status getStatus()
          Returns the listener status.
 java.lang.String getUniqueResourceIdentifier()
          A listener will normally have a resource that only one instance can use at the same time, such as a port.
 void init()
          Call to start the listeners and do any other network initialisation.
 
Methods inherited from interface net.sf.ehcache.event.CacheManagerEventListener
notifyCacheAdded, notifyCacheRemoved
 

Method Detail

init

void init()
          throws CacheException
Call to start the listeners and do any other network initialisation.

Throws:
CacheException

dispose

void dispose()
             throws CacheException
Stop the listener and free any resources.

Throws:
CacheException

getBoundCachePeers

java.util.List getBoundCachePeers()
All of the caches which are listenting for remote changes.

Returns:
a list of CachePeer objects

getStatus

Status getStatus()
Returns the listener status.


getUniqueResourceIdentifier

java.lang.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 java.lang.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:
java.lang.IllegalStateException - if the statis of the listener is not Status.STATUS_UNINITIALISED
CacheException

ehcache