org.axonframework.extensions.springcloud.commandhandling.mode

Class AcceptAllCommandsDiscoveryMode

java.lang.Object

org.axonframework.extensions.springcloud.commandhandling.mode.AbstractCapabilityDiscoveryMode<AcceptAllCommandsDiscoveryMode>

org.axonframework.extensions.springcloud.commandhandling.mode.AcceptAllCommandsDiscoveryMode

All Implemented Interfaces:

CapabilityDiscoveryMode

public class AcceptAllCommandsDiscoveryMode
extends AbstractCapabilityDiscoveryMode<AcceptAllCommandsDiscoveryMode>

Implementation of the CapabilityDiscoveryMode which defaults its own MemberCapabilities to accept all incoming commands. It does so by enforcing the CommandMessageFilter to AcceptAll on each invocation of updateLocalCapabilities(ServiceInstance, int, CommandMessageFilter). This implementation thus does not take into account the given CommandMessageFilter upon any updateLocalCapabilities(ServiceInstance, int, CommandMessageFilter) invocation.

Using this implementation would be a valid solution in a homogeneous command handling system, where every node can handling everything.

Note that both the updateLocalCapabilities(ServiceInstance, int, CommandMessageFilter) and capabilities(ServiceInstance) operations are delegated towards another CapabilityDiscoveryMode instance to ensure MemberCapabilities can still be found and delegated as is required of a CapabilityDiscoveryMode implementation.

Since:

4.4

Author:

Steven van Beelen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AcceptAllCommandsDiscoveryMode.Builder Builder class to instantiate a AcceptAllCommandsDiscoveryMode.

Field Summary

Fields inherited from class org.axonframework.extensions.springcloud.commandhandling.mode.AbstractCapabilityDiscoveryMode

localCapabilities, localInstance

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AcceptAllCommandsDiscoveryMode(AcceptAllCommandsDiscoveryMode.Builder builder) Instantiate a AcceptAllCommandsDiscoveryMode based on the fields contained in the AcceptAllCommandsDiscoveryMode.Builder.

Method Summary

Modifier and Type	Method and Description
static AcceptAllCommandsDiscoveryMode.Builder	builder() Instantiate a AcceptAllCommandsDiscoveryMode.Builder to be able to create a AcceptAllCommandsDiscoveryMode.
Optional<MemberCapabilities>	capabilities(org.springframework.cloud.client.ServiceInstance serviceInstance) Discovers the capabilities of the given serviceInstance, returning an Optional MemberCapabilities.
void	updateLocalCapabilities(org.springframework.cloud.client.ServiceInstance localInstance, int loadFactor, org.axonframework.commandhandling.distributed.CommandMessageFilter commandFilter) Update the capabilities of the localInstance, defined through the given loadFactor and commandFilter.

Methods inherited from class java.lang.Object

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

Constructor Detail

AcceptAllCommandsDiscoveryMode

protected AcceptAllCommandsDiscoveryMode(AcceptAllCommandsDiscoveryMode.Builder builder)

Instantiate a AcceptAllCommandsDiscoveryMode based on the fields contained in the AcceptAllCommandsDiscoveryMode.Builder.

Will assert that the delegate CapabilityDiscoveryMode is not null and will throw an AxonConfigurationException if this is the case.

Parameters:

builder - the AcceptAllCommandsDiscoveryMode.Builder used to instantiate a AcceptAllCommandsDiscoveryMode instance

Method Detail

builder

public static AcceptAllCommandsDiscoveryMode.Builder builder()

Instantiate a AcceptAllCommandsDiscoveryMode.Builder to be able to create a AcceptAllCommandsDiscoveryMode.

The delegate CapabilityDiscoveryMode is a hard requirement and as such should be provided.

Returns:

a AcceptAllCommandsDiscoveryMode.Builder to be able to create a AcceptAllCommandsDiscoveryMode

updateLocalCapabilities

public void updateLocalCapabilities(org.springframework.cloud.client.ServiceInstance localInstance,
                                    int loadFactor,
                                    org.axonframework.commandhandling.distributed.CommandMessageFilter commandFilter)

Description copied from interface: CapabilityDiscoveryMode

Update the capabilities of the localInstance, defined through the given loadFactor and commandFilter.

Specified by:

updateLocalCapabilities in interface CapabilityDiscoveryMode

Overrides:

updateLocalCapabilities in class AbstractCapabilityDiscoveryMode<AcceptAllCommandsDiscoveryMode>

Parameters:

localInstance - the local ServiceInstance

loadFactor - the load factor of the local instance, defining the amount of load this instance can carry

commandFilter - a filter defining the CommandMessages the local instance is capable of handling

capabilities

public Optional<MemberCapabilities> capabilities(org.springframework.cloud.client.ServiceInstance serviceInstance)
                                          throws ServiceInstanceClientException

Description copied from interface: CapabilityDiscoveryMode

Discovers the capabilities of the given serviceInstance, returning an Optional MemberCapabilities.

Parameters:

serviceInstance - the ServiceInstance to discover MemberCapabilities for

Returns:

an Optional MemberCapabilities, based on the given serviceInstance

Throws:

ServiceInstanceClientException - whenever the ServiceInstance returns a client specific exception