org.axonframework.commandhandling.model

Interface ForwardingMode<T extends Message<?>>

All Known Implementing Classes:

ForwardMatchingInstances, ForwardNone, ForwardToAll

public interface ForwardingMode<T extends Message<?>>

Interface describing the required functionality to forward a message. An example implementation is the ForwardToAll, which forwards all incoming messages.

Method Summary

Modifier and Type	Method and Description
<E> Stream<E>	filterCandidates(T message, Stream<E> candidates) Filter the given Stream of candidates which are to handle the supplied message.
default void	initialize(Field field, EntityModel childEntity) Initializes an instance of a ForwardingMode.

Method Detail

initialize

default void initialize(Field field,
                        EntityModel childEntity)

Initializes an instance of a ForwardingMode.

Parameters:

field - The Field to apply a ForwardingMode on. Provided to be able to check for annotations attributes which might assist in the forwarding process.

childEntity - A EntityModel constructed from the given field.

filterCandidates

<E> Stream<E> filterCandidates(T message,
                               Stream<E> candidates)

Filter the given Stream of candidates which are to handle the supplied message.

Type Parameters:

E - The type of the candidates

Parameters:

message - The message of type T to be forwarded.

candidates - The Stream of candidates to filter.

Returns:

a filtered Stream of candidates which will handle the message.