org.daisy.common.messaging

Class MessageBus

java.lang.Object

org.daisy.common.messaging.MessageAccessor

org.daisy.common.messaging.AbstractMessageAccessor

org.daisy.common.messaging.MessageBus

All Implemented Interfaces:

MessageAppender

public class MessageBus
extends AbstractMessageAccessor
implements MessageAppender

Collection of messages that belong together, for example to a Pipeline job.

Nested Class Summary

Nested classes/interfaces inherited from class org.daisy.common.messaging.MessageAccessor

MessageAccessor.MessageFilter

Constructor Summary

Constructors

Constructor and Description
MessageBus(String ownerId, Message.Level threshold)

Method Summary

Modifier and Type	Method and Description
protected Iterable<Message>	allMessages() Must return a (mutable) iterable that contains all messages (which are mutable) received up till now.
MessageAppender	append(MessageBuilder message) Append a child to the underlying message.
void	close() Close the underlying message.
void	listen(Consumer<Integer> callback) Register a callback that is called whenever a new (top-level) message arrives, a message is updated with descendant messages, or the progress of a message changes.
void	unlisten(Consumer<Integer> callback)

Methods inherited from class org.daisy.common.messaging.AbstractMessageAccessor

createFilter, getAll, getProgress

Methods inherited from class org.daisy.common.messaging.MessageAccessor

getDebugs, getErrors, getInfos, getTraces, getWarnings

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.daisy.common.messaging.MessageAppender

asLogger, getActiveBlock, getActiveBlock, getActiveBlockLogger

Constructor Detail

MessageBus

public MessageBus(String ownerId,
                  Message.Level threshold)

Parameters:

ownerId - A string that uniquely identifies this collection of messages. Could for instance be the ID of a Pipeline job.

Method Detail

append

public MessageAppender append(MessageBuilder message)

Description copied from interface: MessageAppender

Append a child to the underlying message.

Specified by:

append in interface MessageAppender

Returns:

the appended message

close

public void close()

Description copied from interface: MessageAppender

Close the underlying message. If a message is closed, the progress becomes 1 and no child message can be appended.

Specified by:

close in interface MessageAppender

allMessages

protected Iterable<Message> allMessages()

Description copied from class: AbstractMessageAccessor

Must return a (mutable) iterable that contains all messages (which are mutable) received up till now. Mutating operations on the iterable must be synchronized on the object itself.

Specified by:

allMessages in class AbstractMessageAccessor

listen

public void listen(Consumer<Integer> callback)

Description copied from class: MessageAccessor

Register a callback that is called whenever a new (top-level) message arrives, a message is updated with descendant messages, or the progress of a message changes. The argument must be a function that accepts a sequence number representing the event. This sequence number can then be used to get the list of all messages affected by the change, via createFilter().inRange(...).getMessages(). A sequence number is never null and never lower than the sequence numbers previously received, but the same sequence number may occur more than once.

Specified by:

listen in class MessageAccessor

unlisten

public void unlisten(Consumer<Integer> callback)

Specified by:

unlisten in class MessageAccessor