ConsoleListener

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.cache
Class ConsoleListener

java.lang.Object
  org.jboss.cache.ConsoleListener

All Implemented Interfaces:: TreeCacheListener (src)

public class ConsoleListener
extends java.lang.Object
implements TreeCacheListener (src)

This class provides a non-graphical view of JBossCache replication events for a replicated cache.

It can be utilized as a standalone application or as a component in other applications.

WARNING: take care when using this class in conjunction with transactionally replicated cache's as it can cause deadlock situations due to the reading of values for nodes in the cache.

Constructor Summary
`ConsoleListener(TreeCache (src) cache)` Constructor.
`ConsoleListener(TreeCache (src) cache, boolean startCache, boolean stopCache)` Constructor.

Method Summary
`void`	`cacheStarted(TreeCache (src) cache)` Called when the cache is started.
`void`	`cacheStopped(TreeCache (src) cache)` Called when the cache is stopped.
`void`	`listen()` Instructs this class to listen for cache replication events.
`void`	`listen(boolean wait)` Instructs this class to listen for cache replication events.
`static void`	`main(java.lang.String[] args)` The main method.
`void`	`nodeCreated(Fqn (src) fqn)` Called when a node is created
`void`	`nodeEvicted(Fqn (src) fqn)` Called when a node is evicted (not the same as remove()).
`void`	`nodeLoaded(Fqn (src) fqn)` Called when a node is loaded into memory via the CacheLoader.
`void`	`nodeModified(Fqn (src) fqn)` Called when a node is modified, e.g., one (key, value) pair in the internal map storage has been modified.
`void`	`nodeRemoved(Fqn (src) fqn)` Called when a node is removed.
`void`	`nodeVisited(Fqn (src) fqn)` Called when a node is visisted, i.e., get().
`void`	`viewChange(View new_view)`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConsoleListener

public ConsoleListener(TreeCache (src)  cache)
                throws java.lang.Exception

Constructor.

When using this constructor, this class with attempt to start and stop the specified cache.

Parameters:

cache - the cache to monitor for replication events.

ConsoleListener

public ConsoleListener(TreeCache (src)  cache,
                       boolean startCache,
                       boolean stopCache)
                throws java.lang.Exception

Constructor.
Parameters:: cache - the cache to monitor for replication events.; startCache - indicates whether or not the cache should be started by this class.; stopCache - indicates whether or not the cache should be stopped by this class.

Method Detail

listen

public void listen()
            throws java.lang.Exception

Instructs this class to listen for cache replication events.

This method waits indefinately. Use the notify method of this class (using traditional Java thread notification semantics) to cause this method to return.

Throws:: java.lang.Exception

listen

public void listen(boolean wait)
            throws java.lang.Exception

Instructs this class to listen for cache replication events.

Parameters:: wait - whether or not this method should wait indefinately.
If this parameter is set to true, using the notify method of this class (using traditional Java thread notification semantics) will cause this method to return.
Throws:: java.lang.Exception