io.spine.client

Class EventSubscriptionRequest<E extends io.spine.base.EventMessage>

java.lang.Object

io.spine.client.ClientRequest

io.spine.client.FilteringRequest<M,io.spine.client.Topic,TopicBuilder,B>

io.spine.client.SubscribingRequest<E,io.spine.core.EventContext,io.spine.core.Event,EventSubscriptionRequest<E>>

io.spine.client.EventSubscriptionRequest<E>

Type Parameters:

E - the type of the event messages

public final class EventSubscriptionRequest<E extends io.spine.base.EventMessage>
extends SubscribingRequest<E,io.spine.core.EventContext,io.spine.core.Event,EventSubscriptionRequest<E>>

Allows to subscribe to events using filtering conditions.

Similarly to subscriptions to entity states, event subscriptions may use filtering by values of the proto types of subscribed messages:

 clientRequest.subscribeToEvent(MyEventMessage.class)
              .where(eq(MyEventMessage.Field.myProtoField(), fieldValue))
              .observe((event, context) -> {...})
              .post();
 

In addition to regular filtering conditions, event subscription requests may also reference fields of spine.core.EventContext. For example, in order to filter events originate from commands of the given user, please use the following code:

 clientRequest.subscribeToEvent(MyEventMessage.class)
              .where(eq(EventContext.Field.pastMessage().actorContext().actor(), userId))
              .observe((event, context) -> {...})
              .post();
 

Method Summary

Modifier and Type	Method and Description
EventSubscriptionRequest<E>	observe(EventConsumer<E> consumer)
EventSubscriptionRequest<E>	where(CompositeEventFilter... filter) Configures the request to return results matching all the passed filters.
EventSubscriptionRequest<E>	where(EventFilter... filter) Configures the request to return results matching all the passed filters.

Methods inherited from class io.spine.client.SubscribingRequest

observe, onConsumingError, onStreamingError, post

Methods inherited from class io.spine.client.FilteringRequest

byId, byId, byId, byId, byId, where, where, withMask, withMask

Methods inherited from class io.spine.client.ClientRequest

client, command, onServerError, select, subscribeTo, subscribeToEvent, user

Methods inherited from class java.lang.Object

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

Method Detail

where

public EventSubscriptionRequest<E> where(EventFilter... filter)

Configures the request to return results matching all the passed filters.

Please note that the EventFilter instances may target both event message and event context fields. See EventFilter for details.

where

public EventSubscriptionRequest<E> where(CompositeEventFilter... filter)

Configures the request to return results matching all the passed filters.

Please note that the CompositeEventFilter instances may target both event message and event context fields. See CompositeEventFilter for details.

observe

@CanIgnoreReturnValue
public EventSubscriptionRequest<E> observe(EventConsumer<E> consumer)