Package org.hibernate.search.mapper.orm.automaticindexing.impl

Class HibernateOrmIndexingQueueEventSendingPlan

java.lang.Object

org.hibernate.search.mapper.orm.automaticindexing.impl.HibernateOrmIndexingQueueEventSendingPlan

All Implemented Interfaces:

PojoIndexingQueueEventSendingPlan

public class HibernateOrmIndexingQueueEventSendingPlan
extends Object
implements PojoIndexingQueueEventSendingPlan

Constructor Summary

Constructors

Constructor	Description
HibernateOrmIndexingQueueEventSendingPlan(AutomaticIndexingQueueEventSendingPlan delegate)

Method Summary

Modifier and Type	Method	Description
void	append(String entityName, Object identifier, String serializedId, PojoIndexingQueueEventPayload payload)	Appends an event to the plan, to be sent later and ultimately added to a PojoIndexingQueueEventProcessingPlan.
void	discard()	Discards all events that were added to this plan, without sending them.
CompletableFuture<MultiEntityOperationExecutionReport>	sendAndReport(OperationSubmitter operationSubmitter)	Sends the events to the queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

HibernateOrmIndexingQueueEventSendingPlan

public HibernateOrmIndexingQueueEventSendingPlan(AutomaticIndexingQueueEventSendingPlan delegate)

Method Detail

append

public void append(String entityName,
                   Object identifier,
                   String serializedId,
                   PojoIndexingQueueEventPayload payload)

Description copied from interface: PojoIndexingQueueEventSendingPlan

Appends an event to the plan, to be sent later and ultimately added to a PojoIndexingQueueEventProcessingPlan.

Specified by:

append in interface PojoIndexingQueueEventSendingPlan

Parameters:

entityName - The name of the entity type.

identifier - The non-serialized entity identifier, to report sending errors.

serializedId - The serialized entity identifier.

payload - A payload to be forwarded as-is to the processing plan.

See Also:

PojoIndexingQueueEventProcessingPlan.append(String, String, PojoIndexingQueueEventPayload)

discard

public void discard()

Description copied from interface: PojoIndexingQueueEventSendingPlan

Discards all events that were added to this plan, without sending them.

Specified by:

discard in interface PojoIndexingQueueEventSendingPlan

sendAndReport

public CompletableFuture<MultiEntityOperationExecutionReport> sendAndReport(OperationSubmitter operationSubmitter)

Description copied from interface: PojoIndexingQueueEventSendingPlan

Sends the events to the queue.

When the returned future completes, events are guaranteed to be stored in secure storage in such a way that they will eventually be processed.

Specified by:

sendAndReport in interface PojoIndexingQueueEventSendingPlan

Parameters:

operationSubmitter - How to handle request to submit operation when the queue is full.

Returns:

A CompletableFuture that will hold an execution report when all the events are sent. If sending an event failed, the future will be completed normally, but the report will contain an exception.