org.axonframework.extensions.springcloud.commandhandling

Class SpringCloudCommandRouter.Builder

java.lang.Object

org.axonframework.extensions.springcloud.commandhandling.SpringCloudCommandRouter.Builder

Direct Known Subclasses:

SpringCloudHttpBackupCommandRouter.Builder

Enclosing class:

SpringCloudCommandRouter

public static class SpringCloudCommandRouter.Builder
extends Object

Builder class to instantiate a SpringCloudCommandRouter.

The Serializer is defaulted to a XStreamSerializer, the serviceInstanceFilter to accept all instances, and the ConsistentHashChangeListener to a no-op solution. The DiscoveryClient, localServiceInstance of type Registration, the RoutingStrategy and the CapabilityDiscoveryMode are hard requirements and as such should be provided.

Field Summary

Fields

Modifier and Type	Field and Description
protected Supplier<org.axonframework.serialization.Serializer>	serializerSupplier

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SpringCloudCommandRouter	build() Initializes a SpringCloudCommandRouter as specified through this Builder.
SpringCloudCommandRouter.Builder	capabilityDiscoveryMode(CapabilityDiscoveryMode capabilityDiscoveryMode) Defines the CapabilityDiscoveryMode used by this CommandRouter implementation.
SpringCloudCommandRouter.Builder	consistentHashChangeListener(org.axonframework.commandhandling.distributed.ConsistentHashChangeListener consistentHashChangeListener) Sets the ConsistentHashChangeListener which is notified when a change in membership has potentially caused a change in the consistent hash.
SpringCloudCommandRouter.Builder	contextRootMetadataPropertyName(String contextRootMetadataPropertyName) Sets a property key to be expected in the ServiceInstance.getMetadata() returned object, defining the context root for the given ServiceInstance.
SpringCloudCommandRouter.Builder	discoveryClient(org.springframework.cloud.client.discovery.DiscoveryClient discoveryClient) Sets the DiscoveryClient used to discovery and notify other nodes.
SpringCloudCommandRouter.Builder	localServiceInstance(org.springframework.cloud.client.serviceregistry.Registration localServiceInstance) Sets the Registration, representing the local Service Instance of this application.
SpringCloudCommandRouter.Builder	routingStrategy(org.axonframework.commandhandling.distributed.RoutingStrategy routingStrategy) Sets the RoutingStrategy used to define the key on which Command Messages are routed to their respective nodes.
SpringCloudCommandRouter.Builder	serializer(org.axonframework.serialization.Serializer serializer) Sets the Serializer used to de-/serialize the CommandMessageFilter.
SpringCloudCommandRouter.Builder	serviceInstanceFilter(Predicate<org.springframework.cloud.client.ServiceInstance> serviceInstanceFilter) Sets a Predicate of generic type ServiceInstance, used to filter out ServiceInstances from the membership update loop.
protected void	validate() Validate whether the fields contained in this Builder as set accordingly.

Methods inherited from class java.lang.Object

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

Field Detail

serializerSupplier

protected Supplier<org.axonframework.serialization.Serializer> serializerSupplier

Constructor Detail

Builder

public Builder()

Method Detail

discoveryClient

public SpringCloudCommandRouter.Builder discoveryClient(org.springframework.cloud.client.discovery.DiscoveryClient discoveryClient)

Sets the DiscoveryClient used to discovery and notify other nodes. Used to update its own membership as a CommandRouter and to create its awareness of available nodes to send commands to.

Parameters:

discoveryClient - the DiscoveryClient used to discovery and notify other nodes

Returns:

the current Builder instance, for fluent interfacing

localServiceInstance

public SpringCloudCommandRouter.Builder localServiceInstance(org.springframework.cloud.client.serviceregistry.Registration localServiceInstance)

Sets the Registration, representing the local Service Instance of this application. Necessary to differentiate other instances from the local instance to ensure correct message routing.

Parameters:

localServiceInstance - the Registration, representing the local Service Instance of this application

Returns:

the current Builder instance, for fluent interfacing

routingStrategy

public SpringCloudCommandRouter.Builder routingStrategy(org.axonframework.commandhandling.distributed.RoutingStrategy routingStrategy)

Sets the RoutingStrategy used to define the key on which Command Messages are routed to their respective nodes.

Parameters:

routingStrategy - the RoutingStrategy used to define the key on which Command Messages are routed to their respective nodes

Returns:

the current Builder instance, for fluent interfacing

capabilityDiscoveryMode

public SpringCloudCommandRouter.Builder capabilityDiscoveryMode(CapabilityDiscoveryMode capabilityDiscoveryMode)

Defines the CapabilityDiscoveryMode used by this CommandRouter implementation. The CapabilityDiscoveryMode is in charge of discovering the capabilities of other nodes and sharing this node's capabilities.

Parameters:

capabilityDiscoveryMode - a CapabilityDiscoveryMode in charge of discovering the capabilities of other nodes and sharing this node's capabilities

Returns:

the current Builder instance, for fluent interfacing

serializer

public SpringCloudCommandRouter.Builder serializer(org.axonframework.serialization.Serializer serializer)

Sets the Serializer used to de-/serialize the CommandMessageFilter. It is strongly recommended to use the XStreamSerializer for this, as the CommandMessageFilter is not set up to be serialized through Jackson. Defaults to the XStreamSerializer.

Parameters:

serializer - a Serializer used to de-/serialize CommandMessageFilter

Returns:

the current Builder instance, for fluent interfacing

serviceInstanceFilter

public SpringCloudCommandRouter.Builder serviceInstanceFilter(Predicate<org.springframework.cloud.client.ServiceInstance> serviceInstanceFilter)

Sets a Predicate of generic type ServiceInstance, used to filter out ServiceInstances from the membership update loop. Defaults to allow all ServiceInstances.

Parameters:

serviceInstanceFilter - the Predicate of generic type ServiceInstance, used to filter out ServiceInstances from the membership update loop

Returns:

the current Builder instance, for fluent interfacing

consistentHashChangeListener

public SpringCloudCommandRouter.Builder consistentHashChangeListener(org.axonframework.commandhandling.distributed.ConsistentHashChangeListener consistentHashChangeListener)

Sets the ConsistentHashChangeListener which is notified when a change in membership has potentially caused a change in the consistent hash. Defaults to a no-op solution.

Parameters:

consistentHashChangeListener - the ConsistentHashChangeListener which is notified when a change in membership has potentially caused a change in the consistent hash

Returns:

the current Builder instance, for fluent interfacing

contextRootMetadataPropertyName

public SpringCloudCommandRouter.Builder contextRootMetadataPropertyName(String contextRootMetadataPropertyName)

Sets a property key to be expected in the ServiceInstance.getMetadata() returned object, defining the context root for the given ServiceInstance. Will be used to correctly configure the URI of a Member. Will default to null.

Parameters:

contextRootMetadataPropertyName - the optional metadata property field of a ServiceInstance that contains the context root path of the service in question

Returns:

the current Builder instance, for fluent interfacing

build

public SpringCloudCommandRouter build()

Initializes a SpringCloudCommandRouter as specified through this Builder.

Returns:

a SpringCloudCommandRouter as specified through this Builder

validate

protected void validate()

Validate whether the fields contained in this Builder as set accordingly.

Throws:

org.axonframework.common.AxonConfigurationException - if one field is asserted to be incorrect according to the Builder's specifications