com.jivesoftware.forum.database
Class DbSearchManager

java.lang.Object
  com.jivesoftware.forum.database.DbSearchManager

All Implemented Interfaces:

JiveManager, ForumListener, MessageListener, ThreadListener, SearchManager

public class DbSearchManager
extends java.lang.Object
implements SearchManager, JiveManager, MessageListener, ThreadListener, ForumListener

Database implementation of SearchManager using the Lucene search package. Search indexes are stored in the "search" subdirectory of jiveHome.

Every 12 hours, a task will be run automatically to optimize the search index. Optimizes are also run right after index rebuilds.

Field Summary

static java.lang.String	BRAZILIAN_ANALYZER The brazlian analyzer provides for stemming of words to allow for flexibility in searching when most content is in Brazilian.
static java.lang.String	CJK_ANALYZER The CJK analyzer is a good choice for Chinese, Japanese and Korean.
static java.lang.String	CZECH_ANALYZER The Czech analyzer provides a good choice for Czech
static java.lang.String	DANISH_ANALYZER The danish analyzer provides for stemming of words to allow for flexibility in searching when most content is in Danish.
static java.lang.String	DUTCH_ANALYZER The danish analyzer provides for stemming of words to allow for flexibility in searching when most content is in Danish.
static java.lang.String	ENGLISH_ANALYZER The english analyzer provides for stemming of words to allow for flexibility in searching when most content is in English.
static java.lang.String	FINNISH_ANALYZER The finnish analyzer provides for stemming of words to allow for flexibility in searching when most content is in Finnish.
static java.lang.String	FRENCH_ANALYZER The french analyzer provides for stemming of words to allow for flexibility in searching when most content is in German.
static java.lang.String	GERMAN_ANALYZER The german analyzer provides for stemming of words to allow for flexibility in searching when most content is in German.
protected static org.apache.lucene.analysis.Analyzer	indexerAnalyzer The analyzer governs how words are tokenized.
static java.lang.String	ITALIAN_ANALYZER The italian analyzer provides for stemming of words to allow for flexibility in searching when most content is in Italian.
static java.lang.String	NORWEGIAN_ANALYZER The norwegian analyzer provides for stemming of words to allow for flexibility in searching when most content is in Norwegian.
static java.lang.String	PORTUGUESE_ANALYZER The portuguese analyzer provides for stemming of words to allow for flexibility in searching when most content is in Portuguese.
static java.lang.String	RUSSIAN_ANALYZER The russian analyzer provides for stemming of words to allow for flexibility in searching when most content is in Russian.
protected static org.apache.lucene.analysis.Analyzer	searcherAnalyzer The analyzer governs how words are tokenized.
protected static ReadWriteLock	searcherLock Lock object used for controlling searches while modifying the index
static java.lang.String	SPANISH_ANALYZER The spanish analyzer provides for stemming of words to allow for flexibility in searching when most content is in Spanish.
static java.lang.String	STANDARD_ANALYZER The standard analyzer provides good indexing for western languages.
static java.lang.String	SWEDISH_ANALYZER The swedish analyzer provides for stemming of words to allow for flexibility in searching when most content is in Swedish.

Method Summary

