no.g9.message

Interface MessageDispatcher

All Known Subinterfaces:

MessageDispatcherSetup

All Known Implementing Classes:

MessageDispatcherImpl

public interface MessageDispatcher

This interface lets the client dispatch messages to the message system. Usage from inside the controller: getMessageDispatcher().dispatch("some.message.id", "Message parameter 1", "Message parameter 2");

Method Summary

Modifier and Type	Method and Description
MessageReply	dispatch(Message message) Dispatches a message to the message system.
MessageReply	dispatch(String id, Object... args) Creates a message and dispatces it to the message system.
MessageReply	dispatch(String id, Throwable exception, Object... args) Creates a message and dispatces it to the message system.

Method Detail

dispatch

MessageReply dispatch(String id,
                      Object... args)

Creates a message and dispatces it to the message system.

Parameters:

id - The message identifier

args - The arguments needed to create the message text.

Returns:

The message reply. If the MessageInteractor does not interact with this message this value might be null.

dispatch

MessageReply dispatch(Message message)

Dispatches a message to the message system.

Parameters:

message - The message to dispatch

Returns:

The message reply. If the MessageInteractor does not interact with this message this value might be null.

dispatch

MessageReply dispatch(String id,
                      Throwable exception,
                      Object... args)

Creates a message and dispatces it to the message system.

Parameters:

id - The message identifier

exception - The exception associated with this message.

args - The arguments needed to create the message text.

Returns:

The message reply. If the MessageInteractor does not interact with this message this value might be null.