Package de.quantummaid.eventmaid.messageBus

Interface MessageBus

All Superinterfaces:

AutoCloseable, NoErrorAutoClosable

public interface MessageBus
extends NoErrorAutoClosable

Messages of different types can be sent over a MessageBus. Subscribers interested in specific messages can subscribe on these selected messages. A MessageBus allows adding Filters to alter the message flow.

See Also:

EventMaid Documentation

Method Summary

Modifier and Type	Method	Description
void	add(Filter<Object> filter)	Adds a Filter to the accepting Channel.
void	add(Filter<Object> filter, int position)	Adds the Filter to the accepting Channel
void	addRaw(Filter<ProcessingContext<Object>> filter)	Adds a Filter to the accepting Channel with access to the ProcessingContext.
void	addRaw(Filter<ProcessingContext<Object>> filter, int position)	Adds a Filter to the accepting Channel with access to the ProcessingContext at the given position.
boolean	awaitTermination(long timeout, TimeUnit unit)	Blocks the caller until all remaining tasks have completed execution after a close has been called, the timeout occurs or the current thread is interrupted.
void	close(boolean finishRemainingTasks)	Closes the MessageBus.
List<Filter<Object>>	getFilter()	Returns all currently added Filters.
MessageBusStatusInformation	getStatusInformation()	Removes the MessageBusStatusInformation interface, that allows querying statistics and Subscribers.
boolean	isClosed()	Returns true if close has been called on this MessageBus.
SubscriptionId	onException(CorrelationId correlationId, MessageBusExceptionListener exceptionListener)	Adds a dynamic MessageBusExceptionListener for the messages matching the CorrelationId.
SubscriptionId	onException(EventType eventType, MessageBusExceptionListener exceptionListener)	Adds a dynamic MessageBusExceptionListener for the messages with the EventType
void	remove(Filter<Object> filter)	Removes the given Filter.
MessageId	send(EventType eventType, Object object)	Sends the message with the given EventType.
MessageId	send(EventType eventType, Object object, CorrelationId correlationId)	Sends the message with the given EventType.
MessageId	send(ProcessingContext<Object> processingContext)	Sends the ProcessingContext on the MessageBus.
SubscriptionId	subscribe(CorrelationId correlationId, Subscriber<ProcessingContext<Object>> subscriber)	Adds the given Subscriber for all messages with a matching CorrelationId.
SubscriptionId	subscribe(CorrelationId correlationId, Consumer<ProcessingContext<Object>> consumer)	Adds the given Consumer wrapped in a Subscriber object for all messages with a matching CorrelationId.
SubscriptionId	subscribe(EventType eventType, Subscriber<Object> subscriber)	Adds the given Subscriber for all messages with a matching EventType.
SubscriptionId	subscribe(EventType eventType, Consumer<Object> consumer)	Adds the given Consumer wrapped in a Subscriber object for all messages with a matching EventType.
SubscriptionId	subscribeRaw(EventType eventType, Subscriber<ProcessingContext<Object>> subscriber)	Adds the Subscriber object for all messages with a matching EventType.
SubscriptionId	subscribeRaw(EventType eventType, Consumer<ProcessingContext<Object>> consumer)	Adds the given Consumer wrapped in a Subscriber object for all messages with a matching EventType.
void	unregisterExceptionListener(SubscriptionId subscriptionId)	Removes all exceptionListener with the given SubscriptionId.
void	unsubcribe(SubscriptionId subscriptionId)	Removes all Subscribers with the given SubscriptionId

Methods inherited from interface de.quantummaid.eventmaid.internal.autoclosable.NoErrorAutoClosable

close

Method Detail

send

MessageId send(EventType eventType,
               Object object)

Sends the message with the given EventType.

Parameters:

eventType - the EventType to identify the message

object - the message

Returns:

the MessageId of the send message

Throws:

AlreadyClosedException - if MessageBus already closed

send

MessageId send(EventType eventType,
               Object object,
               CorrelationId correlationId)

Sends the message with the given EventType.

Parameters:

eventType - the EventType to identify the message

object - the message

correlationId - the CorrelationId of the message

Returns:

the MessageId of the send message

Throws:

AlreadyClosedException - if MessageBus already closed

send

MessageId send(ProcessingContext<Object> processingContext)

Sends the ProcessingContext on the MessageBus.

Parameters:

processingContext - the ProcessingContext to send

Returns:

the MessageId of the send message

Throws:

AlreadyClosedException - if MessageBus already closed

subscribe

SubscriptionId subscribe(EventType eventType,
                         Consumer<Object> consumer)

Adds the given Consumer wrapped in a Subscriber object for all messages with a matching EventType.

Parameters:

eventType - the EventType of interest

consumer - the Subscriber to add

Returns:

the SubscriptionId of the Subscriber

subscribe

SubscriptionId subscribe(EventType eventType,
                         Subscriber<Object> subscriber)