protected void	addMessageToIndex(com.jivesoftware.forum.database.DbSearchManager.MessageBean bean, org.apache.lucene.index.IndexWriter writer) Indexes an individual message.
void	addTextExtractor(java.lang.String className) Installs a new class into the list of available text extractors for the system.
void	addToIndex(ForumMessage message) Adds an individual message to the index.
void	addToIndex(ForumMessage message, boolean cluster)
protected void	deleteMessagesFromIndex(long[] messages, org.apache.lucene.index.IndexReader reader) Deletes a message from the index.
void	destroy() Notifies the manager to release any resources that may be holding on too.
void	forumAdded(ForumEvent event) Fired when a forum has been added to the system.
void	forumDeleted(ForumEvent event) Fired when a forum is about to be deleted from the system.
void	forumMerged(ForumEvent event) Fired when a forum is merged into another forum.
void	forumModified(ForumEvent event) Fired when a forum is modified.
void	forumMoved(ForumEvent event) Fired when a forum has been moved from one category to another.
static java.lang.String	getAnalyzer() Returns the Lucene analyzer class that is be used for indexing.
int	getAutoIndexInterval() Creates a new DbSearchIndexer.
int	getCurrentCount() Returns the number of entries that have been indexed if an indexing operation is currently active (i.e., SearchManager.isBusy() returns true).
static DbSearchManager	getInstance()
java.util.Date	getLastIndexedDate() Returns the date that the last update to the index was made.
int	getPercentComplete() Returns the percent complete that an indexing operation is if an indexing operation is currently active (i.e., SearchManager.isBusy() returns true).
static XMLJiveProperties	getProperties()
TextExtractor[]	getTextExtractors() Returns the current array of TextExtractor objects.
int	getTotalCount() Returns the total number of entries that are to be indexed if an indexing operation is currently active (i.e., SearchManager.isBusy() returns true).
void	initialize() Initialize the manager.
boolean	isAttachmentSearchEnabled() Returns true if the attachment search feature is turned on.
boolean	isAutoIndexEnabled() Returns true if auto indexing is turned on.
boolean	isBusy() Returns true if the search manager is currently busy with an search indexing task.
boolean	isFilterHTMLEnabled() Determines whether to filter out HTML when indexing and retrieving messages.
static boolean	isSearchClusterEnabled() Returns true when searches are being actually performed in the search cluster.
boolean	isSearchEnabled() Returns true if the search feature is turned on.
boolean	isWildcardIgnored() Returns true if wildcarding is disabled.
void	messageAdded(MessageEvent event) Fired when a message has been added to the system.
void	messageDeleted(MessageEvent event) Fired when a message is about to be deleted from the system.
void	messageModerationModified(MessageEvent event) Fired when the moderation value of a message has been changed.
void	messageModified(MessageEvent event) Fired when portions of a message have been modified.
void	messageMoved(MessageEvent event) Fired when a message is moved to another thread.
void	messageRated(MessageEvent event) Fired when a message has been rated.
void	optimize() Optimizes the underlying search index for maximum speed.
void	rebuildIndex() Manually rebuild the entire index.
void	removeFromIndex(Forum forum) Removes a forum from the index.
void	removeFromIndex(Forum forum, boolean cluster)
void	removeFromIndex(ForumMessage message) Removes an individual message from the index.
void	removeFromIndex(ForumMessage message, boolean cluster)
void	removeFromIndex(ForumThread thread) Removes a thread from the index.
void	removeFromIndex(ForumThread thread, boolean cluster)
void	removeTextExtractor(java.lang.String className) Removes an existing text extractor from the list of current text extractors.
static void	setAnalyzer(java.lang.String className) Sets the Lucene analyzer class that is used for indexing.
void	setAttachmentSearchEnabled(boolean attachmentSearchEnabled) Enables or disables the attachment search feature.
void	setAutoIndexEnabled(boolean enabled) Enables or disables auto indexing.
void	setAutoIndexInterval(int minutes) Sets the amount of time that indexer should wait between updating the index.
void	setFilterHTMLEnabled(boolean filterHTMLEnabled) Set whether or not to index and display HTML within messages.
void	setSearchEnabled(boolean searchEnabled) Enables or disables the search feature.
void	setWildcardIgnored(boolean value) Turns on or off wildcarding.
void	threadAdded(ThreadEvent event) Fired when a thread has been added to the system.
void	threadDeleted(ThreadEvent event) Fired when a thread is about to be deleted from the system.
void	threadModerationModified(ThreadEvent event) Fired when the moderation value of a thread has been changed.
void	threadMoved(ThreadEvent event) Fired when a thread is moved from one foru to another.
void	threadRated(ThreadEvent event) Fired when the thread has been rated.
void	updateIndex() Manually update the index to include all new messages since the last update.
protected void	updateIndex(java.util.Date start, java.util.Date end) Updates the index.

Methods inherited from class java.lang.Object

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

Field Detail

STANDARD_ANALYZER

public static final java.lang.String STANDARD_ANALYZER

The standard analyzer provides good indexing for western languages. This is the default analyzer if another is not specified.

See Also:

Constant Field Values

BRAZILIAN_ANALYZER

public static final java.lang.String BRAZILIAN_ANALYZER

The brazlian analyzer provides for stemming of words to allow for flexibility in searching when most content is in Brazilian. Note that stemming might cause odd behavior if the language being searched isn't Brazilian.

