com.enterprisemath.utils.messaging

Interface SystemMessenger

All Known Implementing Classes:

ProxySystemMessenger

public interface SystemMessenger

Defines functionality for system message. This is designed for sending messages to the administrator. Supports are standard message and various methods for sending errors.

Note: Adding functions to this interface will NOT be considered as breaking binary compatibility.

Author:

radek.hecl

Method Summary

Modifier and Type	Method and Description
void	send(Message message) Sends message.
void	sendError(String caption, String explanation) Sends error message without exception.
void	sendError(String caption, String explanation, Map<String,String> exceptionDetails) Sends error message with exception.
void	sendError(String caption, String explanation, Throwable e) Sends error message with exception.

Method Detail

send

void send(Message message)

Sends message.

Parameters:

message - message to send

sendError

void sendError(String caption,
               String explanation)

Sends error message without exception.

Parameters:

caption - caption of the error

explanation - message with error explanation

sendError

void sendError(String caption,
               String explanation,
               Throwable e)

Sends error message with exception.

Parameters:

caption - caption of the error

explanation - message with error explanation

e - error

sendError

void sendError(String caption,
               String explanation,
               Map<String,String> exceptionDetails)

Sends error message with exception.

Parameters:

caption - caption of the error

explanation - message with error explanation

exceptionDetails - details about exception serialized to the map