Package org.hibernate.search.mapper.orm.outboxpolling.mapping

Interface OutboxPollingSearchMapping

@Incubating public interface OutboxPollingSearchMapping
Exposes some utilities to handle aborted events, which are events that have been processed many times without success.

  • Method Details

    • countAbortedEvents

      long countAbortedEvents()
      Returns the number of events that are at the moment in aborted state.

      This method only works for single-tenant applications. If multi-tenancy is enabled, use countAbortedEvents(Object) instead.

      Returns:
      The number of aborted events

    • countAbortedEvents

      @Deprecated(forRemoval=true) long countAbortedEvents(String tenantId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use countAbortedEvents(Object) instead.
      Returns the number of events that are at the moment in aborted state.

      This method only works for multi-tenant applications. If multi-tenancy is disabled, use countAbortedEvents() instead.

      Parameters:
      tenantId - The identifier of the tenant whose index content should be targeted
      Returns:
      The number of aborted events

    • countAbortedEvents

      long countAbortedEvents(Object tenantId)
      Returns the number of events that are at the moment in aborted state.

      This method only works for multi-tenant applications. If multi-tenancy is disabled, use countAbortedEvents() instead.

      Parameters:
      tenantId - The identifier of the tenant whose index content should be targeted
      Returns:
      The number of aborted events

    • reprocessAbortedEvents

      int reprocessAbortedEvents()
      Reprocess events that are at the moment in aborted state.

      This method only works for single-tenant applications. If multi-tenancy is enabled, use reprocessAbortedEvents(Object) instead.

      Returns:
      The number of reprocessed events

    • reprocessAbortedEvents

      @Deprecated(forRemoval=true) int reprocessAbortedEvents(String tenantId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use reprocessAbortedEvents(Object) instead.
      Reprocess events that are at the moment in aborted state.

      This method only works for multi-tenant applications. If multi-tenancy is disabled, use reprocessAbortedEvents() instead.

      Parameters:
      tenantId - The identifier of the tenant whose index content should be targeted
      Returns:
      The number of reprocessed events

    • reprocessAbortedEvents

      int reprocessAbortedEvents(Object tenantId)
      Reprocess events that are at the moment in aborted state.

      This method only works for multi-tenant applications. If multi-tenancy is disabled, use reprocessAbortedEvents() instead.

      Parameters:
      tenantId - The identifier of the tenant whose index content should be targeted
      Returns:
      The number of reprocessed events

    • clearAllAbortedEvents

      int clearAllAbortedEvents()
      Delete all events that are at the moment in aborted state.

      This method only works for single-tenant applications. If multi-tenancy is enabled, use clearAllAbortedEvents(Object) instead.

      Returns:
      The number of deleted events

    • clearAllAbortedEvents

      @Deprecated(forRemoval=true) int clearAllAbortedEvents(String tenantId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use clearAllAbortedEvents(Object) instead.
      Delete all events that are at the moment in aborted state.

      This method only works for multi-tenant applications. If multi-tenancy is disabled, use clearAllAbortedEvents() instead.

      Parameters:
      tenantId - The identifier of the tenant whose index content should be targeted
      Returns:
      The number of deleted events

    • clearAllAbortedEvents

      int clearAllAbortedEvents(Object tenantId)
      Delete all events that are at the moment in aborted state.

      This method only works for multi-tenant applications. If multi-tenancy is disabled, use clearAllAbortedEvents() instead.

      Parameters:
      tenantId - The identifier of the tenant whose index content should be targeted
      Returns:
      The number of deleted events