org.axonframework.axonserver.connector.processor

Class EventProcessorControlService

java.lang.Object

org.axonframework.axonserver.connector.processor.EventProcessorControlService

All Implemented Interfaces:

Lifecycle

public class EventProcessorControlService
extends Object
implements Lifecycle

Service that listens to PlatformOutboundInstructions to control EventProcessors when for example requested by Axon Server. Will delegate the calls to the AxonServerConnectionManager for further processing.

Since:

4.0

Author:

Sara Pellegrini

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	EventProcessorControlService.AxonProcessorInstructionHandler

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

Lifecycle.LifecycleHandler, Lifecycle.LifecycleRegistry

Field Summary

Fields

Modifier and Type	Field and Description
protected AxonServerConnectionManager	axonServerConnectionManager
protected String	context
protected EventProcessingConfiguration	eventProcessingConfiguration
protected Map<String,AxonServerConfiguration.Eventhandling.ProcessorSettings>	processorConfig

Constructor Summary

Constructors

Constructor and Description
EventProcessorControlService(AxonServerConnectionManager axonServerConnectionManager, EventProcessingConfiguration eventProcessingConfiguration, AxonServerConfiguration axonServerConfiguration) Initialize a EventProcessorControlService.
EventProcessorControlService(AxonServerConnectionManager axonServerConnectionManager, EventProcessingConfiguration eventProcessingConfiguration, String context) Deprecated. Please use EventProcessorControlService(AxonServerConnectionManager, EventProcessingConfiguration, String, Map) to ensure processor settings are provided.
EventProcessorControlService(AxonServerConnectionManager axonServerConnectionManager, EventProcessingConfiguration eventProcessingConfiguration, String context, Map<String,AxonServerConfiguration.Eventhandling.ProcessorSettings> processorConfig) Initialize a EventProcessorControlService.

Method Summary

Modifier and Type	Method and Description
protected Supplier<io.axoniq.axonserver.grpc.control.EventProcessorInfo>	infoSupplier(EventProcessor processor) Constructs an EventProcessorInfo for the given processor.
void	registerLifecycleHandlers(Lifecycle.LifecycleRegistry lifecycle) Registers the activities to be executed in the various phases of an application's lifecycle.
void	start() Registers EventProcessor instruction handlers to the ControlChannel for the configured context and set the load balancing strategies through the AdminChannel for the configured context.

Methods inherited from class java.lang.Object

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

Field Detail

axonServerConnectionManager

protected final AxonServerConnectionManager axonServerConnectionManager

eventProcessingConfiguration

protected final EventProcessingConfiguration eventProcessingConfiguration

context

protected final String context

processorConfig

protected final Map<String,AxonServerConfiguration.Eventhandling.ProcessorSettings> processorConfig

Constructor Detail

EventProcessorControlService

public EventProcessorControlService(AxonServerConnectionManager axonServerConnectionManager,
                                    EventProcessingConfiguration eventProcessingConfiguration,
                                    AxonServerConfiguration axonServerConfiguration)

Initialize a EventProcessorControlService.

This service adds processor instruction handlers to the ControlChannel of the default context. Doing so ensures operation like the start and shutdown can be triggered through Axon Server. Furthermore, it sets the configured load balancing strategies} through the AdminChannel of the default context.

Parameters:

axonServerConnectionManager - A AxonServerConnectionManager from which to retrieve the ControlChannel and AdminChannel.

eventProcessingConfiguration - The EventProcessor configuration of this application, used to retrieve the registered event processors from.

axonServerConfiguration - The AxonServerConfiguration used to retrieve the default context from.

EventProcessorControlService

@Deprecated
public EventProcessorControlService(AxonServerConnectionManager axonServerConnectionManager,
                                                EventProcessingConfiguration eventProcessingConfiguration,
                                                String context)

Deprecated. Please use EventProcessorControlService(AxonServerConnectionManager, EventProcessingConfiguration, String, Map) to ensure processor settings are provided.

Initialize a EventProcessorControlService.

This service adds processor instruction handlers to the ControlChannel of the given context. Doing so ensures operation like the start and shutdown can be triggered through Axon Server. Furthermore, it sets the configured load balancing strategies} through the AdminChannel of the context.

Parameters:

axonServerConnectionManager - A AxonServerConnectionManager from which to retrieve the ControlChannel and AdminChannel.

eventProcessingConfiguration - The EventProcessor configuration of this application, used to retrieve the registered event processors from.

context - The context of this application instance to retrieve the ControlChannel and AdminChannel for.

EventProcessorControlService

public EventProcessorControlService(AxonServerConnectionManager axonServerConnectionManager,
                                    EventProcessingConfiguration eventProcessingConfiguration,
                                    String context,
                                    Map<String,AxonServerConfiguration.Eventhandling.ProcessorSettings> processorConfig)

Initialize a EventProcessorControlService.

This service adds processor instruction handlers to the ControlChannel of the given context. Doing so ensures operation like the start and shutdown can be triggered through Axon Server. Furthermore, it sets the configured load balancing strategies through the AdminChannel of the context.

Parameters:

axonServerConnectionManager - A AxonServerConnectionManager from which to retrieve the ControlChannel and AdminChannel.

eventProcessingConfiguration - The EventProcessor configuration of this application, used to retrieve the registered event processors from.

context - The context of this application instance to retrieve the ControlChannel and AdminChannel for.

processorConfig - The processor configuration from the AxonServerConfiguration, used to (for example) retrieve the load balancing strategies from.

Method Detail

registerLifecycleHandlers

public void registerLifecycleHandlers(@Nonnull
                                      Lifecycle.LifecycleRegistry lifecycle)

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:

lifecycle - the lifecycle instance to register the handlers with

See Also:

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

start

public void start()

Registers EventProcessor instruction handlers to the ControlChannel for the configured context and set the load balancing strategies through the AdminChannel for the configured context.

The registration is performed in Phase.INBOUND_EVENT_CONNECTORS phase, to ensure the event processors this service provides control over have been started.

infoSupplier

protected Supplier<io.axoniq.axonserver.grpc.control.EventProcessorInfo> infoSupplier(EventProcessor processor)

Constructs an EventProcessorInfo for the given processor. Typically results in a StreamingEventProcessor or SubscribingEventProcessor specific instance.

Parameters:

processor - The EventProcessor to construct a EventProcessorInfo for.

Returns:

A Supplier of EventProcessorInfo, based on the given processor.