Package io.jmix.search.index.queue.impl

Class JpaIndexingQueueManager

java.lang.Object

io.jmix.search.index.queue.impl.JpaIndexingQueueManager

All Implemented Interfaces:

IndexingQueueManager

@Component("search_JpaIndexingQueueManager")
public class JpaIndexingQueueManager
extends Object
implements IndexingQueueManager

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	JpaIndexingQueueManager.QueueItemsAggregator	Analyzes collection of IndexingQueueItem, determines unique entity ids and splits them among two disjoint groups: for index and for delete.

Field Summary

Fields

Modifier and Type	Field	Description
protected SystemAuthenticator	authenticator
protected UnconstrainedDataManager	dataManager
protected EnqueueingSessionManager	enqueueingSessionManager
protected EntityIdsLoaderProvider	entityIdsLoaderProvider
protected EntityIndexer	entityIndexer
protected IdSerialization	idSerialization
protected IndexConfigurationManager	indexConfigurationManager
protected IndexStateRegistry	indexStateRegistry
protected IndexingLocker	locker
protected Metadata	metadata
protected MetadataTools	metadataTools
protected SearchProperties	searchProperties
protected StoreAwareLocator	storeAwareLocator

Constructor Summary

Constructors

Constructor	Description
JpaIndexingQueueManager()

Method Summary

Modifier and Type	Method	Description
protected LoadContext<IndexingQueueItem>	createDequeueLoadContext(List<String> unavailableEntities, int batchSize)
protected IndexingQueueItem	createQueueItem(MetaClass metaClass, String entityId, IndexingOperation operation)
protected IndexingQueueItem	createQueueItem(String entityName, String entityId, IndexingOperation operation)
int	emptyQueue()	Removes all queue items.
int	emptyQueue(String entityName)	Removes all queue items related to provided entity.
protected int	enqueue(Collection<IndexingQueueItem> queueItems)
protected int	enqueue(Collection<Object> entityInstances, IndexingOperation operation)
protected int	enqueueByIds(Collection<Id<?>> entityIds, IndexingOperation operation)
int	enqueueDelete(Object entityInstance)	Sends provided entity instance to indexing queue in order to delete it from index.
int	enqueueDeleteByEntityId(Id<?> entityId)	Sends entity instance to indexing queue by provided ID in order to delete it from index.
int	enqueueDeleteCollection(Collection<Object> entityInstances)	Sends provided entity instances to indexing queue in order to delete them from index.
int	enqueueDeleteCollectionByEntityIds(Collection<Id<?>> entityIds)	Sends entity instances to indexing queue by provided IDs in order to delete them from index.
int	enqueueIndex(Object entityInstance)	Sends provided entity instance to indexing queue in order to store it to index.
int	enqueueIndexAll()	Synchronously sends all instances of all index-configured entities to indexing queue.
int	enqueueIndexAll(String entityName)	Synchronously sends all instances of provided entity to indexing queue.
protected int	enqueueIndexAll(String entityName, int batchSize)
int	enqueueIndexByEntityId(Id<?> entityId)	Sends entity instance to indexing queue by provided ID in order to store it to index.
int	enqueueIndexCollection(Collection<Object> entityInstances)	Sends provided entity instances to indexing queue in order to store them to index.
int	enqueueIndexCollectionByEntityIds(Collection<Id<?>> entityIds)	Sends entity instances to indexing queue by provided IDs in order to store them to index.
protected int	enqueueNextBatchInternal(EnqueueingSession session, int batchSize)
List<String>	getEntityNamesOfEnqueueingSessions()	Gets entity names of all existing enqueueing sessions.
protected Map<IndexingOperation,Map<Id<?>,List<IndexingQueueItem>>>	groupQueueItems(Collection<IndexingQueueItem> queueItems)
protected List<IndexingQueueItem>	handleIndexResult(IndexResult indexResult, Map<Id<?>,List<IndexingQueueItem>> itemsGroup)
void	initAsyncEnqueueIndexAll()	Initializes async enqueueing session for all indexed entities.
boolean	initAsyncEnqueueIndexAll(String entityName)	Initializes async enqueueing session for provided entity.
protected List<?>	loadRawIds(MetaClass metaClass)
protected int	processEnqueueingSession(EnqueueingSession session, int batchSize)
int	processEnqueueingSession(String entityName)	Processes enqueueing session for provided entity - one batch (with default size) of entity instances will be enqueued.
int	processEnqueueingSession(String entityName, int batchSize)	Processes enqueueing session for provided entity - one batch (with provided size) of entity instances will be enqueued.
int	processEntireQueue()	Retrieves items from indexing queue and processes them - store/remove related documents in index.
int	processEntireQueue(int batchSize)	Retrieves items from indexing queue and processes them - store/remove related documents in index.
int	processNextBatch()	Retrieves next batch of items from indexing queue and processes them - store/remove related documents in index.
int	processNextBatch(int batchSize)	Retrieves next batch of items from indexing queue and processes them - store/remove related documents in index.
int	processNextEnqueueingSession()	Processes next available enqueueing session - one batch (with default size) of entity instances will be enqueued.
int	processNextEnqueueingSession(int batchSize)	Processes next available enqueueing session - one batch (with provided size) of entity instances will be enqueued.
protected int	processQueue(int batchSize, boolean processEntireQueue)
protected List<IndexingQueueItem>	processQueueItems(List<IndexingQueueItem> queueItems)
protected List<IndexingQueueItem>	processQueueItemsGroup(Map<Id<?>,List<IndexingQueueItem>> itemsGroup, Function<Collection<Id<?>>,IndexResult> processingFunction)
protected int	processRawIds(List<?> rawIds, MetaClass metaClass, int batchSize)
void	resumeAsyncEnqueueIndexAll()	Resumes all previously suspended enqueueing sessions.
boolean	resumeAsyncEnqueueIndexAll(String entityName)	Resumes previously suspended enqueueing session for provided entity.
void	suspendAsyncEnqueueIndexAll()	Suspends all enqueueing sessions.
boolean	suspendAsyncEnqueueIndexAll(String entityName)	Suspends enqueueing session for provided entity.
void	terminateAsyncEnqueueIndexAll()	Terminates all enqueueing sessions.
boolean	terminateAsyncEnqueueIndexAll(String entityName)	Terminates enqueueing session for provided entity.

