io.zeebe.logstreams.processor

Interface StreamProcessor

public interface StreamProcessor

Process events from a log stream.

Method Summary

Modifier and Type	Method and Description
default StateController	getStateController() Deprecated.
SnapshotSupport	getStateResource() Returns the resource which holds the state of the processor.
default void	onClose() Callback which is invoked by the controller when it closes.
EventProcessor	onEvent(LoggedEvent event) Returns a specific processor to process the event which is read from the log stream, if available.
default void	onOpen(StreamProcessorContext context) Callback which is invoked by the controller when it opens.
default void	onRecovered() Callback which is invoked by the controller when the recovery is done.

Method Detail

getStateResource

SnapshotSupport getStateResource()

Returns the resource which holds the state of the processor.

Returns:

the processor state resource

getStateController

default StateController getStateController()

Deprecated.

TODO: Remove when we get rid of state resources, no need to expose this afterwards. Return the associated DB controller if any.

Returns:

current rocks DB controller (or null if none)

onEvent

EventProcessor onEvent(LoggedEvent event)

Returns a specific processor to process the event which is read from the log stream, if available.

Parameters:

event - the event to process

Returns:

specific processor to process the event, or null if the event can't be processed

onOpen

default void onOpen(StreamProcessorContext context)

Callback which is invoked by the controller when it opens. An implementation can provide any setup logic here.

onRecovered

default void onRecovered()

Callback which is invoked by the controller when the recovery is done. Implementation could contain logic which should not be done on recovery, but afterwards.

onClose

default void onClose()

Callback which is invoked by the controller when it closes. An implementation can provide any clean up logic here.