org.mule.runtime.core.api.routing.filter

Interface Filter

All Known Implementing Classes:

AbstractFilterCollection, AcceptAllFilter, AndFilter, ConsumableMuleMessageFilter, EqualsFilter, ExceptionTypeFilter, ExpressionFilter, MessagePropertyFilter, NotFilter, NotWildcardFilter, OrFilter, PayloadTypeFilter, RegExFilter, WildcardFilter

public interface Filter

The Filter interface allows Message filtering.

Method Summary

Modifier and Type	Method and Description
default boolean	accept(Event event, Event.Builder builder) Checks a given event against this filter.
boolean	accept(org.mule.runtime.api.message.Message message, Event.Builder builder) Deprecated.

Method Detail

accept

@Deprecated
boolean accept(org.mule.runtime.api.message.Message message,
                           Event.Builder builder)

Deprecated.

Checks a given message against this filter.

TODO MULE-9142 See how this API can be improved to not need the builder.

Parameters:

message - a non null message to filter.

builder - an event builder in case the filter needs to make changes to the event.

Returns:

true if the message matches the filter TODO MULE-9341 Remove Filters that are not needed. This method will be removed when filters are cleaned up.

accept

default boolean accept(Event event,
                       Event.Builder builder)

Checks a given event against this filter.

TODO MULE-9142 See how this API can be improved to not need the builder.

Parameters:

event - a non null event to filter.

builder - an event builder in case the filter needs to make changes to the event.

Returns:

true if the event matches the filter