Clearspace API (2.5.29) Core Javadocs

com.jivesoftware.community.event
Class CommunityEventDispatcher

java.lang.Object
  extended by com.jivesoftware.community.event.CommunityEventDispatcher

public class CommunityEventDispatcher
extends Object

Dispatcher for CommunityEvents. Register CommunityListeners at runtime using the addListener(CommunityListener) method, or add a child Jive Property to the key "eventListeners.CommunityListener" to register a listener that will persist across restarts.

For example, to register the com.acme.CustomCommunityListener class as a persistent listener the following code could be used: // add persistent key to have the listener loaded and registered automatically at startup JiveGlobals.setJiveProperty("eventListeners.CommunityListener.customCommunityListener", "com.acme.CustomCommunityListener.class"); // now add it for this runtime instance CommunityEventDispatcher.addListener(new com.acme.CustomerCommunityListener());


Method Summary
 void addListener(CommunityListener listener)
           
static void destroy()
          Destroy dispatcher.
 void dispatchEvent(CommunityEvent event)
           
static CommunityEventDispatcher getInstance()
           
 void removeListener(CommunityListener listener)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static CommunityEventDispatcher getInstance()

addListener

public void addListener(CommunityListener listener)

removeListener

public void removeListener(CommunityListener listener)

destroy

public static void destroy()
Destroy dispatcher. Intended to be used primarily during testing.


dispatchEvent

public void dispatchEvent(CommunityEvent event)

Clearspace Project Page

Copyright © 1999-2007 Jive Software.