See Also:

Constant Field Values

CJK_ANALYZER

public static final java.lang.String CJK_ANALYZER

The CJK analyzer is a good choice for Chinese, Japanese and Korean.

See Also:

Constant Field Values

CZECH_ANALYZER

public static final java.lang.String CZECH_ANALYZER

The Czech analyzer provides a good choice for Czech

See Also:

Constant Field Values

DANISH_ANALYZER

public static final java.lang.String DANISH_ANALYZER

The danish analyzer provides for stemming of words to allow for flexibility in searching when most content is in Danish. Note that stemming might cause odd behavior if the language being searched isn't Danish.

See Also:

Constant Field Values

DUTCH_ANALYZER

public static final java.lang.String DUTCH_ANALYZER

The danish analyzer provides for stemming of words to allow for flexibility in searching when most content is in Danish. Note that stemming might cause odd behavior if the language being searched isn't Danish.

See Also:

Constant Field Values

ENGLISH_ANALYZER

public static final java.lang.String ENGLISH_ANALYZER

The english analyzer provides for stemming of words to allow for flexibility in searching when most content is in English. Note that stemming might cause odd behavior if the language being searched isn't English.

See Also:

Constant Field Values

FINNISH_ANALYZER

public static final java.lang.String FINNISH_ANALYZER

The finnish analyzer provides for stemming of words to allow for flexibility in searching when most content is in Finnish. Note that stemming might cause odd behavior if the language being searched isn't Finnish.

See Also:

Constant Field Values

FRENCH_ANALYZER

public static final java.lang.String FRENCH_ANALYZER

The french analyzer provides for stemming of words to allow for flexibility in searching when most content is in German. Note that stemming might cause odd behavior if the language being searched isn't German.

See Also:

Constant Field Values

GERMAN_ANALYZER

public static final java.lang.String GERMAN_ANALYZER

The german analyzer provides for stemming of words to allow for flexibility in searching when most content is in German. Note that stemming might cause odd behavior if the language being searched isn't German.

See Also:

Constant Field Values

ITALIAN_ANALYZER

public static final java.lang.String ITALIAN_ANALYZER

The italian analyzer provides for stemming of words to allow for flexibility in searching when most content is in Italian. Note that stemming might cause odd behavior if the language being searched isn't Italian.

See Also:

Constant Field Values

NORWEGIAN_ANALYZER

public static final java.lang.String NORWEGIAN_ANALYZER

The norwegian analyzer provides for stemming of words to allow for flexibility in searching when most content is in Norwegian. Note that stemming might cause odd behavior if the language being searched isn't Norwegian.

See Also:

Constant Field Values

PORTUGUESE_ANALYZER

public static final java.lang.String PORTUGUESE_ANALYZER

The portuguese analyzer provides for stemming of words to allow for flexibility in searching when most content is in Portuguese. Note that stemming might cause odd behavior if the language being searched isn't Portuguese.

See Also:

Constant Field Values

RUSSIAN_ANALYZER

public static final java.lang.String RUSSIAN_ANALYZER

The russian analyzer provides for stemming of words to allow for flexibility in searching when most content is in Russian. Note that stemming might cause odd behavior if the language being searched isn't Russian.

See Also:

Constant Field Values

SPANISH_ANALYZER

public static final java.lang.String SPANISH_ANALYZER

The spanish analyzer provides for stemming of words to allow for flexibility in searching when most content is in Spanish. Note that stemming might cause odd behavior if the language being searched isn't Spanish.

See Also:

Constant Field Values

SWEDISH_ANALYZER

public static final java.lang.String SWEDISH_ANALYZER

The swedish analyzer provides for stemming of words to allow for flexibility in searching when most content is in Swedish. Note that stemming might cause odd behavior if the language being searched isn't Swedish.

See Also:

Constant Field Values

indexerAnalyzer

protected static org.apache.lucene.analysis.Analyzer indexerAnalyzer

The analyzer governs how words are tokenized. We make the analyzer protected so that the DbQuery class can also reference it (indexing and searching should use the same analyzer).

searcherAnalyzer

protected static org.apache.lucene.analysis.Analyzer searcherAnalyzer

The analyzer governs how words are tokenized. There is a seperate analyzer for searching because searching requires that synonyms be disabled, while indexing requires that they be enabled.

