org.daisy.common.messaging

Interface MessageAppender

All Known Implementing Classes:

MessageBus

public interface MessageAppender

An object that can modify an underlying message by appending child messages to it or by closing it.

Method Summary

Modifier and Type	Method and Description
MessageAppender	append(MessageBuilder message) Append a child to the underlying message.
default org.slf4j.Logger	asLogger() Logger that appends messages to the underlying message.
void	close() Close the underlying message.
static MessageAppender	getActiveBlock() Returns the "active" block in the current "message thread".
static MessageAppender	getActiveBlock(String threadId) Returns the active block in the specified message thread.
static org.slf4j.Logger	getActiveBlockLogger() Logger that appends messages to the active block at the time of the log calls.

Method Detail

append

MessageAppender append(MessageBuilder message)

Append a child to the underlying message.

Returns:

the appended message

close

void close()

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

asLogger

default org.slf4j.Logger asLogger()

Logger that appends messages to the underlying message.

getActiveBlock

static MessageAppender getActiveBlock()

Returns the "active" block in the current "message thread". A message thread is a collection of messages that belong to the same owner ("job") and thread. The active block is the portion of the process currently in progress. Whenever a new MessageImpl is created it becomes the new active block of that thread, until it is closed, and if its parent belongs to the same thread it then becomes the active block. This method assumes that different jobs are run in different threads.

getActiveBlock

static MessageAppender getActiveBlock(String threadId)

Returns the active block in the specified message thread. This method is intended to be used by the JobProgressAppender class which receives log messages with "message-thread" info attached to them through the MDC mechanism.

getActiveBlockLogger

static org.slf4j.Logger getActiveBlockLogger()

Logger that appends messages to the active block at the time of the log calls.