org.axonframework.config

Interface ModuleConfiguration

All Known Subinterfaces:

AggregateConfiguration<A>

All Known Implementing Classes:

AggregateConfigurer, EventProcessingModule, EventProcessorInfoConfiguration

public interface ModuleConfiguration

Interface describing a module for the Axon Configuration API. These modules are relatively independent, but have access to the component available in the main Configuration.

Modules have callback methods for the initialization, start and shutdown phases of the application's lifecycle.

Method Summary

Modifier and Type	Method and Description
void	initialize(Configuration config) Initialize the module configuration using the given global config
default boolean	isType(Class<?> type) Checks whether this Module Configuration is of the given type.
default int	phase() Defines a phase in which this module's initialize(Configuration), start(), shutdown() will be invoked.
void	shutdown() Invoked prior to shutdown of the application.
void	start() Invoked when the Configuration is started.
default ModuleConfiguration	unwrap() Returns the actual module configuration instance.

Method Detail

initialize

void initialize(Configuration config)

Initialize the module configuration using the given global config

Parameters:

config - the global configuration, providing access to generic components

phase

default int phase()

Defines a phase in which this module's initialize(Configuration), start(), shutdown() will be invoked.

Returns:

this module's phase

start

void start()

Invoked when the Configuration is started.

See Also:

Configuration.start()

shutdown

void shutdown()

Invoked prior to shutdown of the application.

See Also:

Configuration.shutdown()

unwrap

default ModuleConfiguration unwrap()

Returns the actual module configuration instance. Usually, it is the instance itself. However, in case of module configuration wrappers, we would like to provide the wrapped module configuration as the instance.

Returns:

the actual module configuration instance

isType

default boolean isType(Class<?> type)

Checks whether this Module Configuration is of the given type.

Parameters:

type - a Class type to check the Module Configuration against

Returns:

whether Module Configuration is of given type