searcherLock

protected static ReadWriteLock searcherLock

Lock object used for controlling searches while modifying the index

Method Detail

isSearchClusterEnabled

public static boolean isSearchClusterEnabled()

Returns true when searches are being actually performed in the search cluster. Otherwise, return false since searches are being run in the application server.

Returns:

true when searches are being actually performed in the search cluster.

getInstance

public static DbSearchManager getInstance()

initialize

public void initialize()

Description copied from interface: JiveManager

Initialize the manager. It is within this method that it is ok to create, access and/or otherwise use external classes (including caches). Until this method is called implementation should not access any external classes that could possibly either access one of the main Factory classes or any caches since doing so can cause deadlocks and possible clustering issues during startup.

This method is used internally by Jive during application startup and should not be called during normal usage of the class.

Specified by:

initialize in interface JiveManager

destroy

public void destroy()

Description copied from interface: JiveManager

Notifies the manager to release any resources that may be holding on too. This could also be used to clear out the managers caches, etc.

This method is used internally by Jive during application startup and should not be called during normal usage of the class.

Specified by:

destroy in interface JiveManager

getProperties

public static XMLJiveProperties getProperties()

getAnalyzer

public static java.lang.String getAnalyzer()

Returns the Lucene analyzer class that is be used for indexing. The following constant values are common values, but any valid analyzer may be used:

• STANDARD_ANALYZER (default)
• BRAZILIAN_ANALYZER
• CJK_ANALYZER
• CZECH_ANALYZER
• DANISH_ANALYZER
• DUTCH_ANALYZER
• ENGLISH_ANALYZER
• FINNISH_ANALYZER
• FRENCH_ANALYZER
• GERMAN_ANALYZER
• ITALIAN_ANALYZER
• NORWEGIAN_ANALYZER
• PORTUGUESE_ANALYZER
• RUSSIAN_ANALYZER
• SPANISH_ANALYZER
• SWEDISH_ANALYZER

The analyzer class name is stored as the Jive Property search.analyzer.className.

Returns:

the name of the analyzer class that is used for indexing.

setAnalyzer

public static void setAnalyzer(java.lang.String className)

Sets the Lucene analyzer class that is used for indexing. The following constant values are common values, but any valid analyzer may be used:

• STANDARD_ANALYZER (default)
• BRAZILIAN_ANALYZER
• CJK_ANALYZER
• CZECH_ANALYZER
• DANISH_ANALYZER
• DUTCH_ANALYZER
• ENGLISH_ANALYZER
• FINNISH_ANALYZER
• FRENCH_ANALYZER
• GERMAN_ANALYZER
• ITALIAN_ANALYZER
• NORWEGIAN_ANALYZER
• PORTUGUESE_ANALYZER
• RUSSIAN_ANALYZER
• SPANISH_ANALYZER
• SWEDISH_ANALYZER

Anytime the analyzer class is changed, the search index must be rebuilt for searching to work reliably. The analyzer class name is stored as the Jive Property search.analyzer.className.

Parameters:

className - the name of the analyzer class will be used for indexing.

getAutoIndexInterval

public int getAutoIndexInterval()

Creates a new DbSearchIndexer. It attempts to load properties for the update interval and when the last index occured from the Jive properties then starts the indexing thread.

Specified by:

getAutoIndexInterval in interface SearchManager

Returns:

the number of hours between automatic index updates.

setAutoIndexInterval

public void setAutoIndexInterval(int minutes)

Description copied from interface: SearchManager

Sets the amount of time that indexer should wait between updating the index.

Specified by:

setAutoIndexInterval in interface SearchManager

Parameters:

minutes - the number of minutes between automatic index updates.

getLastIndexedDate

public java.util.Date getLastIndexedDate()

Description copied from interface: SearchManager

Returns the date that the last update to the index was made.

Specified by:

getLastIndexedDate in interface SearchManager

Returns:

the date the last index update was made.

isSearchEnabled

public boolean isSearchEnabled()

Description copied from interface: SearchManager

Returns true if the search feature is turned on. When search is disabled, other methods serve as no-ops and auto indexing will not occur.

Specified by:

isSearchEnabled in interface SearchManager

Returns:

true if the search is enabled.

setSearchEnabled

public void setSearchEnabled(boolean searchEnabled)

