Clearspace API (1.10.16) Core Javadocs

com.jivesoftware.community.event
Class EmailEventDispatcher

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

public class EmailEventDispatcher
extends java.lang.Object

Dispatcher for EmailEvents. Register EmailListeners at runtime using the addListener(com.jivesoftware.community.event.EmailListener) method, or add a child Jive Property to the key "eventListeners.EmailListener" to register a listener that will persist across restarts.

For example, to register the com.acme.CustomEmailListener 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.EmailListener.customEmailListener", "com.acme.CustomEmailListener.class"); // now add it for this runtime instance EmailEventDispatcher.addListener(new com.acme.CustomerEmailListener());


Method Summary
 void addListener(com.jivesoftware.community.event.EmailListener listener)
           
static void destroy()
          Destroy dispatcher.
 void dispatchEvent(EmailEvent event)
           
static EmailEventDispatcher getInstance()
           
 void removeListener(com.jivesoftware.community.event.EmailListener listener)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static EmailEventDispatcher getInstance()

addListener

public void addListener(com.jivesoftware.community.event.EmailListener listener)

removeListener

public void removeListener(com.jivesoftware.community.event.EmailListener listener)

destroy

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


dispatchEvent

public void dispatchEvent(EmailEvent event)

Clearspace Project Page

Copyright © 1999-2007 Jive Software.