Package org.flowable.eventregistry.api

# Interface InboundEventFilter<T>

Type Parameters:
  `T` - the type of the expected payload (e.g. a JsonNode)

Functional Interface:
  This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface public interface InboundEventFilter<T>
This interface must be implemented by a custom filtering bean to hook into the default inbound event processing pipeline in order to have a very effective way to filter out events which should not be processed any further and thus preventing expensive processing time like DB lookups and the full consumer invocation.

Author:
  Micha Kiener

- ## Method Summary

  Modifier and Type
  Method
  Description
  `boolean`
  `retain(String eventDefinitionKey, FlowableEventInfo<T> event)`
  Returns true, if the event should be further processed or false if the event should be ignored and will not be processed any further.

- ## Method Details

  - ### retain

    boolean retain(String eventDefinitionKey, FlowableEventInfo<T> event)
    Returns true, if the event should be further processed or false if the event should be ignored and will not be processed any further.
    Parameters:
      `eventDefinitionKey` - the key for the inbound event
      `event` - the inbound event information
    Returns:
      true, if the event should continue to be processed, false, if the pipeline will ignore the event and stop any further processing