Description copied from interface: SearchManager

Enables or disables the search feature. When search is disabled, other methods serve as no-ops and auto indexing will not occur.

Specified by:

setSearchEnabled in interface SearchManager

Parameters:

searchEnabled - true to enable the search feature, false to disable.

isAttachmentSearchEnabled

public boolean isAttachmentSearchEnabled()

Description copied from interface: SearchManager

Returns true if the attachment search feature is turned on. When attachment search is disabled, attachment data is not indexed.

Specified by:

isAttachmentSearchEnabled in interface SearchManager

Returns:

true if the attachments search is enabled.

setAttachmentSearchEnabled

public void setAttachmentSearchEnabled(boolean attachmentSearchEnabled)

Description copied from interface: SearchManager

Enables or disables the attachment search feature. When attachment search is disabled, attachment data is not indexed.

Specified by:

setAttachmentSearchEnabled in interface SearchManager

Parameters:

attachmentSearchEnabled - true to enable attachment search.

isFilterHTMLEnabled

public boolean isFilterHTMLEnabled()

Description copied from interface: SearchManager

Determines whether to filter out HTML when indexing and retrieving messages.

Specified by:

isFilterHTMLEnabled in interface SearchManager

Returns:

true if HTML should be filtered.

setFilterHTMLEnabled

public void setFilterHTMLEnabled(boolean filterHTMLEnabled)

Description copied from interface: SearchManager

Set whether or not to index and display HTML within messages.

Specified by:

setFilterHTMLEnabled in interface SearchManager

Parameters:

filterHTMLEnabled - true if HTML should be filtered.

getTextExtractors

public TextExtractor[] getTextExtractors()

Description copied from interface: SearchManager

Returns the current array of TextExtractor objects.

Specified by:

getTextExtractors in interface SearchManager

Returns:

an array of text extractors.

addTextExtractor

public void addTextExtractor(java.lang.String className)
                      throws java.lang.ClassNotFoundException

Description copied from interface: SearchManager

Installs a new class into the list of available text extractors for the system. Exceptions are thrown if you're not a system administrator, the class can't be loaded from the classpath, or the class isn't an instance of TextExtractor.

Specified by:

addTextExtractor in interface SearchManager

Parameters:

className - the fully qualified name of the text extractor.

Throws:

java.lang.ClassNotFoundException - if the class could not be loaded.

removeTextExtractor

public void removeTextExtractor(java.lang.String className)
                         throws java.lang.ClassNotFoundException

Description copied from interface: SearchManager

Removes an existing text extractor from the list of current text extractors.

Specified by:

removeTextExtractor in interface SearchManager

Parameters:

className - the fully qualified name of the text extractor to remove.

Throws:

java.lang.ClassNotFoundException - if the class could not be loaded.

isBusy

public boolean isBusy()

Description copied from interface: SearchManager

Returns true if the search manager is currently busy with an search indexing task. When busy, calls to index operations such as SearchManager.rebuildIndex() will do nothing. If you'd like to query the status of the indexing operation while the manager is busy, use the SearchManager.getPercentComplete() method.

Specified by:

isBusy in interface SearchManager

Returns:

true if the search manager is currently busy with an index maintenance task.

getPercentComplete

public int getPercentComplete()

Description copied from interface: SearchManager

Returns the percent complete that an indexing operation is if an indexing operation is currently active (i.e., SearchManager.isBusy() returns true). Valid percentages returned are from 0 to 100. If no indexing operation is active, this method will return -1.

Specified by:

getPercentComplete in interface SearchManager

Returns:

the percent complete that the currently active index operation is.

getTotalCount

public int getTotalCount()

Description copied from interface: SearchManager

Returns the total number of entries that are to be indexed if an indexing operation is currently active (i.e., SearchManager.isBusy() returns true).

Specified by:

getTotalCount in interface SearchManager

Returns:

the total number of entries that are to be indexed

getCurrentCount

public int getCurrentCount()

Description copied from interface: SearchManager

Returns the number of entries that have been indexed if an indexing operation is currently active (i.e., SearchManager.isBusy() returns true).

Specified by:

getCurrentCount in interface SearchManager

Returns:

the number of entries that have been indexed

isWildcardIgnored

public boolean isWildcardIgnored()

Description copied from interface: SearchManager

