org.jboss.cache
Class ConsoleListener

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

public class ConsoleListener
extends java.lang.Object

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.

Author:

Jimmy Wilson 12-2004

Constructor Summary

ConsoleListener(CacheImpl cache)
Constructor.

ConsoleListener(CacheImpl cache, boolean startCache, boolean stopCache)
Constructor.

Method Summary

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	printDetails(Event e)
void	printDetailsWithFqn(NodeEvent e)
void	printNewView(ViewChangedEvent e)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleListener

public ConsoleListener(CacheImpl 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.

Throws:

java.lang.Exception

ConsoleListener

public ConsoleListener(CacheImpl 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.

Throws:

java.lang.Exception

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

printDetails

public void printDetails(Event e)

printDetailsWithFqn

public void printDetailsWithFqn(NodeEvent e)

printNewView

public void printNewView(ViewChangedEvent e)

main

public static void main(java.lang.String[] args)

The main method.

Parameters:

args - command line arguments dictated by convention.

The first command line argument is the name of the JBossCache configuration file to be utilized for configuration of the cache. Only the name of the configuration file is necessary as it is read off of the classpath.

If a configuration file is not specified on the command line, jboss-cache.xml will be the assumed file name.

All command line arguments after the first are ignored.