Package org.axonframework.config

Interface ModuleConfiguration

All Known Subinterfaces:

AggregateConfiguration<A>

All Known Implementing Classes:

AggregateConfigurer, AxonIQConsoleModule, EventProcessingModule, EventProcessorInfoConfiguration, HeartbeatConfiguration

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.

Since:

3.0

Author:

Allard Buijze

Method Summary

Modifier and Type	Method	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()	Deprecated. a ModuleConfiguration's phase is no longer used, as distinct phases might be necessary for any of the start or shutdown processes added in the initialize(Configuration) method
default void	shutdown()	Deprecated. in favor of maintaining shutdown operations in the Component.
default void	start()	Deprecated. in favor of maintaining start operations in the Component.
default ModuleConfiguration	unwrap()	Returns the actual module configuration instance.

Method Details

initialize

void initialize(Configuration config)

Initialize the module configuration using the given global config. Any specific start up or shut down processes should be added here by using the provided config and invoke LifecycleOperations.onStart(int, LifecycleHandler) and LifecycleOperations.onShutdown(int, LifecycleHandler) respectively.

Parameters:

config - the global configuration, providing access to generic components

phase

@Deprecated
default int phase()

Deprecated.

a ModuleConfiguration's phase is no longer used, as distinct phases might be necessary for any of the start or shutdown processes added in the initialize(Configuration) method

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

Returns:

this module's phase

start

@Deprecated
default void start()

Deprecated.

in favor of maintaining start operations in the Component. Any lifecycle operations not covered through the components created by this ModuleConfiguration should be added to the Configuration in initialize(Configuration) through LifecycleOperations.onStart(int, LifecycleHandler)

Invoked when the Configuration is started.

See Also:

• Configuration.start()

shutdown

@Deprecated
default void shutdown()

Deprecated.

in favor of maintaining shutdown operations in the Component. Any lifecycle operations not covered through the components created by this ModuleConfiguration should be added to the Configuration in initialize(Configuration) through LifecycleOperations.onShutdown(int, LifecycleHandler)

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