Package nl.gx.webmanager.services.contentindex.queue.api

Interface IndexQueue

public interface IndexQueue

The Index Queue Service contract. Clients can serve their entities to be queued for indexing. The index queue fulfills the objective to index requests for all nodes in the cluster. Therefore, the queue is the single point of entry in a cluster.

Method Summary

Modifier and Type	Method	Description
void	addToQueue(Object entity, IndexQueueAction action)	Adds an entity to the index queue.
void	cleanUpIndexQueue()	Cleans up items in the queue that have already been processed by all nodes in the cluster.
void	pollIndexQueue()	Polls the index queue for queued events.
void	reIndex()	Schedules a re-index of all content.
void	reIndex(List<ContentDomain<?>> contentDomains)	Schedules a re-index of one or more specific content domains.

Method Detail

addToQueue

void addToQueue(Object entity,
                IndexQueueAction action)
         throws IndexQueueException

Adds an entity to the index queue.

Parameters:

entity - Entity to add.

action - Indication whether the entity is created/updated or deleted.

Throws:

IndexQueueException - In case an exception occurs when accessing the store.

reIndex

void reIndex()
      throws IndexQueueException

Schedules a re-index of all content. All content is defined to be the total of all enumerations that registered ContentDomainEnumerator services represent.

Re-indexing pace is - next to hardware limitations - constraint by the following configuration values:

• contentindex_queue_poller_schedule
• contentindex_queue_iteration_limit

As initial indexing of content originating from e.g. clean setup or an upgrade scenario already causes

Throws:

IndexQueueException - In case an exception occurs when accessing the store.

reIndex

void reIndex(List<ContentDomain<?>> contentDomains)
      throws IndexQueueException

Schedules a re-index of one or more specific content domains.

Parameters:

contentDomains - Content domain to re-index. If null or an empty list a full re-index is performed.

Throws:

IndexQueueException - In case an exception occurs when accessing the store.

pollIndexQueue

void pollIndexQueue()
             throws IndexQueueException

Polls the index queue for queued events. These events are fed to the index.

Throws:

IndexQueueException - In case an exception occurs when accessing the store.

cleanUpIndexQueue

void cleanUpIndexQueue()
                throws IndexQueueException

Cleans up items in the queue that have already been processed by all nodes in the cluster. Note that this does not mean new nodes won't get an up-to-date index.

Throws:

IndexQueueException - In case an exception occurs when accessing the store.