Package org.axonframework.config

Class MessageHandlerRegistrar

java.lang.Object

org.axonframework.config.MessageHandlerRegistrar

All Implemented Interfaces:

Lifecycle

public class MessageHandlerRegistrar
extends Object
implements Lifecycle

The MessageHandlerRegistrar manages the lifecycle of a message handling component, by defining a start() and shutdown() method and keeping hold of the message handler's Registration.

Note that this component is not intended for Event Handling Components, as those should be registered through the EventProcessingConfigurer.

Since:

4.3

Author:

Steven van Beelen

Nested Class Summary

Nested classes/interfaces inherited from interface org.axonframework.lifecycle.Lifecycle

Lifecycle.LifecycleHandler, Lifecycle.LifecycleRegistry

Constructor Summary

Constructors

Constructor	Description
MessageHandlerRegistrar(Supplier<Configuration> configSupplier, Function<Configuration,Object> messageHandlerBuilder, BiFunction<Configuration,Object,Registration> messageHandlerSubscriber)	Instantiate a MessageHandlerRegistrar, using the provided configSupplier to supply the Configuration needed to build and register the message handler.

Method Summary

Modifier and Type	Method	Description
void	registerLifecycleHandlers(Lifecycle.LifecycleRegistry handle)	Registers the activities to be executed in the various phases of an application's lifecycle.
void	shutdown()	Close the message handler registration initialized in phase Phase.LOCAL_MESSAGE_HANDLER_REGISTRATIONS through the start() method.
void	start()	Start the message handler registration process by building the message handler in the Phase.LOCAL_MESSAGE_HANDLER_REGISTRATIONS phase.

Methods inherited from class java.lang.Object

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

Constructor Details

MessageHandlerRegistrar

public MessageHandlerRegistrar(Supplier<Configuration> configSupplier,
 Function<Configuration,Object> messageHandlerBuilder,
 BiFunction<Configuration,Object,Registration> messageHandlerSubscriber)

Instantiate a MessageHandlerRegistrar, using the provided configSupplier to supply the Configuration needed to build and register the message handler. For the latter operations the given messageHandlerBuilder and messageHandlerSubscriber will be used respectively.

Parameters:

configSupplier - a Supplier of the Configuration to be used by the given messageHandlerBuilder and messageHandlerSubscriber

messageHandlerBuilder - a Function using the configSupplier's input to create a message handler

messageHandlerSubscriber - a BiFunction using the the configSupplier and messageHandlerBuilder their output to register the created message handler with the Configuration

Method Details

registerLifecycleHandlers

public void registerLifecycleHandlers(@Nonnull
 Lifecycle.LifecycleRegistry handle)

Description copied from interface: Lifecycle

Registers the activities to be executed in the various phases of an application's lifecycle. This could either be at startup, shutdown, or both.

Specified by:

registerLifecycleHandlers in interface Lifecycle

Parameters:

handle - the lifecycle instance to register the handlers with

See Also:

• Lifecycle.LifecycleRegistry.onShutdown(int, Runnable)
• Lifecycle.LifecycleRegistry.onShutdown(int, LifecycleHandler)
• Lifecycle.LifecycleRegistry.onStart(int, Runnable)
• Lifecycle.LifecycleRegistry.onStart(int, LifecycleHandler)

start

public void start()

Start the message handler registration process by building the message handler in the Phase.LOCAL_MESSAGE_HANDLER_REGISTRATIONS phase. The specified messageHandlerBuilder is used for creation and registration is performed through the messageHandlerSubscriber.

shutdown

public void shutdown()

Close the message handler registration initialized in phase Phase.LOCAL_MESSAGE_HANDLER_REGISTRATIONS through the start() method.