All Classes
-
All Classes Interface Summary Class Summary Exception Summary Annotation Types Summary Class Description AnnotatedCommandHandler Extending this class will allow you to colocate multiple related Command handling methods inside the same class and use it together with theLocalCommandBus
Each method must accept a single Command argument, may return a value or return void and be annotated with theEventHandlerannotation.
The method argument type is matched against the concrete command type usingClass.isAssignableFrom(Class).
The method accessibility can be any combination of private, protected, public, etc.
Example:AnnotatedEventHandler<EVENT_TYPE> Extending this class will allow you to colocate multiple related Event handling methods inside the same class and use it together with theLocalEventBus
Each method must accept a single Event argument, return void and be annotated with theEventHandlerannotation.
The method argument type is matched against the concrete event type usingClass.isAssignableFrom(Class).
The method accessibility can be any combination of private, protected, public, etc.
Example:AsyncEventHandler Annotate anEventHandler/AnnotatedEventHandlerwith this annotation to have theEventHandlerbe registered as an asynchronous event-handler with the defaultLocalEventBus(default is registering them as a synchronous event handler).CommandHandler Common interface for all Command message handlers
A command handler can choose support to 1 or more command typesEventHandler<EVENT_TYPE> Common interface for all Event message handlersHandler Method annotation that can be applied to any single argument method insideAnnotatedCommandHandlerorAnnotatedEventHandler.
Depending on which class you extend the rules that apply to each method may be different.
Common for all is that the method accessibility can be any combination of private, protected, public, etc.LocalCommandBus TheLocalCommandBusprovides an indirection between a command and theCommandHandlerthat's capable of handling the command.
Commands can be sent synchronously usingLocalCommandBus.send(Object)or asynchronously usingLocalCommandBus.sendAsync(Object)that returns aMono.
The handling of a command usually doesn't return any value (according to the principles of CQRS), however theLocalCommandBusAPI allows aCommandHandlerto return a value if needed (e.g.LocalEventBus<EVENT_TYPE> Simple event bus that supports both synchronous and asynchronous subscribers that are registered and listening for events published within the local the JVM
You can have multiple instances of the LocalEventBus deployed with the local JVM, but usually one event bus is sufficient.
Example:MultipleCommandHandlersFoundException NoCommandHandlerFoundException OnErrorHandler<EVENT_TYPE> Error Handler interface for theLocalEventBusPublishException ReactiveHandlersBeanPostProcessor When using Spring or Spring Boot it will be easier to register theLocalEventBus,LocalCommandBus,CommandHandlerandEventHandlerinstances as @Bean or @Component and automatically have theCommandHandlerbeans registered as with the singleLocalCommandBusbean and theEventHandlerbeans registered as subscribers with the singleLocalEventBusbean.SendCommandException