EventProcessingConfiguration (Axon Framework 4.12.1 API)

All Known Implementing Classes:

EventProcessingModule
```
public interface EventProcessingConfiguration
```
Defines a contract for accessor methods regarding event processing configuration.

Since:

4.0

Author:

Milan Savic

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default Optional<EnqueuePolicy<EventMessage<?>>>`	`deadLetterPolicy(String processingGroup)` Returns the `dead letter policy` tied to the given `processingGroup` in an `Optional`.
`default Optional<SequencedDeadLetterQueue<EventMessage<?>>>`	`deadLetterQueue(String processingGroup)` Returns the `SequencedDeadLetterQueue` tied to the given `processingGroup` in an `Optional`.
`ErrorHandler`	`errorHandler(String processorName)` Returns the `ErrorHandler` tied to the given `processorName`.
`default <T extends EventProcessor> Optional<T>`	`eventProcessor(String name)` Obtains an `EventProcessor` through the given `name`.
`default <T extends EventProcessor> Optional<T>`	`eventProcessor(String name, Class<T> expectedType)` Returns the `EventProcessor` with the given `name` if present, matching the given `expectedType`.
`<T extends EventProcessor> Optional<T>`	`eventProcessorByProcessingGroup(String processingGroup)` Obtains an `EventProcessor` by it's `processingGroup`.
`default <T extends EventProcessor> Optional<T>`	`eventProcessorByProcessingGroup(String processingGroup, Class<T> expectedType)` Returns an `EventProcessor` by the given `processingGroup` if present, matching the given `expectedType`.
`Map<String,EventProcessor>`	`eventProcessors()` Obtains all registered `EventProcessor`s.
`List<MessageHandlerInterceptor<? super EventMessage<?>>>`	`interceptorsFor(String processorName)` Returns a `List` of `MessageHandlerInterceptor`s for a processor with given `processorName`.
`ListenerInvocationErrorHandler`	`listenerInvocationErrorHandler(String processingGroup)` Returns the `ListenerInvocationErrorHandler` tied to the given `processingGroup`.
`MessageMonitor<? super Message<?>>`	`messageMonitor(Class<?> componentType, String componentName)` Returns the `MessageMonitor` set to the given `componentType` and `componentName` registered within this configuration.
`RollbackConfiguration`	`rollbackConfiguration(String processorName)` Returns the `RollbackConfiguration` tied to the given `processorName`.
`default <T> SagaConfiguration<T>`	`sagaConfiguration(Class<T> sagaType)` Returns the `SagaConfiguration` for the given `sagaType`.
`List<SagaConfiguration<?>>`	`sagaConfigurations()` Returns a `List` of `SagaConfiguration`s registered within this configuration.
`default <T extends EventProcessor> Optional<T>`	`sagaEventProcessor(Class<?> sagaType)` Obtains an Saga `EventProcessor` implementation for the given `sagaType`.
`String`	`sagaProcessingGroup(Class<?> sagaType)` Gets the processing group for given `sagaType`.
`SagaStore`	`sagaStore()` Returns a `SagaStore` registered within this configuration.
`default Optional<SequencedDeadLetterProcessor<EventMessage<?>>>`	`sequencedDeadLetterProcessor(String processingGroup)` Returns the `SequencedDeadLetterProcessor` tied to the given `processingGroup` in an `Optional`.
`SequencingPolicy<? super EventMessage<?>>`	`sequencingPolicy(String processingGroup)` Returns the `SequencingPolicy` tied to the given `processingGroup`.
`TokenStore`	`tokenStore(String processorName)` Returns the `TokenStore` tied to the given `processorName`.
`TransactionManager`	`transactionManager(String processorName)` Returns the `TransactionManager` tied to the given `processorName`.

- Method Detail
  - eventProcessor
```
default <T extends EventProcessor> Optional<T> eventProcessor(String name)
```
    Obtains an EventProcessor through the given name.
    
    Type Parameters:
    
    T - the type of the expected EventProcessor
    
    Parameters:
    
    name - a String specifying the name of an EventProcessor
    
    Returns:
    
    an Optional specifying whether an EventProcessor with the given name exists
  - sagaEventProcessor
```
default <T extends EventProcessor> Optional<T> sagaEventProcessor(Class<?> sagaType)
```
    Obtains an Saga EventProcessor implementation for the given sagaType.
    
    Type Parameters:
    
    T - the type of the expected EventProcessor
    
    Parameters:
    
    sagaType - the type of Saga for which to get the Event Processor
    
    Returns:
    
    an Optional specifying whether an EventProcessor for the given SagaConfiguration exists
  - eventProcessor
```
default <T extends EventProcessor> Optional<T> eventProcessor(String name,
                                                              Class<T> expectedType)