Methods inherited from class java.lang.Object

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

Field Details

dataManager

@Autowired
protected UnconstrainedDataManager dataManager

metadata

@Autowired
protected Metadata metadata

metadataTools

@Autowired
protected MetadataTools metadataTools

entityIndexer

@Autowired
protected EntityIndexer entityIndexer

storeAwareLocator

@Autowired
protected StoreAwareLocator storeAwareLocator

indexConfigurationManager

@Autowired
protected IndexConfigurationManager indexConfigurationManager

idSerialization

@Autowired
protected IdSerialization idSerialization

authenticator

@Autowired
protected SystemAuthenticator authenticator

locker

@Autowired
protected IndexingLocker locker

searchProperties

@Autowired
protected SearchProperties searchProperties

indexStateRegistry

@Autowired
protected IndexStateRegistry indexStateRegistry

enqueueingSessionManager

@Autowired
protected EnqueueingSessionManager enqueueingSessionManager

entityIdsLoaderProvider

@Autowired
protected EntityIdsLoaderProvider entityIdsLoaderProvider

Constructor Details

JpaIndexingQueueManager

public JpaIndexingQueueManager()

Method Details

emptyQueue

public int emptyQueue()

Description copied from interface: IndexingQueueManager

Removes all queue items.

Specified by:

emptyQueue in interface IndexingQueueManager

Returns:

amount of deleted items

emptyQueue

public int emptyQueue(String entityName)

Description copied from interface: IndexingQueueManager

Removes all queue items related to provided entity.

Specified by:

emptyQueue in interface IndexingQueueManager

