org.opencms.search
Class CmsIndexingThreadManager

java.lang.Object
  extended by org.opencms.search.CmsIndexingThreadManager

public class CmsIndexingThreadManager
extends java.lang.Object

Implements the management of indexing threads.

Since:
6.0.0
Version:
$Revision: 1.35 $
Author:
Carsten Weinholz, Alexander Kandzior

Constructor Summary
CmsIndexingThreadManager(long timeout, int maxModificationsBeforeCommit)
          Creates and starts a thread manager for indexing threads.
 
Method Summary
 void createIndexingThread(CmsObject cms, org.apache.lucene.index.IndexWriter writer, CmsResource res, CmsSearchIndex index, I_CmsReport report)
          Creates and starts a new indexing thread for a resource.
 int getCounter()
          Gets the current thread (file) count.
 boolean isRunning()
          Returns if the indexing manager still have indexing threads.
 void reportStatistics(I_CmsReport report)
          Writes statistical information to the report.
 void run()
          Starts the thread manager to look for non-terminated threads The thread manager looks all 10 minutes if threads are not returned and reports the number to the log file.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

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 Detail

createIndexingThread

public void createIndexingThread(CmsObject cms,
                                 org.apache.lucene.index.IndexWriter writer,
                                 CmsResource res,
                                 CmsSearchIndex index,
                                 I_CmsReport report)
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:
cms - the cms object
writer - the write to write the index
res - the resource
index - the index
report - the report to write the indexing progress to

getCounter

public int getCounter()
Gets the current thread (file) count.

Returns:
the current thread count

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

run

public void run()
Starts the thread manager to look for non-terminated threads

The thread manager looks all 10 minutes if threads are not returned and reports the number to the log file.

See Also:
Runnable.run()