public interface ITaskQueueHandler
ITaskQueueHandler
is mainly responsible for indexing, reindexing and delta indexing
of documents. If no TaskQueueService is active the methods are immediately
executed. Otherwise tasks are enqueued in a task queue. The task queue is checked according
to a time interval, which could be adjusted in the system configuration.
This way, it is possible to execute different tasks on different machines in a distributed
CM scenario.
Internally this interface is also used by particular indexes , when the corresponding methods
are called.
Changes between major releases 7.0 and 7.X
reindexWithoutClear(IIndex)
IIndex
,
AbstractIndex
Modifier and Type | Method and Description |
---|---|
void |
createTaxonomyHierarchyByCopiing(String taxonomyName,
ICollection existingHierarchy,
IClassificationIndex index)
The taxonomy hierarchy is created by copying an existing hierarchy.
|
void |
deindexDocuments(IIndex index,
IRidList deindexRids,
boolean removeClassification)
Deindexes a list of document IDs from an index.
|
void |
deltaReindex(IIndex index)
Performs indexing of the documents that are not yet indexed or have been
changed since the last crawl.
|
void |
executeTask(ITask task)
Runs an index management task of the task queue service.
|
void |
indexDocument(IIndex index,
IResource document,
IResourceEvent event)
Indexes a document into an index.
|
void |
reindex(IIndex index,
boolean disablePostClearTasks)
Clears the index and starts putting all documents into the index again.
|
void |
reindexWithoutClear(IIndex index)
Starts putting all documents into the index again without clearing it first.
|
void |
startDeindexCrawler(IIndex index,
RID startRid)
Runs a deindex crawl as a separate thread.
|
void |
startDeindexCrawler(IIndex index,
RID startRid,
IResourceEvent event,
RID eventPreRid,
RID eventNewRid,
String crawlerProfileId)
Runs a deindex crawl as a separate thread.
|
void |
startDeltaCrawler(IIndex index,
RID startRid)
Runs an delta index crawl as a separate thread.
|
void |
startIndexCrawler(IIndex index,
RID startRid,
IResourceEvent event)
Runs an index crawl as a separate thread.
|
void |
startTrainingCrawler(String taxonomyName,
ICollection taxonomyCollection,
IClassificationIndex index,
boolean isSearchRelevant)
Runs a taxonomy training crawler as a separate thread.
|
void |
updateCategoryContents(String taxonomyName,
boolean dirtyOnly,
IIndex index,
IResourceContext context,
boolean markCategoriesUpdated)
Starts a process that checks and updates categories of a taxonomy where the query is
not in sync with the documents of category.
|
void startIndexCrawler(IIndex index, RID startRid, IResourceEvent event) throws WcmException
index
- index where the documents have to be indexed intostartRid
- start resource of the crawlevent
- event that caused the index request; can be null
WcmException
- exception raised in failure situationvoid startDeltaCrawler(IIndex index, RID startRid) throws WcmException
index
- index where the documents have to be indexed intostartRid
- start resource of the crawlWcmException
- exception raised in failure situationvoid startTrainingCrawler(String taxonomyName, ICollection taxonomyCollection, IClassificationIndex index, boolean isSearchRelevant) throws WcmException
taxonomyName
- name of taxonomytaxonomyCollection
- start folder for the crawl; represents the taxonomy rootindex
- index where the documents have to be indexed intoisSearchRelevant
- if true the start folder is attached to the index,
if false the crawl is only used to build the taxonomy.WcmException
- exception raised in failure situationvoid createTaxonomyHierarchyByCopiing(String taxonomyName, ICollection existingHierarchy, IClassificationIndex index) throws WcmException
taxonomyName
- name of taxonomyexistingHierarchy
- root folder of the hierarchy to copyindex
- classification index where the taxonomy will be createdWcmException
- WcmExceptionvoid startDeindexCrawler(IIndex index, RID startRid) throws WcmException
index
- index where the documents have to be deindexed fromstartRid
- start resource ID of the crawlWcmException
- exception raised in failure situationvoid startDeindexCrawler(IIndex index, RID startRid, IResourceEvent event, RID eventPreRid, RID eventNewRid, String crawlerProfileId) throws WcmException
index
- index where the documents have to be deindexed fromstartRid
- start resource ID of the crawlevent
- event that caused the deindex request; can be null
eventPreRid
- resource ID of the events resource before an action like rename or move.eventNewRid
- current resource ID of the events resourcecrawlerProfileId
- crawler profile id of the data source as fallback if the data source is not
available anymore when requesting the crawler profile id after a detach.WcmException
- exception raised in failure situationvoid indexDocument(IIndex index, IResource document, IResourceEvent event) throws WcmException
index
- index where the documents have to be indexed intodocument
- document to indexevent
- event that caused the index request; can be null
WcmException
- exception raised in failure situationvoid reindex(IIndex index, boolean disablePostClearTasks) throws WcmException
index
- index to reindexdisablePostClearTasks
- if true, the tasks that can be performed by
the index implementation after the index has been cleared are skipped.WcmException
- exception raised in failure situationvoid reindexWithoutClear(IIndex index) throws WcmException
index
- index to reindexWcmException
- exception raised in failure situationvoid deltaReindex(IIndex index) throws WcmException
reindex
method, this call does not clear the index.index
- the indexWcmException
- exception raised in failure situationvoid deindexDocuments(IIndex index, IRidList deindexRids, boolean removeClassification) throws WcmException
index
- index where the documents have to be deindexed fromdeindexRids
- list of resource IDs to deindexremoveClassification
- if true the classification if the documents is deleted,
if false the classification remains.WcmException
- exception raised in failure situationvoid updateCategoryContents(String taxonomyName, boolean dirtyOnly, IIndex index, IResourceContext context, boolean markCategoriesUpdated) throws WcmException
taxonomyName
- name of the taxonomy to checkdirtyOnly
- if false all categories are checked, if false only categories
that are out of sync (dirty) are updated.index
- index where the taxonomy is definedcontext
- user contextmarkCategoriesUpdated
- if false the updated categories remain dirtyWcmException
- exception raised in failure situationvoid executeTask(ITask task) throws WcmException
task
- task queue taskWcmException
- exception raised in failure situationAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice