Package akka.javasdk.consumer

Class Consumer

Object

akka.javasdk.consumer.Consumer

public abstract class Consumer
extends Object

Consumers are stateless components that can be used to implement different uses cases, such as:

• subscribe to events from an Event Sourced Entity.
• subscribe to state changes from a Key Value Entity.

A Consumer method should return an Consumer.Effect that describes what to do next.

Concrete classes can accept the following types to the constructor:

• ComponentClient
• HttpClientProvider
• TimerScheduler
• Materializer
• Config
• Custom types provided by a DependencyProvider from the service setup

Concrete class must be annotated with ComponentId and one of the Consume annotations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Consumer.Effect	An Effect is a description of what the runtime needs to do after the command is handled.

Constructor Summary

Constructors

Constructor	Description
Consumer()

Method Summary

Modifier and Type	Method	Description
final Consumer.Effect.Builder	effects()
protected final MessageContext	messageContext()	Additional context and metadata for a message handler.
final TimerScheduler	timers()	Returns a TimerScheduler that can be used to schedule further in time.

Methods inherited from class java.lang.Object

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

Constructor Details

Consumer

public Consumer()

Method Details

messageContext

protected final MessageContext messageContext()

Additional context and metadata for a message handler.

It will throw an exception if accessed from constructor.

effects

public final Consumer.Effect.Builder effects()

timers

public final TimerScheduler timers()

Returns a TimerScheduler that can be used to schedule further in time.