```
    Returns the EventProcessor with the given name if present, matching the given expectedType.
    
    Type Parameters:
    
    T - the type of the expected EventProcessor
    
    Parameters:
    
    name - a String specifying the name of the EventProcessor to return
    
    expectedType - the type of the EventProcessor to return
    
    Returns:
    
    an Optional referencing the EventProcessor, if present and of expected type
  - eventProcessorByProcessingGroup
```
<T extends EventProcessor> Optional<T> eventProcessorByProcessingGroup(String processingGroup)
```
    Obtains an EventProcessor by it's processingGroup.
    
    Type Parameters:
    
    T - the type of the expected EventProcessor
    
    Parameters:
    
    processingGroup - a String specifying the processing group of an EventProcessor
    
    Returns:
    
    an Optional referencing the EventProcessor
  - eventProcessorByProcessingGroup
```
default <T extends EventProcessor> Optional<T> eventProcessorByProcessingGroup(String processingGroup,
                                                                               Class<T> expectedType)
```
    Returns an EventProcessor by the given processingGroup if present, matching the given expectedType.
    
    Type Parameters:
    
    T - the type of the expected EventProcessor
    
    Parameters:
    
    processingGroup - a String specifying the processing group of an EventProcessor
    
    expectedType - the type of the EventProcessor to return
    
    Returns:
    
    an Optional referencing the EventProcessor, if present and of expected type
  - eventProcessors
```
Map<String,EventProcessor> eventProcessors()
```
    Obtains all registered EventProcessors.
    
    Returns:
    
    a Map of registered EventProcessors within this configuration with the processor names as keys
  - sagaProcessingGroup
```
String sagaProcessingGroup(Class<?> sagaType)
```
    Gets the processing group for given sagaType.
    
    Parameters:
    
    sagaType - the type of Saga
    
    Returns:
    
    the processing group
  - interceptorsFor
```
List<MessageHandlerInterceptor<? super EventMessage<?>>> interceptorsFor(String processorName)
```
    Returns a List of MessageHandlerInterceptors for a processor with given processorName.
    
    Parameters:
    
    processorName - a String specifying a processing group
    
    Returns:
    
    a List of MessageHandlerInterceptors for a processor with given processorName
  - listenerInvocationErrorHandler
```
ListenerInvocationErrorHandler listenerInvocationErrorHandler(String processingGroup)
```
    Returns the ListenerInvocationErrorHandler tied to the given processingGroup.
    
    Parameters:
    
    processingGroup - a String specifying a processing group
    
    Returns:
    
    the ListenerInvocationErrorHandler belonging to the given processingGroup
  - sequencingPolicy
```
SequencingPolicy<? super EventMessage<?>> sequencingPolicy(String processingGroup)
```
    Returns the SequencingPolicy tied to the given processingGroup.
    
    Parameters:
    
    processingGroup - a String specifying a processing group
    
    Returns:
    
    the SequencingPolicy belonging to the given processingGroup
  - rollbackConfiguration
```
RollbackConfiguration rollbackConfiguration(String processorName)
```
    Returns the RollbackConfiguration tied to the given processorName.
    
    Parameters:
    
    processorName - a String specifying a processing group
    
    Returns:
    
    the RollbackConfiguration belonging to the given processorName
  - errorHandler
```
ErrorHandler errorHandler(String processorName)
```
    Returns the ErrorHandler tied to the given processorName.
    
    Parameters:
    
    processorName - a String specifying a processing group
    
    Returns:
    
    the ErrorHandler belonging to the given processorName
  - sagaStore
```
SagaStore sagaStore()
```
    Returns a SagaStore registered within this configuration.
    
    Returns:
    
    a SagaStore registered within this configuration
  - sagaConfigurations
```
List<SagaConfiguration<?>> sagaConfigurations()
```
    Returns a List of SagaConfigurations registered within this configuration.
    
    Returns:
    
    a List of SagaConfigurations registered within this configuration
  - sagaConfiguration
```
default <T> SagaConfiguration<T> sagaConfiguration(Class<T> sagaType)
```
    Returns the SagaConfiguration for the given sagaType. If no configuration has been provided for a Saga of this type, null is returned.
    
    Type Parameters:
    
    T - the type of Saga
    
    Parameters:
    
    sagaType - the type of Saga to return the configuration for.
    
    Returns:
    
    the configuration for the Saga, or null if not found
  - messageMonitor
```
MessageMonitor<? super Message<?>> messageMonitor(Class<?> componentType,
                                                  String componentName)
