Package org.opencms.search

Class CmsSearchManager.CmsSearchOfflineHandler

java.lang.Object

org.opencms.search.CmsSearchManager.CmsSearchOfflineHandler

All Implemented Interfaces:

I_CmsEventListener

Enclosing class:

CmsSearchManager

protected class CmsSearchManager.CmsSearchOfflineHandler
extends Object
implements I_CmsEventListener

Handles offline index generation.

Field Summary

Fields inherited from interface org.opencms.main.I_CmsEventListener

EVENT_BEFORE_PUBLISH_PROJECT, EVENT_CLEAR_CACHES, EVENT_CLEAR_OFFLINE_CACHES, EVENT_CLEAR_ONLINE_CACHES, EVENT_CLEAR_PRINCIPAL_CACHES, EVENT_FLEX_CACHE_CLEAR, EVENT_FLEX_PURGE_JSP_REPOSITORY, EVENT_FULLSTATIC_EXPORT, EVENT_GROUP_MODIFIED, EVENT_LOGIN_USER, EVENT_OU_MODIFIED, EVENT_PROJECT_MODIFIED, EVENT_PROPERTY_DEFINITION_CREATED, EVENT_PROPERTY_DEFINITION_MODIFIED, EVENT_PROPERTY_MODIFIED, EVENT_PUBLISH_PROJECT, EVENT_REBUILD_SEARCHINDEXES, EVENT_REINDEX_OFFLINE, EVENT_REINDEX_ONLINE, EVENT_RESOURCE_AND_PROPERTIES_MODIFIED, EVENT_RESOURCE_COPIED, EVENT_RESOURCE_CREATED, EVENT_RESOURCE_DELETED, EVENT_RESOURCE_MODIFIED, EVENT_RESOURCE_MOVED, EVENT_RESOURCES_AND_PROPERTIES_MODIFIED, EVENT_RESOURCES_MODIFIED, EVENT_SITEMAP_CHANGED, EVENT_UPDATE_EXPORTS, EVENT_USER_MODIFIED, KEY_CHANGE, KEY_DBCONTEXT, KEY_GROUP_ID, KEY_GROUP_NAME, KEY_INDEX_NAMES, KEY_IS_ONLINE, KEY_OU_ID, KEY_OU_NAME, KEY_PROJECTID, KEY_PUBLISHID, KEY_PUBLISHLIST, KEY_REINDEX_RELATED, KEY_REPORT, KEY_RESOURCE, KEY_RESOURCES, KEY_SKIPINDEX, KEY_USER_ACTION, KEY_USER_CHANGES, KEY_USER_ID, KEY_USER_NAME, LISTENERS_FOR_ALL_EVENTS, VALUE_CREATE_SIBLING, VALUE_GROUP_MODIFIED_ACTION_CREATE, VALUE_GROUP_MODIFIED_ACTION_DELETE, VALUE_GROUP_MODIFIED_ACTION_WRITE, VALUE_OU_MODIFIED_ACTION_CREATE, VALUE_OU_MODIFIED_ACTION_DELETE, VALUE_USER_MODIFIED_ACTION_ADD_USER_TO_GROUP, VALUE_USER_MODIFIED_ACTION_CREATE_USER, VALUE_USER_MODIFIED_ACTION_DELETE_USER, VALUE_USER_MODIFIED_ACTION_REMOVE_USER_FROM_GROUP, VALUE_USER_MODIFIED_ACTION_RESET_PASSWORD, VALUE_USER_MODIFIED_ACTION_SET_OU, VALUE_USER_MODIFIED_ACTION_WRITE_USER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CmsSearchOfflineHandler()	Initializes the offline index handler.

Method Summary

Modifier and Type	Method	Description
protected void	addResourcesToIndex(List<CmsPublishedResource> resourcesToIndex)	Adds a list of CmsPublishedResource objects to be indexed.
void	cmsEvent(CmsEvent event)	Implements the event listener of this class.
protected List<CmsPublishedResource>	getResourcesToIndex()	Returns the list of CmsPublishedResource objects to index.
protected void	initialize()	Initializes this offline search handler, registering the event handlers if required.
protected void	reIndexResources(List<CmsResource> resources)	Updates all offline indexes for the given list of CmsResource objects.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsSearchOfflineHandler

protected CmsSearchOfflineHandler()

Initializes the offline index handler.

Method Details

cmsEvent

public void cmsEvent(CmsEvent event)

Implements the event listener of this class.

Specified by:

cmsEvent in interface I_CmsEventListener

Parameters:

event - CmsEvent that has occurred

See Also:

• I_CmsEventListener.cmsEvent(org.opencms.main.CmsEvent)

addResourcesToIndex

protected void addResourcesToIndex(List<CmsPublishedResource> resourcesToIndex)

Adds a list of CmsPublishedResource objects to be indexed.

Parameters:

resourcesToIndex - the list of CmsPublishedResource objects to be indexed

getResourcesToIndex

protected List<CmsPublishedResource> getResourcesToIndex()

Returns the list of CmsPublishedResource objects to index.

Returns:

the resources to index

initialize

protected void initialize()

Initializes this offline search handler, registering the event handlers if required.

reIndexResources

protected void reIndexResources(List<CmsResource> resources)

Updates all offline indexes for the given list of CmsResource objects.

Parameters:

resources - a list of CmsResource objects to update in the offline indexes