Adds the given Subscriber for all messages with a matching EventType.

Parameters:

eventType - the EventType of interest

subscriber - the Subscriber to add

Returns:

the SubscriptionId of the Subscriber

subscribe

SubscriptionId subscribe(CorrelationId correlationId,
                         Consumer<ProcessingContext<Object>> consumer)

Adds the given Consumer wrapped in a Subscriber object for all messages with a matching CorrelationId.

Parameters:

correlationId - the CorrelationId of interest

consumer - the Subscriber to add

Returns:

the SubscriptionId of the Subscriber

subscribe

SubscriptionId subscribe(CorrelationId correlationId,
                         Subscriber<ProcessingContext<Object>> subscriber)

Adds the given Subscriber for all messages with a matching CorrelationId.

Parameters:

correlationId - the CorrelationId of interest

subscriber - the Subscriber to add

Returns:

the SubscriptionId of the Subscriber

subscribeRaw

SubscriptionId subscribeRaw(EventType eventType,
                            Consumer<ProcessingContext<Object>> consumer)

Adds the given Consumer wrapped in a Subscriber object for all messages with a matching EventType. The Subscriber gets access to the underlying ProcessingContext.

Parameters:

eventType - the EventType of interest

consumer - the Subscriber to add

Returns:

the SubscriptionId of the Subscriber

subscribeRaw

SubscriptionId subscribeRaw(EventType eventType,
                            Subscriber<ProcessingContext<Object>> subscriber)

Adds the Subscriber object for all messages with a matching EventType. The Subscriber gets access to the underlying ProcessingContext.

Parameters:

eventType - the EventType of interest

subscriber - the Subscriber to add

Returns:

the SubscriptionId of the Subscriber

unsubcribe

void unsubcribe(SubscriptionId subscriptionId)

Removes all Subscribers with the given SubscriptionId

Parameters:

subscriptionId - the SubscriptionId to remove Subscribers

add

void add(Filter<Object> filter)

Adds a Filter to the accepting Channel.

Parameters:

filter - the Filter to be added

add

void add(Filter<Object> filter,
         int position)

Adds the Filter to the accepting Channel

Parameters:

filter - the Filter to be added

position - the position of the Filter

Throws:

ArrayIndexOutOfBoundsException - if the position is higher than the number of Filter or negative

addRaw

void addRaw(Filter<ProcessingContext<Object>> filter)

Adds a Filter to the accepting Channel with access to the ProcessingContext.

Parameters:

filter - the Filter to be added

addRaw

void addRaw(Filter<ProcessingContext<Object>> filter,
            int position)

Adds a Filter to the accepting Channel with access to the ProcessingContext at the given position.

Parameters:

filter - the Filter to be added

position - the position of the Filter

getFilter

List<Filter<Object>> getFilter()

Returns all currently added Filters.

Returns:

all Filters

remove

void remove(Filter<Object> filter)

Removes the given Filter.

Parameters:

filter - the Filter to remove

onException

SubscriptionId onException(EventType eventType,
                           MessageBusExceptionListener exceptionListener)

Adds a dynamic MessageBusExceptionListener for the messages with the EventType

Parameters:

eventType - the EventType to match

exceptionListener - the MessageBusExceptionListener to add

Returns:

a SubscriptionId identifying exception listener

onException

SubscriptionId onException(CorrelationId correlationId,
                           MessageBusExceptionListener exceptionListener)

Adds a dynamic MessageBusExceptionListener for the messages matching the CorrelationId.

Parameters:

correlationId - the CorrelationId to match

exceptionListener - the MessageBusExceptionListener to add

Returns:

a SubscriptionId identifying exception listener

unregisterExceptionListener

void unregisterExceptionListener(SubscriptionId subscriptionId)

Removes all exceptionListener with the given SubscriptionId.

Parameters:

subscriptionId - the SubscriptionId to remove exception listener for

getStatusInformation

MessageBusStatusInformation getStatusInformation()

Removes the MessageBusStatusInformation interface, that allows querying statistics and Subscribers.

Returns:

the MessageBusStatusInformation interface

close

void close(boolean finishRemainingTasks)

Closes the MessageBus.

Parameters:

finishRemainingTasks - when true, the MessageBus tries to deliver queued messages, otherwise they are discarded

awaitTermination

boolean awaitTermination(long timeout,
                         TimeUnit unit)
                  throws InterruptedException

Blocks the caller until all remaining tasks have completed execution after a close has been called, the timeout occurs or the current thread is interrupted.

Parameters:

timeout - the duration to wait

unit - the time unit of the timeout

Returns:

true if this MessageBus terminated, false if the timeout elapsed before termination or false if close was not yet called

Throws:

InterruptedException - if interrupted while waiting

isClosed

boolean isClosed()

Returns true if close has been called on this MessageBus.

Returns:

true, if a close was already called, or false otherwise