public interface Configuration
Note that certain components in the Configuration may need to be started. Therefore, before using any of the
components provided by this configuration, ensure that start()
has been invoked.
Modifier and Type | Method and Description |
---|---|
default CommandBus |
commandBus()
Returns the Command Bus defined in this Configuration.
|
default CommandGateway |
commandGateway()
Returns the Command Gateway defined in this Configuration.
|
List<CorrelationDataProvider> |
correlationDataProviders()
Returns the Correlation Data Providers defined in this Configuration.
|
default DeadlineManager |
deadlineManager()
Returns the Deadline Manager defined in this Configuration.
|
default EventBus |
eventBus()
Retrieves the Event Bus defined in this Configuration.
|
default EventGateway |
eventGateway()
Returns the Event Gateway defined in this Configuration.
|
default EventProcessingConfiguration |
eventProcessingConfiguration()
Returns the
EventProcessingConfiguration defined in this Configuration. |
Serializer |
eventSerializer()
Returns the
Serializer defined in this Configuration to be used for serializing Event Message payload
and their metadata. |
default EventStore |
eventStore()
Returns the Event Store in this Configuration, if it is defined.
|
default <T extends ModuleConfiguration> |
findModules(Class<T> moduleType)
Finds all configuration modules of given
moduleType within this configuration. |
default <T> T |
getComponent(Class<T> componentType)
Returns the Component declared under the given
componentType , typically the interface the component
implements. |
<T> T |
getComponent(Class<T> componentType,
Supplier<T> defaultImpl)
Returns the Component declared under the given
componentType , typically the interface the component
implements, reverting to the given defaultImpl if no such component is defined. |
List<ModuleConfiguration> |
getModules()
Returns all modules that have been registered with this Configuration.
|
HandlerDefinition |
handlerDefinition(Class<?> inspectedType)
Returns the Handler Definition defined in this Configuration for the given
inspectedType . |
<M extends Message<?>> |
messageMonitor(Class<?> componentType,
String componentName)
Returns the message monitor configured for a component of given
componentType and componentName . |
Serializer |
messageSerializer()
Returns the
Serializer defined in this Configuration to be used for serializing Message payloads and
metadata. |
void |
onShutdown(int phase,
LifecycleHandler shutdownHandler)
Registers an asynchronous
shutdownHandler to be executed in the given phase when the
Configuration is shut down. |
default void |
onShutdown(int phase,
Runnable shutdownHandler)
Registers a
shutdownHandler to be executed in the given phase when the Configuration is shut
down. |
default void |
onShutdown(Runnable shutdownHandler)
Registers a
shutdownHandler to be executed in the default phase 0 when the Configuration is shut
down. |
void |
onStart(int phase,
LifecycleHandler startHandler)
Registers an asynchronous
startHandler to be executed in the given phase when this Configuration
is started. |
default void |
onStart(int phase,
Runnable startHandler)
Registers a
startHandler to be executed in the given phase when this Configuration is started. |
default void |
onStart(Runnable startHandler)
Registers a
startHandler to be executed in the default phase 0 when this Configuration is
started. |
default ParameterResolverFactory |
parameterResolverFactory()
Returns the Parameter Resolver Factory defined in this Configuration
|
default QueryBus |
queryBus() |
default QueryGateway |
queryGateway()
Returns the Query Gateway defined in this Configuration.
|
default QueryUpdateEmitter |
queryUpdateEmitter()
Returns the Query Update Emitter in this Configuration.
|
<T> Repository<T> |
repository(Class<T> aggregateType)
Returns the Repository configured for the given
aggregateType . |
default ResourceInjector |
resourceInjector()
Returns the ResourceInjector used to provide resources to Saga instances.
|
default Serializer |
serializer()
Returns the serializer defined in this Configuration
|
void |
shutdown()
Shuts down the components defined in this Configuration
|
void |
start()
Starts this configuration.
|
default TagsConfiguration |
tags()
Returns the Tags Configuration defined in this Configuration.
|
EventUpcasterChain |
upcasterChain()
Returns the EventUpcasterChain with all registered upcasters.
|
default EventBus eventBus()
default EventStore eventStore()
AxonConfigurationException
.default <T extends ModuleConfiguration> List<T> findModules(Class<T> moduleType)
moduleType
within this configuration.T
- The type of the configuration modulemoduleType
- The type of the configuration modulemoduleType
defined in this configurationdefault CommandBus commandBus()
start()
) before sending Commands over the Command Bus.default QueryBus queryBus()
default QueryUpdateEmitter queryUpdateEmitter()
start()
before emitting updates over Query Update Emitter.default ResourceInjector resourceInjector()
default CommandGateway commandGateway()
start()
) before sending Commands using this Command Gateway.default EventProcessingConfiguration eventProcessingConfiguration() throws AxonConfigurationException
EventProcessingConfiguration
defined in this Configuration. If there aren't any defined,
null
will be returned. If there is exactly one, it will be returned. For case when there are multiple,
an AxonConfigurationException
is thrown and the getModules()
API should be used instead.EventProcessingConfiguration
defined in this ConfigurationAxonConfigurationException
- thrown if there are more than one Event Processing Configurations defined with
this configurationdefault QueryGateway queryGateway()
start()
) before sending Queries using this Query Gateway.default EventGateway eventGateway()
default TagsConfiguration tags()
<T> Repository<T> repository(Class<T> aggregateType)
aggregateType
.T
- The aggregate typeaggregateType
- The aggregate type to find the repository fordefault <T> T getComponent(Class<T> componentType)
componentType
, typically the interface the component
implements.T
- The type of componentcomponentType
- The type of componentnull
if no such component exists<T> T getComponent(Class<T> componentType, Supplier<T> defaultImpl)
componentType
, typically the interface the component
implements, reverting to the given defaultImpl
if no such component is defined.
When no component was previously registered, the default is then configured as the component for the given type.
T
- The type of componentcomponentType
- The type of componentdefaultImpl
- The supplier of the default to return if no component was registereddefaultImpl
supplier,
if no component was registered<M extends Message<?>> MessageMonitor<? super M> messageMonitor(Class<?> componentType, String componentName)
componentType
and componentName
.M
- The type of message the monitor can deal withcomponentType
- The type of component to return the monitor forcomponentName
- The name of the componentdefault Serializer serializer()
Serializer eventSerializer()
Serializer
defined in this Configuration to be used for serializing Event Message payload
and their metadata.Serializer messageSerializer()
Serializer
defined in this Configuration to be used for serializing Message payloads and
metadata.void start()
void shutdown()
List<CorrelationDataProvider> correlationDataProviders()
default ParameterResolverFactory parameterResolverFactory()
HandlerDefinition handlerDefinition(Class<?> inspectedType)
inspectedType
.inspectedType
- The class to being inspected for handlersdefault DeadlineManager deadlineManager()
List<ModuleConfiguration> getModules()
default void onStart(Runnable startHandler)
startHandler
to be executed in the default phase 0
when this Configuration is
started.
The behavior for handlers that are registered when the Configuration is already started is undefined.
startHandler
- the handler to execute when the configuration is startedstart()
default void onStart(int phase, Runnable startHandler)
startHandler
to be executed in the given phase
when this Configuration is started.
The behavior for handlers that are registered when the Configuration is already started is undefined.
void onStart(int phase, LifecycleHandler startHandler)
startHandler
to be executed in the given phase
when this Configuration
is started.
The behavior for handlers that are registered when the Configuration is already started is undefined.
phase
- defines a phase
in which the start handler will be invoked during start()
. When starting the configuration the given handlers are started in
ascending order based on their phase
startHandler
- the handler to be executed asynchronously when the configuration is startedstart()
default void onShutdown(Runnable shutdownHandler)
shutdownHandler
to be executed in the default phase 0
when the Configuration is shut
down.
The behavior for handlers that are registered when the Configuration is already shut down is undefined.
shutdownHandler
- the handler to execute when the Configuration is shut downshutdown()
default void onShutdown(int phase, Runnable shutdownHandler)
shutdownHandler
to be executed in the given phase
when the Configuration is shut
down.
The behavior for handlers that are registered when the Configuration is already shut down is undefined.
phase
- defines a phase in which the shutdown handler will be invoked during shutdown()
. When shutting down the configuration the given handlers are
executing in descending order based on their phase
shutdownHandler
- the handler to execute when the Configuration is shut downshutdown()
void onShutdown(int phase, LifecycleHandler shutdownHandler)
shutdownHandler
to be executed in the given phase
when the
Configuration is shut down.
The behavior for handlers that are registered when the Configuration is already shut down is undefined.
phase
- defines a phase in which the shutdown handler will be invoked during shutdown()
. When shutting down the configuration the given handlers are
executing in descending order based on their phase
shutdownHandler
- the handler to be executed asynchronously when the Configuration is shut downshutdown()
EventUpcasterChain upcasterChain()
Copyright © 2010–2020. All rights reserved.