Package com.alachisoft.ncache.client.services

Interface NotificationService

public interface NotificationService

This interface contains properties and methods required for a Notification Service.

Method Summary

Modifier and Type	Method	Description
void	addCacheClearedListener(CacheClearedListener listener)	Registers event for notifying applications when the cache is cleared.
void	addCacheConnectivityChangedListener(CacheClientConnectivityChangedListener listener)	Registers event for notifying the application about the status of cache client connectivity.
void	addCacheStatusEventListener(CacheStatusEventListener cacheStatusEventListener, java.util.EnumSet<CacheStatusNotificationType> statusNotificationTypes)	Registers event for notifying applications when a node joins/lefts the cache or when cache is stopped.
void	removeCacheClearedListener(CacheClearedListener listener)	Unregisters event for notifying applications when the cache is cleared.
void	removeCacheConnectivityChangedListener(CacheClientConnectivityChangedListener listener)	Unregisters event for notifying the application about the status of cache client connectivity.
void	removeCacheStatusEventListener(CacheStatusEventListener cacheStatusEventListener, java.util.EnumSet<CacheStatusNotificationType> statusNotificationTypes)	Unregisters event for notifying applications when a node joins/lefts the cache or when cache is stopped.

Method Detail

addCacheConnectivityChangedListener

void addCacheConnectivityChangedListener(CacheClientConnectivityChangedListener listener)
                                  throws CacheException,
                                         java.lang.IllegalArgumentException

Registers event for notifying the application about the status of cache client connectivity.

Parameters:

listener - The listener that is invoked when client connectivity status changes.

Throws:

CacheException

java.lang.IllegalArgumentException

removeCacheConnectivityChangedListener

void removeCacheConnectivityChangedListener(CacheClientConnectivityChangedListener listener)
                                     throws CacheException,
                                            java.lang.IllegalArgumentException

Unregisters event for notifying the application about the status of cache client connectivity.

Parameters:

listener - The listener that was registered with client connectivity changed event.

Throws:

CacheException

java.lang.IllegalArgumentException

addCacheClearedListener

void addCacheClearedListener(CacheClearedListener listener)
                      throws CacheException,
                             java.lang.IllegalArgumentException

Registers event for notifying applications when the cache is cleared.

Parameters:

listener - The listener that is invoked whenever the cache is cleared.

Throws:

CacheException

java.lang.IllegalArgumentException

removeCacheClearedListener

void removeCacheClearedListener(CacheClearedListener listener)
                         throws CacheException,
                                java.lang.IllegalArgumentException

Unregisters event for notifying applications when the cache is cleared.

Parameters:

listener - The listener that is registered with the cache cleared event.

Throws:

CacheException

java.lang.IllegalArgumentException

addCacheStatusEventListener

void addCacheStatusEventListener(CacheStatusEventListener cacheStatusEventListener,
                                 java.util.EnumSet<CacheStatusNotificationType> statusNotificationTypes)
                          throws CacheException,
                                 java.lang.IllegalArgumentException

Registers event for notifying applications when a node joins/lefts the cache or when cache is stopped.

Parameters:

cacheStatusEventListener - The listener that is invoded whenever cache status changes.

statusNotificationTypes - The enumset that specifies the events that listener is registered with.

Throws:

CacheException

java.lang.IllegalArgumentException

removeCacheStatusEventListener

void removeCacheStatusEventListener(CacheStatusEventListener cacheStatusEventListener,
                                    java.util.EnumSet<CacheStatusNotificationType> statusNotificationTypes)
                             throws CacheException,
                                    java.lang.IllegalArgumentException

Unregisters event for notifying applications when a node joins/lefts the cache or when cache is stopped.

Parameters:

cacheStatusEventListener - The listener that was registered with cache status event.

statusNotificationTypes - The enumset that specifies the events that listener is unregistered with.

Throws:

CacheException

java.lang.IllegalArgumentException