io.spine.server.bus

Class DispatcherRegistry<C extends io.spine.type.MessageClass<? extends com.google.protobuf.Message>,E extends MessageEnvelope<?,?,?>,D extends MessageDispatcher<C,E>>

java.lang.Object

io.spine.server.bus.DispatcherRegistry<C,E,D>

Type Parameters:

C - the type of the class of dispatched messages

D - the type of the message dispatchers

public abstract class DispatcherRegistry<C extends io.spine.type.MessageClass<? extends com.google.protobuf.Message>,E extends MessageEnvelope<?,?,?>,D extends MessageDispatcher<C,E>>
extends java.lang.Object

A registry of message dispatchers.

Constructor Summary

Constructors

Constructor and Description
DispatcherRegistry()

Method Summary

Modifier and Type	Method and Description
protected java.util.function.BiPredicate<E,D>	attributeFilter() Returns a filter allowing to tell whether the attributes of the envelope match the dispatcher requirements.
protected void	checkDispatcher(D dispatcher) Ensures that the passed dispatcher is valid.
protected java.util.Optional<D>	dispatcherOf(E envelope) Obtains a single dispatcher (if available) for the passed message.
protected java.util.Set<D>	dispatchersOf(C messageClass) Obtains all the dispatchers for the passed message class.
protected java.util.Optional<? extends D>	getDispatcherForType(C messageClass) Obtains a single dispatcher (if available) for the passed message.
void	register(D dispatcher)
protected java.util.Set<C>	registeredMessageClasses() Obtains message classes from all registered dispatchers.
void	unregister(D dispatcher)
protected void	unregisterAll() Unregisters all dispatchers.

Methods inherited from class java.lang.Object

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

Constructor Detail

DispatcherRegistry

public DispatcherRegistry()

Method Detail

register

public void register(D dispatcher)

unregister

public void unregister(D dispatcher)

unregisterAll

protected void unregisterAll()

Unregisters all dispatchers.

registeredMessageClasses

protected java.util.Set<C> registeredMessageClasses()

Obtains message classes from all registered dispatchers.

attributeFilter

protected java.util.function.BiPredicate<E,D> attributeFilter()

Returns a filter allowing to tell whether the attributes of the envelope match the dispatcher requirements.

dispatcherOf

protected java.util.Optional<D> dispatcherOf(E envelope)

Obtains a single dispatcher (if available) for the passed message.

Parameters:

envelope - the message to find a dispatcher for

Throws:

java.lang.IllegalStateException - if more than one dispatcher is found

API Note:

This method must be called only for serving UnicastBuses.

dispatchersOf

protected java.util.Set<D> dispatchersOf(C messageClass)

Obtains all the dispatchers for the passed message class.

Parameters:

messageClass - the target message class

Returns:

all the registered dispatchers of the given class

getDispatcherForType

protected java.util.Optional<? extends D> getDispatcherForType(C messageClass)

Obtains a single dispatcher (if available) for the passed message.

Parameters:

messageClass - the class of the message to find a dispatcher for

Throws:

java.lang.IllegalStateException - if more than one dispatcher is found

checkDispatcher

protected void checkDispatcher(D dispatcher)
                        throws java.lang.IllegalArgumentException

Ensures that the passed dispatcher is valid.

The passed dispatcher must expose at least one message class.

Parameters:

dispatcher - the dispatcher to check

Throws:

java.lang.IllegalArgumentException - if the check is failed