```
    Returns the MessageMonitor set to the given componentType and componentName registered within this configuration.
    
    Parameters:
    
    componentType - a Class type of component to be monitored
    
    componentName - a String specifying the name of the component to be monitored
    
    Returns:
    
    the MessageMonitor registered to the given componentType and componentName
  - tokenStore
```
TokenStore tokenStore(String processorName)
```
    Returns the TokenStore tied to the given processorName.
    
    Parameters:
    
    processorName - a String specifying a event processor
    
    Returns:
    
    the TokenStore belonging to the given processorName
  - transactionManager
```
TransactionManager transactionManager(String processorName)
```
    Returns the TransactionManager tied to the given processorName.
    
    Parameters:
    
    processorName - a String specifying a processing group
    
    Returns:
    
    the TransactionManagerbelonging to the given processorName
  - deadLetterQueue
```
default Optional<SequencedDeadLetterQueue<EventMessage<?>>> deadLetterQueue(@Nonnull
                                                                            String processingGroup)
```
    Returns the SequencedDeadLetterQueue tied to the given processingGroup in an Optional. May return an empty optional when there's no SequencedDeadLetterQueue present for the given processingGroup.
    
    Parameters:
    
    processingGroup - The name of the processing group for which to return a SequencedDeadLetterQueue.
    
    Returns:
    
    The SequencedDeadLetterQueue tied to the given processingGroup, Optional.empty() if there is none.
  - deadLetterPolicy
```
default Optional<EnqueuePolicy<EventMessage<?>>> deadLetterPolicy(@Nonnull
                                                                  String processingGroup)
```
    Returns the dead letter policy tied to the given processingGroup in an Optional. May return an Optional containing the default policy if present.
    
    Parameters:
    
    processingGroup - The name of the processing group for which to return an EnqueuePolicy.
    
    Returns:
    
    The EnqueuePolicy belonging to the given processingGroup.
  - sequencedDeadLetterProcessor
```
default Optional<SequencedDeadLetterProcessor<EventMessage<?>>> sequencedDeadLetterProcessor(@Nonnull
                                                                                             String processingGroup)
```
    Returns the SequencedDeadLetterProcessor tied to the given processingGroup in an Optional. Returns an empty optional when the processingGroup does not have a SequencedDeadLetterQueue attached to it.
    
    Parameters:
    
    processingGroup - The name of the processing group for which to return an EnqueuePolicy.
    
    Returns:
    
    The SequencedDeadLetterProcessor tied to the given processingGroup in an Optional, Optional.empty() if there is none.

Interface EventProcessingConfiguration

Method Summary

Method Detail

eventProcessor

sagaEventProcessor

eventProcessor

eventProcessorByProcessingGroup

eventProcessorByProcessingGroup

eventProcessors

sagaProcessingGroup

interceptorsFor

listenerInvocationErrorHandler

sequencingPolicy

rollbackConfiguration

errorHandler

sagaStore

sagaConfigurations

sagaConfiguration

messageMonitor

tokenStore

transactionManager

deadLetterQueue

deadLetterPolicy

sequencedDeadLetterProcessor