org.axonframework.extensions.springcloud.commandhandling.mode

Class RestCapabilityDiscoveryMode

java.lang.Object

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

org.axonframework.extensions.springcloud.commandhandling.mode.RestCapabilityDiscoveryMode

All Implemented Interfaces:

CapabilityDiscoveryMode

public class RestCapabilityDiscoveryMode
extends AbstractCapabilityDiscoveryMode<RestCapabilityDiscoveryMode>

Implementation of the CapabilityDiscoveryMode which uses a RestTemplate to discover the MemberCapabilities of other ServiceInstances.

Note that when this REST CapabilityDiscoveryMode is selected, a member's capabilities should also be retrievable. To that end a MemberCapabilitiesController is required to be present.

Since:

4.4

Author:

Steven van Beelen

Nested Class Summary

Nested Classes

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

Field Summary

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

localCapabilities, localInstance

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static RestCapabilityDiscoveryMode.Builder	builder() Instantiate a RestCapabilityDiscoveryMode.Builder to be able to create a RestCapabilityDiscoveryMode.
Optional<MemberCapabilities>	capabilities(org.springframework.cloud.client.ServiceInstance serviceInstance) Discovers the capabilities of the given serviceInstance, returning an Optional MemberCapabilities.
SerializedMemberCapabilities	getLocalMemberCapabilities() Get the local membership information as a SerializedMemberCapabilities, thus the MemberCapabilities of the node this CapabilityDiscoveryMode is a part of.

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

updateLocalCapabilities

Methods inherited from class java.lang.Object

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

Constructor Detail

RestCapabilityDiscoveryMode

protected RestCapabilityDiscoveryMode(RestCapabilityDiscoveryMode.Builder builder)

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

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

Parameters:

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

Method Detail

builder

public static RestCapabilityDiscoveryMode.Builder builder()

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

The Serializer is defaulted to a XStreamSerializer instance and the messageCapabilitiesEndpoint to "/message-routing-information". The RestTemplate is a hard requirement and as such should be provided.

Returns:

a RestCapabilityDiscoveryMode.Builder to be able to create a RestCapabilityDiscoveryMode

capabilities

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

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

getLocalMemberCapabilities

public SerializedMemberCapabilities getLocalMemberCapabilities()

Get the local membership information as a SerializedMemberCapabilities, thus the MemberCapabilities of the node this CapabilityDiscoveryMode is a part of. The local membership information is set and updated through the AbstractCapabilityDiscoveryMode.updateLocalCapabilities(ServiceInstance, int, CommandMessageFilter) method.

Returns:

the SerializedMemberCapabilities of the node this CapabilityDiscoveryMode implementation is part of