Clearspace API (1.10.16) Core Javadocs

com.jivesoftware.community.event
Class SearchIndexEventDispatcher

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

public class SearchIndexEventDispatcher
extends java.lang.Object

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

For example, to register the com.acme.CustomSearchIndexListener 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.SearchIndexListener.customSearchIndexListener", "com.acme.CustomSearchIndexListener.class"); // now add it for this runtime instance SearchIndexEventDispatcher.addListener(new com.acme.CustomerSearchIndexListener());


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

Method Detail

getInstance

public static SearchIndexEventDispatcher getInstance()

addListener

public void addListener(SearchIndexListener listener)

removeListener

public void removeListener(SearchIndexListener listener)

destroy

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


dispatchEvent

public void dispatchEvent(SearchIndexEvent event)

Clearspace Project Page

Copyright © 1999-2007 Jive Software.