Parameters:

entityName - entity

Returns:

amount of deleted items

enqueueIndex

public int enqueueIndex(Object entityInstance)

Description copied from interface: IndexingQueueManager

Sends provided entity instance to indexing queue in order to store it to index.

Specified by:

enqueueIndex in interface IndexingQueueManager

Parameters:

entityInstance - instance

Returns:

amount of enqueued instances

enqueueIndexCollection

public int enqueueIndexCollection(Collection<Object> entityInstances)

Description copied from interface: IndexingQueueManager

Sends provided entity instances to indexing queue in order to store them to index.

Specified by:

enqueueIndexCollection in interface IndexingQueueManager

Parameters:

entityInstances - instances

Returns:

amount of enqueued instances

enqueueIndexByEntityId

public int enqueueIndexByEntityId(Id<?> entityId)

Description copied from interface: IndexingQueueManager

Sends entity instance to indexing queue by provided ID in order to store it to index.

Specified by:

enqueueIndexByEntityId in interface IndexingQueueManager

Parameters:

entityId - ID of entity instance

Returns:

amount of enqueued instances

enqueueIndexCollectionByEntityIds

public int enqueueIndexCollectionByEntityIds(Collection<Id<?>> entityIds)

Description copied from interface: IndexingQueueManager

Sends entity instances to indexing queue by provided IDs in order to store them to index.

Specified by:

enqueueIndexCollectionByEntityIds in interface IndexingQueueManager

Parameters:

entityIds - IDs of entity instances

Returns:

amount of enqueued instances

enqueueIndexAll

public int enqueueIndexAll()

Description copied from interface: IndexingQueueManager

Synchronously sends all instances of all index-configured entities to indexing queue.

Don't use it on a huge amount of data - all ids (per entity) will be kept in memory during this process. Use IndexingQueueManager.initAsyncEnqueueIndexAll() methods instead.

Specified by:

enqueueIndexAll in interface IndexingQueueManager

Returns:

amount of enqueued instances

enqueueIndexAll

public int enqueueIndexAll(String entityName)

Description copied from interface: IndexingQueueManager

Synchronously sends all instances of provided entity to indexing queue.

Don't use it on a huge amount of data - all ids will be kept in memory during this process. Use IndexingQueueManager.initAsyncEnqueueIndexAll() methods instead.

Specified by:

enqueueIndexAll in interface IndexingQueueManager

Parameters:

entityName - entity name

Returns:

amount of enqueued instances

getEntityNamesOfEnqueueingSessions

public List<String> getEntityNamesOfEnqueueingSessions()

Description copied from interface: IndexingQueueManager

Gets entity names of all existing enqueueing sessions.

Specified by:

getEntityNamesOfEnqueueingSessions in interface IndexingQueueManager

Returns:

list of entity names

initAsyncEnqueueIndexAll

public void initAsyncEnqueueIndexAll()

Description copied from interface: IndexingQueueManager

Initializes async enqueueing session for all indexed entities.

Specified by:

initAsyncEnqueueIndexAll in interface IndexingQueueManager

initAsyncEnqueueIndexAll

public boolean initAsyncEnqueueIndexAll(String entityName)

Description copied from interface: IndexingQueueManager

Initializes async enqueueing session for provided entity. Existing session will be removed and created again.

Specified by:

initAsyncEnqueueIndexAll in interface IndexingQueueManager

Parameters:

entityName - entity name

Returns:

true if operation was successfully performed, false otherwise

suspendAsyncEnqueueIndexAll

public void suspendAsyncEnqueueIndexAll()

Description copied from interface: IndexingQueueManager

Suspends all enqueueing sessions. Suspended sessions are ignored during session processing. Session can be resumed by IndexingQueueManager.resumeAsyncEnqueueIndexAll()

Specified by:

suspendAsyncEnqueueIndexAll in interface IndexingQueueManager

suspendAsyncEnqueueIndexAll

public boolean suspendAsyncEnqueueIndexAll(String entityName)