Returns true if wildcarding is disabled. When wildcarding is disabled, characters such as *, ?, and ~ are simply ignored.

Specified by:

isWildcardIgnored in interface SearchManager

Returns:

true if wildcards are ignored.

setWildcardIgnored

public void setWildcardIgnored(boolean value)

Description copied from interface: SearchManager

Turns on or off wildcarding. When wildcarding is disabled, characters such as *, ?, and ~ are simply ignored.

Specified by:

setWildcardIgnored in interface SearchManager

Parameters:

value - true if wildcards are to be ignored. false enables wildcard search.

isAutoIndexEnabled

public boolean isAutoIndexEnabled()

Description copied from interface: SearchManager

Returns true if auto indexing is turned on. When auto indexing is on, it will update the search index at the interval specified by the setUpdateInterval method.

Specified by:

isAutoIndexEnabled in interface SearchManager

Returns:

true if auto indexing is turned on.

setAutoIndexEnabled

public void setAutoIndexEnabled(boolean enabled)

Description copied from interface: SearchManager

Enables or disables auto indexing. When auto indexing is on, it will update the search index at the interval specified by the setUpdateInterval method.

Specified by:

setAutoIndexEnabled in interface SearchManager

Parameters:

enabled - true to turn auto indexing on, false to turn it off.

addToIndex

public void addToIndex(ForumMessage message)

Description copied from interface: SearchManager

Adds an individual message to the index. This method is useful for doing real-time indexing. However, for maximum posting speed this method can be ignored. In that case, the automatic indexer will pick up all new messages at the next index interval.

Specified by:

addToIndex in interface SearchManager

Parameters:

message - the message to add to the index.

addToIndex

public void addToIndex(ForumMessage message,
                       boolean cluster)

removeFromIndex

public void removeFromIndex(ForumMessage message)

Description copied from interface: SearchManager

Removes an individual message from the index.

Specified by:

removeFromIndex in interface SearchManager

Parameters:

message - the message to remove from the index.

removeFromIndex

public void removeFromIndex(ForumMessage message,
                            boolean cluster)

removeFromIndex

public void removeFromIndex(ForumThread thread)

Description copied from interface: SearchManager

Removes a thread from the index.

Specified by:

removeFromIndex in interface SearchManager

Parameters:

thread - the thread to remove from the index.

removeFromIndex

public void removeFromIndex(ForumThread thread,
                            boolean cluster)

removeFromIndex

public void removeFromIndex(Forum forum)

Description copied from interface: SearchManager

Removes a forum from the index.

Specified by:

removeFromIndex in interface SearchManager

Parameters:

forum - the forum to remove from the index.

removeFromIndex

public void removeFromIndex(Forum forum,
                            boolean cluster)

updateIndex

public void updateIndex()

Description copied from interface: SearchManager

Manually update the index to include all new messages since the last update.

Specified by:

updateIndex in interface SearchManager

rebuildIndex

public void rebuildIndex()

Description copied from interface: SearchManager

Manually rebuild the entire index. This operation can be slow if the index is large.

Specified by:

rebuildIndex in interface SearchManager

optimize

public void optimize()

Description copied from interface: SearchManager

Optimizes the underlying search index for maximum speed. This operation may be CPU intensive so should be performed relatively infrequently. Rebuilding an index should automatically optimize it.

Specified by:

optimize in interface SearchManager

updateIndex

protected final void updateIndex(java.util.Date start,
                                 java.util.Date end)

Updates the index. It first deletes any messages in the index between the start and end times, and then adds all messages to the index that are between the start and end times.

addMessageToIndex

protected final void addMessageToIndex(com.jivesoftware.forum.database.DbSearchManager.MessageBean bean,
                                       org.apache.lucene.index.IndexWriter writer)
                                throws java.io.IOException

Indexes an individual message. The writer is assumed to be open when passed in and will remain open after the method is done executing.

Throws:

java.io.IOException

deleteMessagesFromIndex

protected final void deleteMessagesFromIndex(long[] messages,
                                             org.apache.lucene.index.IndexReader reader)
                                      throws java.io.IOException

Deletes a message from the index.

Throws:

java.io.IOException

messageAdded

public void messageAdded(MessageEvent event)

Description copied from interface: MessageListener

