Interface PojoIndexingQueueEventProcessingPlan
public interface PojoIndexingQueueEventProcessingPlan
-
Method Summary
Modifier and TypeMethodDescriptionvoid
append
(String entityName, String serializedId, PojoIndexingQueueEventPayload payload) Appends an event to the plan, received from aPojoIndexingQueueEventSendingPlan
.executeAndReport
(OperationSubmitter operationSubmitter) Writes all pending changes to the index now, and clears the plan so that it can be re-used.toIdentifier
(String entityName, String serializedId) Convert the serialized id to the original identifier.<I> String
toSerializedId
(String entityName, I identifier) Convert the identifier to its serialized form.
-
Method Details
-
append
Appends an event to the plan, received from aPojoIndexingQueueEventSendingPlan
.- Parameters:
entityName
- The name of the entity type.serializedId
- The serialized entity identifier.payload
- The payload as passed to the sending plan.- See Also:
-
executeAndReport
CompletableFuture<MultiEntityOperationExecutionReport> executeAndReport(OperationSubmitter operationSubmitter) Writes all pending changes to the index now, and clears the plan so that it can be re-used.- Parameters:
operationSubmitter
- How to handle request to submit operation when the queue is full- Returns:
- A
CompletableFuture
that will be completed with an execution report when all the works are complete.
-
toSerializedId
Convert the identifier to its serialized form. The identifier type must be the one used by the entity having nameentityName
.- Type Parameters:
I
- The type of the identifier of the entity.- Parameters:
entityName
- The name of the entity.identifier
- The provided identifier.- Returns:
- The serialized form of the provided identifier.
-
toIdentifier
Convert the serialized id to the original identifier.- Parameters:
entityName
- The name of the entity.serializedId
- The serialized id.- Returns:
- The original entity identifier.
-