Description copied from interface: IndexingQueueManager

Suspends enqueueing session for provided entity. Suspended sessions are ignored during session processing. Session can be resumed by IndexingQueueManager.resumeAsyncEnqueueIndexAll()

Specified by:

suspendAsyncEnqueueIndexAll in interface IndexingQueueManager

Parameters:

entityName - entity name

Returns:

true if operation was successfully performed, false otherwise

resumeAsyncEnqueueIndexAll

public void resumeAsyncEnqueueIndexAll()

Description copied from interface: IndexingQueueManager

Resumes all previously suspended enqueueing sessions.

Specified by:

resumeAsyncEnqueueIndexAll in interface IndexingQueueManager

resumeAsyncEnqueueIndexAll

public boolean resumeAsyncEnqueueIndexAll(String entityName)

Description copied from interface: IndexingQueueManager

Resumes previously suspended enqueueing session for provided entity.

Specified by:

resumeAsyncEnqueueIndexAll in interface IndexingQueueManager

Parameters:

entityName - entity name

Returns:

true if operation was successfully performed, false otherwise

terminateAsyncEnqueueIndexAll

public void terminateAsyncEnqueueIndexAll()

Description copied from interface: IndexingQueueManager

Terminates all enqueueing sessions.

Specified by:

terminateAsyncEnqueueIndexAll in interface IndexingQueueManager

terminateAsyncEnqueueIndexAll

public boolean terminateAsyncEnqueueIndexAll(String entityName)

Description copied from interface: IndexingQueueManager

Terminates enqueueing session for provided entity.

Specified by:

terminateAsyncEnqueueIndexAll in interface IndexingQueueManager

Parameters:

entityName - entity name

Returns:

true if operation was successfully performed, false otherwise

processNextEnqueueingSession

public int processNextEnqueueingSession()

Description copied from interface: IndexingQueueManager

Processes next available enqueueing session - one batch (with default size) of entity instances will be enqueued.

Specified by:

processNextEnqueueingSession in interface IndexingQueueManager

Returns:

amount of processed entity instances

processNextEnqueueingSession

public int processNextEnqueueingSession(int batchSize)

Description copied from interface: IndexingQueueManager

Processes next available enqueueing session - one batch (with provided size) of entity instances will be enqueued.

Specified by:

processNextEnqueueingSession in interface IndexingQueueManager

Parameters:

batchSize - batch size

Returns:

amount of processed entity instances

processEnqueueingSession

public int processEnqueueingSession(String entityName)

Description copied from interface: IndexingQueueManager

Processes enqueueing session for provided entity - one batch (with default size) of entity instances will be enqueued.

Specified by:

processEnqueueingSession in interface IndexingQueueManager

Parameters:

entityName - entity name

Returns:

amount of processed entity instances

processEnqueueingSession

public int processEnqueueingSession(String entityName,
 int batchSize)

Description copied from interface: IndexingQueueManager

Processes enqueueing session for provided entity - one batch (with provided size) of entity instances will be enqueued.

Specified by:

processEnqueueingSession in interface IndexingQueueManager

Parameters:

entityName - entity name

batchSize - batch size

Returns:

amount of processed entity instances

enqueueDelete

public int enqueueDelete(Object entityInstance)

Description copied from interface: IndexingQueueManager

Sends provided entity instance to indexing queue in order to delete it from index.

Specified by:

enqueueDelete in interface IndexingQueueManager

Parameters:

entityInstance - instance

Returns:

amount of enqueued instances

enqueueDeleteCollection

public int enqueueDeleteCollection(Collection<Object> entityInstances)

Description copied from interface: IndexingQueueManager

Sends provided entity instances to indexing queue in order to delete them from index.

Specified by:

enqueueDeleteCollection in interface IndexingQueueManager

Parameters:

entityInstances - instances

Returns:

amount of enqueued instances

enqueueDeleteByEntityId

public int enqueueDeleteByEntityId(Id<?> entityId)

