io.spine.server.entity

Class EventWhiteList

java.lang.Object

io.spine.server.entity.EventWhiteList

All Implemented Interfaces:

EventFilter

public final class EventWhiteList
extends java.lang.Object
implements EventFilter

An EventFilter which allows only events of given types.

All other events are discarded by this filter by default.

Caution: Make sure you are aware of consequences of discarding system events posted by a repository when using this filter.

See Also:

EventBlackList

Method Summary

Modifier and Type	Method and Description
static EventWhiteList	allowEvents(java.lang.Class<? extends io.spine.base.EventMessage>... eventClasses) Creates a new instance of EventWhiteList allowing events of the given types.
java.util.Optional<? extends io.spine.base.EventMessage>	filter(io.spine.base.EventMessage event) Applies this filter to the given event.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.spine.server.entity.EventFilter

allowAll, filter

Method Detail

allowEvents

@SafeVarargs
public static EventWhiteList allowEvents(java.lang.Class<? extends io.spine.base.EventMessage>... eventClasses)

Creates a new instance of EventWhiteList allowing events of the given types.

Parameters:

eventClasses - the allowed event classes

Returns:

new instance of the white-list filter

filter

public java.util.Optional<? extends io.spine.base.EventMessage> filter(io.spine.base.EventMessage event)

Description copied from interface: EventFilter

Applies this filter to the given event.

Specified by:

filter in interface EventFilter

Parameters:

event - the event to apply the filter to

Returns:

processed event or Optional.empty() if the event should not be posted