org.axonframework.extensions.springcloud.commandhandling

Class SpringCloudHttpBackupCommandRouter.Builder

java.lang.Object

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

org.axonframework.extensions.springcloud.commandhandling.SpringCloudHttpBackupCommandRouter.Builder

Enclosing class:

SpringCloudHttpBackupCommandRouter

public static class SpringCloudHttpBackupCommandRouter.Builder
extends SpringCloudCommandRouter.Builder

Builder class to instantiate a SpringCloudHttpBackupCommandRouter.

The serviceInstanceFilter is defaulted to a Predicate which always returns true, the ConsistentHashChangeListener to a no-op solution and the messageRoutingInformationEndpoint to "/message-routing-information". The DiscoveryClient, localServiceInstance of type Registration, the RoutingStrategy, RestTemplate and messageRoutingInformationEndpoint are hard requirements and as such should be provided.

Field Summary

Fields inherited from class org.axonframework.extensions.springcloud.commandhandling.SpringCloudCommandRouter.Builder

serializerSupplier

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SpringCloudHttpBackupCommandRouter	build() Initializes a SpringCloudHttpBackupCommandRouter as specified through this Builder.
SpringCloudHttpBackupCommandRouter.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.
SpringCloudHttpBackupCommandRouter.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.
SpringCloudHttpBackupCommandRouter.Builder	discoveryClient(org.springframework.cloud.client.discovery.DiscoveryClient discoveryClient) Sets the DiscoveryClient used to discovery and notify other nodes.
SpringCloudHttpBackupCommandRouter.Builder	enforceHttpDiscovery() Deprecated. in favor of using the SpringCloudCommandRouter in combination with the RestCapabilityDiscoveryMode
SpringCloudHttpBackupCommandRouter.Builder	localServiceInstance(org.springframework.cloud.client.serviceregistry.Registration localServiceInstance) Sets the Registration, representing the local Service Instance of this application.
SpringCloudHttpBackupCommandRouter.Builder	messageRoutingInformationEndpoint(String messageRoutingInformationEndpoint) Sets the messageRoutingInformationEndpoint of type String, which is the endpoint where to retrieve the another nodes message routing information from.
SpringCloudHttpBackupCommandRouter.Builder	restTemplate(org.springframework.web.client.RestTemplate restTemplate) Sets the RestTemplate used as the backup mechanism to request another member's MessageRoutingInformation with.
SpringCloudHttpBackupCommandRouter.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.
SpringCloudHttpBackupCommandRouter.Builder	serializer(org.axonframework.serialization.Serializer serializer) Sets the Serializer used to de-/serialize the CommandMessageFilter.
SpringCloudHttpBackupCommandRouter.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 org.axonframework.extensions.springcloud.commandhandling.SpringCloudCommandRouter.Builder

capabilityDiscoveryMode

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

discoveryClient

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

Description copied from class: SpringCloudCommandRouter.Builder

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.

Overrides:

discoveryClient in class SpringCloudCommandRouter.Builder

Parameters:

discoveryClient - the DiscoveryClient used to discovery and notify other nodes

Returns:

the current Builder instance, for fluent interfacing

localServiceInstance

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

Description copied from class: SpringCloudCommandRouter.Builder

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.

Overrides:

localServiceInstance in class SpringCloudCommandRouter.Builder

Parameters:

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

Returns:

the current Builder instance, for fluent interfacing

routingStrategy

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

Description copied from class: SpringCloudCommandRouter.Builder

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

Overrides:

routingStrategy in class SpringCloudCommandRouter.Builder

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

serviceInstanceFilter

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

Description copied from class: SpringCloudCommandRouter.Builder

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

Overrides:

serviceInstanceFilter in class SpringCloudCommandRouter.Builder

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 SpringCloudHttpBackupCommandRouter.Builder consistentHashChangeListener(org.axonframework.commandhandling.distributed.ConsistentHashChangeListener consistentHashChangeListener)

Description copied from class: SpringCloudCommandRouter.Builder

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.

Overrides:

consistentHashChangeListener in class SpringCloudCommandRouter.Builder

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 SpringCloudHttpBackupCommandRouter.Builder contextRootMetadataPropertyName(String contextRootMetadataPropertyName)

Description copied from class: SpringCloudCommandRouter.Builder

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.

Overrides:

contextRootMetadataPropertyName in class SpringCloudCommandRouter.Builder

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

serializer

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

Description copied from class: SpringCloudCommandRouter.Builder

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.

Overrides:

serializer in class SpringCloudCommandRouter.Builder

Parameters:

serializer - a Serializer used to de-/serialize CommandMessageFilter

Returns:

the current Builder instance, for fluent interfacing

restTemplate

public SpringCloudHttpBackupCommandRouter.Builder restTemplate(org.springframework.web.client.RestTemplate restTemplate)

Sets the RestTemplate used as the backup mechanism to request another member's MessageRoutingInformation with.

Parameters:

restTemplate - the RestTemplate used as the backup mechanism to request another member's MessageRoutingInformation with.

Returns:

the current Builder instance, for fluent interfacing

messageRoutingInformationEndpoint

public SpringCloudHttpBackupCommandRouter.Builder messageRoutingInformationEndpoint(String messageRoutingInformationEndpoint)

Sets the messageRoutingInformationEndpoint of type String, which is the endpoint where to retrieve the another nodes message routing information from. Defaults to endpoint "/message-routing-information".

Parameters:

messageRoutingInformationEndpoint - the endpoint where to retrieve the another nodes message routing information from

Returns:

the current Builder instance, for fluent interfacing

enforceHttpDiscovery

@Deprecated
public SpringCloudHttpBackupCommandRouter.Builder enforceHttpDiscovery()

Deprecated. in favor of using the SpringCloudCommandRouter in combination with the RestCapabilityDiscoveryMode

Enforces the back up solution provided by this SpringCloudCommandRouter to be used for retrieving MessageRoutingInformation. This should be toggled on if the utilized Spring Cloud Discovery mechanism has an inconsistent metadata update policy on the ServiceInstance, which can lead to inconsistent MessageRoutingInformation being shared.

Returns:

the current Builder instance, for fluent interfacing

build

public SpringCloudHttpBackupCommandRouter build()

Initializes a SpringCloudHttpBackupCommandRouter as specified through this Builder.

Overrides:

build in class SpringCloudCommandRouter.Builder

Returns:

a SpringCloudHttpBackupCommandRouter as specified through this Builder

validate

protected void validate()

Description copied from class: SpringCloudCommandRouter.Builder

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

Overrides:

validate in class SpringCloudCommandRouter.Builder