Description copied from interface: IndexingQueueManager

Sends entity instance to indexing queue by provided ID in order to delete it from index.

Specified by:

enqueueDeleteByEntityId in interface IndexingQueueManager

Parameters:

entityId - ID of entity instance

Returns:

amount of enqueued instances

enqueueDeleteCollectionByEntityIds

public int enqueueDeleteCollectionByEntityIds(Collection<Id<?>> entityIds)

Description copied from interface: IndexingQueueManager

Sends entity instances to indexing queue by provided IDs in order to delete them from index.

Specified by:

enqueueDeleteCollectionByEntityIds in interface IndexingQueueManager

Parameters:

entityIds - IDs of entity instances

Returns:

amount of enqueued instances

processNextBatch

public int processNextBatch()

Description copied from interface: IndexingQueueManager

Retrieves next batch of items from indexing queue and processes them - store/remove related documents in index.

Specified by:

processNextBatch in interface IndexingQueueManager

Returns:

amount of processed queue items

processNextBatch

public int processNextBatch(int batchSize)

Description copied from interface: IndexingQueueManager

Retrieves next batch of items from indexing queue and processes them - store/remove related documents in index.

Specified by:

processNextBatch in interface IndexingQueueManager

Parameters:

batchSize - amount of queue items to process

Returns:

amount of processed queue items

processEntireQueue

public int processEntireQueue()

Description copied from interface: IndexingQueueManager

Retrieves items from indexing queue and processes them - store/remove related documents in index.

Specified by:

processEntireQueue in interface IndexingQueueManager

Returns:

amount of processed queue items

processEntireQueue

public int processEntireQueue(int batchSize)

Description copied from interface: IndexingQueueManager

Retrieves items from indexing queue and processes them - store/remove related documents in index.

Specified by:

processEntireQueue in interface IndexingQueueManager

Parameters:

batchSize - amount of queue items to process within single batch

Returns:

amount of processed queue items

processEnqueueingSession

protected int processEnqueueingSession(EnqueueingSession session,
 int batchSize)

enqueueNextBatchInternal

protected int enqueueNextBatchInternal(EnqueueingSession session,
 int batchSize)

enqueueIndexAll

protected int enqueueIndexAll(String entityName,
 int batchSize)

loadRawIds

protected List<?> loadRawIds(MetaClass metaClass)

processRawIds

protected int processRawIds(List<?> rawIds,
 MetaClass metaClass,
 int batchSize)

processQueue

protected int processQueue(int batchSize,
 boolean processEntireQueue)

createDequeueLoadContext

protected LoadContext<IndexingQueueItem> createDequeueLoadContext(List<String> unavailableEntities,
 int batchSize)

processQueueItems

protected List<IndexingQueueItem> processQueueItems(List<IndexingQueueItem> queueItems)

processQueueItemsGroup

protected List<IndexingQueueItem> processQueueItemsGroup(Map<Id<?>,List<IndexingQueueItem>> itemsGroup,
 Function<Collection<Id<?>>,IndexResult> processingFunction)

handleIndexResult

protected List<IndexingQueueItem> handleIndexResult(IndexResult indexResult,
 Map<Id<?>,List<IndexingQueueItem>> itemsGroup)

groupQueueItems

protected Map<IndexingOperation,Map<Id<?>,List<IndexingQueueItem>>> groupQueueItems(Collection<IndexingQueueItem> queueItems)

enqueue

protected int enqueue(Collection<Object> entityInstances,
 IndexingOperation operation)

enqueueByIds

protected int enqueueByIds(Collection<Id<?>> entityIds,
 IndexingOperation operation)

enqueue

protected int enqueue(Collection<IndexingQueueItem> queueItems)

createQueueItem

protected IndexingQueueItem createQueueItem(MetaClass metaClass,
 String entityId,
 IndexingOperation operation)

createQueueItem

protected IndexingQueueItem createQueueItem(String entityName,
 String entityId,
 IndexingOperation operation)