Fired when a message has been added to the system. Care should be taken with this event type since a message being added may need to go through a moderation process before it becomes visible in a forum. Therefore, actions that should only be triggered after moderation has taken place should use the message moderation modified event type instead.

Specified by:

messageAdded in interface MessageListener

Parameters:

event - the event object.

messageDeleted

public void messageDeleted(MessageEvent event)

Description copied from interface: MessageListener

Fired when a message is about to be deleted from the system. This event will only be fired when an individual message is deleted; it is not fired when the thread or forum that contains the message is deleted. Because various code pieces may depend on this event for performing cleanup tasks, it's guaranteed that this method will be called before the message is deleted from the database.

Specified by:

messageDeleted in interface MessageListener

Parameters:

event - the event object.

messageModified

public void messageModified(MessageEvent event)

Description copied from interface: MessageListener

Fired when portions of a message have been modified.

Specified by:

messageModified in interface MessageListener

Parameters:

event - the event object.

messageModerationModified

public void messageModerationModified(MessageEvent event)

Description copied from interface: MessageListener

Fired when the moderation value of a message has been changed.

Specified by:

messageModerationModified in interface MessageListener

Parameters:

event - the event object.

messageRated

public void messageRated(MessageEvent event)

Description copied from interface: MessageListener

Fired when a message has been rated.

Specified by:

messageRated in interface MessageListener

Parameters:

event - the event object.

messageMoved

public void messageMoved(MessageEvent event)

Description copied from interface: MessageListener

Fired when a message is moved to another thread. This happens when a thread is branched such that a message and its children become a new thread.

Specified by:

messageMoved in interface MessageListener

Parameters:

event - the event object.

threadAdded

public void threadAdded(ThreadEvent event)

Description copied from interface: ThreadListener

Fired when a thread has been added to the system.

Specified by:

threadAdded in interface ThreadListener

Parameters:

event - the event object.

threadDeleted

public void threadDeleted(ThreadEvent event)

Description copied from interface: ThreadListener

Fired when a thread is about to be deleted from the system. This event will only be fired when an individual thread is deleted; it is not fired when the forum that contains the thread is deleted. Because various code pieces may depend on this event for performing cleanup tasks, it's guaranteed that this method will be called before the thread is deleted from the database.

Specified by:

threadDeleted in interface ThreadListener

Parameters:

event - the event object.

threadMoved

public void threadMoved(ThreadEvent event)

Description copied from interface: ThreadListener

Fired when a thread is moved from one foru to another.

Specified by:

threadMoved in interface ThreadListener

Parameters:

event - the event object.

threadModerationModified

public void threadModerationModified(ThreadEvent event)

Description copied from interface: ThreadListener

Fired when the moderation value of a thread has been changed.

Specified by:

threadModerationModified in interface ThreadListener

Parameters:

event - the event object.

threadRated

public void threadRated(ThreadEvent event)

Description copied from interface: ThreadListener

Fired when the thread has been rated.

Specified by:

threadRated in interface ThreadListener

Parameters:

event - the event object.

forumAdded

public void forumAdded(ForumEvent event)

Description copied from interface: ForumListener

Fired when a forum has been added to the system.

Specified by:

forumAdded in interface ForumListener

Parameters:

event - the event object.

forumDeleted

public void forumDeleted(ForumEvent event)

Description copied from interface: ForumListener

Fired when a forum is about to be deleted from the system. This event will be fired when an individual forum is deleted or when the forum's category is deleted. Because various code pieces may depend on this event for performing cleanup tasks, it's guaranteed that this method will be called before the forum is deleted from the database.

Specified by:

forumDeleted in interface ForumListener

Parameters:

event - the event object.

forumModified

public void forumModified(ForumEvent event)

Description copied from interface: ForumListener

Fired when a forum is modified.

Specified by:

forumModified in interface ForumListener

Parameters:

event - the event object.

forumMoved

public void forumMoved(ForumEvent event)

Description copied from interface: ForumListener

Fired when a forum has been moved from one category to another.

Specified by:

forumMoved in interface ForumListener

Parameters:

event - the event object.

forumMerged

public void forumMerged(ForumEvent event)

Description copied from interface: ForumListener

Fired when a forum is merged into another forum.

Specified by:

forumMerged in interface ForumListener

Parameters:

event - the event object.