org.axonframework.commandhandling.distributed

Class MetaDataRoutingStrategy

java.lang.Object

org.axonframework.commandhandling.distributed.AbstractRoutingStrategy

org.axonframework.commandhandling.distributed.MetaDataRoutingStrategy

All Implemented Interfaces:

RoutingStrategy

public class MetaDataRoutingStrategy
extends AbstractRoutingStrategy

RoutingStrategy implementation that uses the value in the MetaData of a CommandMessage assigned to a given key. The value's toString() is used to convert the MetaData value to a String.

Since:

2.0

Author:

Allard Buijze

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetaDataRoutingStrategy(MetaDataRoutingStrategy.Builder builder) Instantiate a MetaDataRoutingStrategy based on the fields contained in the give builder.
	MetaDataRoutingStrategy(String metaDataKey) Deprecated. in favor of the builder()
	MetaDataRoutingStrategy(String metaDataKey, UnresolvedRoutingKeyPolicy unresolvedRoutingKeyPolicy) Deprecated. in favor of the builder()

Method Summary

Modifier and Type	Method and Description
static MetaDataRoutingStrategy.Builder	builder() Instantiate a Builder to be able to create a MetaDataRoutingStrategy.
protected String	doResolveRoutingKey(CommandMessage<?> command) Resolve the Routing Key for the given command.

Methods inherited from class org.axonframework.commandhandling.distributed.AbstractRoutingStrategy

getRoutingKey

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaDataRoutingStrategy

protected MetaDataRoutingStrategy(MetaDataRoutingStrategy.Builder builder)

Instantiate a MetaDataRoutingStrategy based on the fields contained in the give builder.

Will assert that the metaDataKey is not an empty String or null and will throw an AxonConfigurationException if this is the case.

Parameters:

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

MetaDataRoutingStrategy

@Deprecated
public MetaDataRoutingStrategy(String metaDataKey)

Deprecated. in favor of the builder()

Initializes the MetaDataRoutingStrategy where the given metaDataKey is used to get the Meta Data value. An error is raised when the MetaData key cannot be found.

Parameters:

metaDataKey - the key on which the value is retrieved from the MetaData

MetaDataRoutingStrategy

@Deprecated
public MetaDataRoutingStrategy(String metaDataKey,
                                           UnresolvedRoutingKeyPolicy unresolvedRoutingKeyPolicy)

Deprecated. in favor of the builder()

Initializes the MetaDataRoutingStrategy where the given metaDataKey is used to get the Meta Data value. The given unresolvedRoutingKeyPolicy prescribes what to do when the Meta Data properties cannot be found.

Parameters:

metaDataKey - the key on which the value is retrieved from the MetaData

unresolvedRoutingKeyPolicy - the policy prescribing behavior when the routing key cannot be resolved

Method Detail

builder

public static MetaDataRoutingStrategy.Builder builder()

Instantiate a Builder to be able to create a MetaDataRoutingStrategy.

The fallbackRoutingStrategy to UnresolvedRoutingKeyPolicy.RANDOM_KEY. The metaDataKey is a hard requirements and as such should be provided.

Returns:

a Builder to be able to create a MetaDataRoutingStrategy

doResolveRoutingKey

protected String doResolveRoutingKey(@Nonnull
                                     CommandMessage<?> command)

Description copied from class: AbstractRoutingStrategy

Resolve the Routing Key for the given command.

Specified by:

doResolveRoutingKey in class AbstractRoutingStrategy

Parameters:

command - the command to resolve the routing key for

Returns:

the String representing the Routing Key, or null if unresolved