org.opencms.search

Class CmsSearchManager.CmsSearchOfflineIndexThread

java.lang.Object

java.lang.Thread

org.opencms.search.CmsSearchManager.CmsSearchOfflineIndexThread

All Implemented Interfaces:

java.lang.Runnable

Enclosing class:

CmsSearchManager

protected class CmsSearchManager.CmsSearchOfflineIndexThread
extends java.lang.Thread

The offline indexer thread runs periodically and indexes all resources added by the event handler.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CmsSearchOfflineIndexThread(CmsSearchManager.CmsSearchOfflineHandler handler) Constructor.

Method Summary

Modifier and Type	Method and Description
protected java.util.List<CmsPublishedResource>	getResourcesToIndex() Obtains the list of resource to update in the offline index, then optimizes the list by removing duplicate entries.
CmsWaitHandle	getWaitHandle() Gets the wait handle used for signalling when the worker thread has finished.
void	interrupt()
void	run()
protected void	shutDown() Shuts down this offline index thread.
void	start()
protected void	startOfflineUpdateThread(I_CmsReport report, java.util.List<CmsPublishedResource> resourcesToIndex) Updates the offline search indexes for the given list of resources.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsSearchOfflineIndexThread

protected CmsSearchOfflineIndexThread(CmsSearchManager.CmsSearchOfflineHandler handler)

Constructor.

Parameters:

handler - the offline index event handler

Method Detail

getWaitHandle

public CmsWaitHandle getWaitHandle()

Gets the wait handle used for signalling when the worker thread has finished.

Returns:

the wait handle

interrupt

public void interrupt()

Overrides:

interrupt in class java.lang.Thread

See Also:

Thread.interrupt()

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

See Also:

Thread.run()

start

public void start()

Overrides:

start in class java.lang.Thread

See Also:

Thread.start()

getResourcesToIndex

protected java.util.List<CmsPublishedResource> getResourcesToIndex()

Obtains the list of resource to update in the offline index, then optimizes the list by removing duplicate entries.

Returns:

the list of resource to update in the offline index

shutDown

protected void shutDown()

Shuts down this offline index thread.

startOfflineUpdateThread

protected void startOfflineUpdateThread(I_CmsReport report,
                                        java.util.List<CmsPublishedResource> resourcesToIndex)

Updates the offline search indexes for the given list of resources.

Parameters:

report - the report to write the index information to

resourcesToIndex - the list of CmsPublishedResource objects to index