Package org.opencms.search

Class CmsIndexingThreadManager

java.lang.Object

org.opencms.search.CmsIndexingThreadManager

public class CmsIndexingThreadManager
extends Object

Implements the management of indexing threads.

Since:

6.0.0

Constructor Summary

Constructors

Constructor	Description
CmsIndexingThreadManager(long timeout, int maxModificationsBeforeCommit)	Creates and starts a thread manager for indexing threads.

Method Summary

Modifier and Type	Method	Description
void	createIndexingThread(CmsVfsIndexer indexer, I_CmsIndexWriter writer, CmsResource res)	Creates and starts a new indexing thread for a resource.
boolean	isRunning()	Returns if the indexing manager still have indexing threads.
void	reportStatistics(I_CmsReport report)	Writes statistical information to the report.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsIndexingThreadManager

public CmsIndexingThreadManager(long timeout,
 int maxModificationsBeforeCommit)

Creates and starts a thread manager for indexing threads.

Parameters:

timeout - timeout after a thread is abandoned

maxModificationsBeforeCommit - the maximum number of modifications before a commit in the search index is triggered

Method Details

createIndexingThread

public void createIndexingThread(CmsVfsIndexer indexer,
 I_CmsIndexWriter writer,
 CmsResource res)

Creates and starts a new indexing thread for a resource.

After an indexing thread was started, the manager suspends itself and waits for an amount of time specified by the timeout value. If the timeout value is reached, the indexing thread is aborted by an interrupt signal.

Parameters:

indexer - the VFS indexer to create the index thread for

writer - the index writer that can update the index

res - the resource

isRunning

public boolean isRunning()

Returns if the indexing manager still have indexing threads.

Returns:

true if the indexing manager still have indexing threads

reportStatistics

public void reportStatistics(I_CmsReport report)

Writes statistical information to the report.

The method reports the total number of threads started (equals to the number of indexed files), the number of returned threads (equals to the number of successfully indexed files), and the number of abandoned threads (hanging threads reaching the timeout).

Parameters:

report - the report to write the statistics to