Package com.sapportals.wcm.service.indexmanagement

Provides a service for managing indexes.

See:
Description

Interface Summary

IIndex	Represents a generic index object of the index management service.
IIndexFolder	Folder that is attached to an index.
IIndexFolderIterator	Iterator for a IIndexFolderList list
IIndexFolderList	List of IIndexFolders.
IIndexService	Manages the indexes of the content management system.
IIndexServiceCrawler	Indicates that an object is a crawler in the index management service.
IIndexServiceEvent	This event is send by the index management event mapper to the indexmanagement service if another service sent an event.
ISupportedOptionSet	Provides access to a set of supported options for a index.
ITaskQueueHandler	The handler puts index management tasks into the task queue of the task queue service and reads index management tasks from the task queue to execute them.
IWcmIndexConst	Constants of the index management service

Class Summary

AbstractIndex	Generic index class, which must be extended by a specialized index implementation.
AbstractIndex.ErrorState
AbstractIndex.IndexingState
AbstractIndex.RunningState
AbstractIndex.WhatToIndex
AbstractIndexCollection	Collection of indexes.
IndexFolder	Folder that is attached to an index
IndexFolderIterator	Iterator for an IIndexFolderList list
IndexFolderList	List of index folders
IndexServiceEvent	This event is send by the event mapper if another service send an event.
SupportedOption	Options supported by an index.
SupportedOptionSet	A set of supported operations for a resource

Exception Summary

CommunicationException	Indicates that the communication with another server failed because of an error.
IndexDoesNotExistOnServerException	Indicates that an index doesnt exist on the index server.
IndexInactiveException	Indicates that the requested action can not be performed because of an inactive index.
IndexNotReadyException	Indicates that the requested action can not be performed because of an busy index.

Package com.sapportals.wcm.service.indexmanagement Description

Provides a service for managing indexes.

Package Specification

Purpose
Configuration
Implementation Notes

Purpose

The index management service is used to manage and administer indexes. This is done in a generic way through the IIndexService (com.sapportals.wcm.service.indexmanagement.IIndexService) and IIndex (com.sapportals.wcm.service.indexmanagement.IIndex) interfaces. The actual functionality of an index is accessable through interfaces in sub packages. As an example the ISearchIndex interface (com.sapportals.wcm.service.indexmanagement.retieval.search.ISearchIndex) offers search functionality. Another important interface is the IClassificationIndex interface (com.sapportals.wcm.service.indexmanagement.retieval.classification.IClassificationIndex), which offers classification functionality. Every Index implementation has to implement one of the specialized interfaces (e.g. ISearchIndex) that extends the IIndex interface. The index management service itself only manages the indices so that they stay consistent to CM index management rules.

This has the following advantages:

• You only have to implement one of the existing interfaces or define a new one for a new type of index conform to the IIndex interface and implement this interface to integrate other index related (e.g. search) services.
• Indexing and deindexing of CM resources is handled event driven by the index managment service

Configuration

Index Management Service

The index management service can be configured with the parameters shown in the table.
The parameters can be set with the help of the user interface of the Content Management configuration framework.
For more information see the documentation Administering Content Management.

Property	Required	Description
class	yes	The Java class of the index management service com.sapportals.wcm.service.indexmanagement.IIndexService.
singleton	yes	Indicates that service has only one instance. Note: Value must always be "true".
serviceuser	yes	The service user of the index management service has read access for every resource. It also has to be defined as a service user in the usermanagement configuration.
cl_taxonomyRmPrefix	no	The prefix of the taxonomy manager must only be defined when classification indexes will be managed by the index management service.
services	yes	List of ids of index sub services as described below.

The following shows a sample configuration:

Name	Value
class	com.sapportals.wcm.service.indexmanagement.IndexService
singleton	true
serviceuser	index_service
cl_taxonomyRmPrefix	/taxonomies
services	trexSearch, trexSearchAndClassification, trexClassification

Index Sub Services

The index sub services are implementations of the index interfaces. The following properties can be set for a service:

Property	Required	Description
name	yes	The id/name of the index sub service. It is used to identify an index sub service.
class	yes	The Java class of the index sub service. For example the "TrexSearchIndex".
displayname	yes	The display name of the index sub service. It is displayed when creating an index to choose an index sub service.

The following shows a sample configuration:

Name	Value
name	trexSearch
class	com.sapportals.wcm.service.indexmanagement.retrieval.trex.TrexSearchIndex
displayname	Trex Search

Implementation notes

Service User

For indexing purposes you have to configure an service user named "index_service", which must have at least read access to all index relevant repositories.