org.ginsim.core.notification

Class NotificationManager

java.lang.Object

org.ginsim.core.notification.NotificationManager

public class NotificationManager
extends Object

This class is the central class of the register/publish design pattern applied to Notifications This manager receive registration from object that have to receive Notification on specific topics It receive also all the Notification and distribute them to listening objects according to the Notification Topic

Author:

Lionel Spinelli

Constructor Summary

Constructors

Constructor and Description
NotificationManager() Default constructor

Method Summary

Modifier and Type	Method and Description
static NotificationManager	getManager() Give access to the manager instance
void	publishDeletion(Notification message) Publish a notification so NotificationListerner that were registered and have subscribe to the type of the given notification will remove it from their notification list (deletion is due to notification timeout)
static void	publishDetailedError(Object topic, String message, String details) Publish an error message with details
static void	publishDetailedInformation(Object topic, String message, String details) Publish an information message with details
static void	publishDetailedWarning(Object topic, String message, String details) Publish an warning message with details
static void	publishError(Object topic, String message) Publish an error message
static void	publishException(Object topic, String message, Exception exception) Publish a Java exception
static void	publishInformation(Object topic, String message) Publish an information message
static void	publishResolvableError(Object topic, String message, Graph graph, Object[] data, NotificationResolution resolution) Publish an error message with its resolution options
static void	publishResolvableWarning(Object topic, String message, Graph graph, Object[] data, NotificationResolution resolution) Publish a warning message with its resolution options
static void	publishWarning(Object topic, String message) Publish a warning message
void	registerListener(NotificationListener listener, Object topic) Register a listener and subscribe it to the given topic

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationManager

public NotificationManager()

Default constructor

Method Detail

getManager

public static NotificationManager getManager()

Give access to the manager instance

Returns:

the manager instance

registerListener

public void registerListener(NotificationListener listener,
                             Object topic)

Register a listener and subscribe it to the given topic

Parameters:

listener - the NotificationListerner to register

topic - the topic the listener subscribe to

publishError

public static void publishError(Object topic,
                                String message)

Publish an error message

Parameters:

topic - the topic of the notification

message - the message of the notification

publishDetailedError

public static void publishDetailedError(Object topic,
                                        String message,
                                        String details)

Publish an error message with details

Parameters:

topic - the topic of the notification

message - the message of the notification

details - the details associated to the notification

publishException

public static void publishException(Object topic,
                                    String message,
                                    Exception exception)

Publish a Java exception

Parameters:

topic - the topic of the notification

message - the message of the notification

exception - the Exception to publish

publishWarning

public static void publishWarning(Object topic,
                                  String message)

Publish a warning message

Parameters:

topic - the topic of the notification

message - the message of the notification

publishDetailedWarning

public static void publishDetailedWarning(Object topic,
                                          String message,
                                          String details)

Publish an warning message with details

Parameters:

topic - the topic of the notification

message - the message of the notification

details - the details associated to the notification

publishInformation

public static void publishInformation(Object topic,
                                      String message)

Publish an information message

Parameters:

topic - the topic of the notification

message - the message of the notification

publishDetailedInformation

public static void publishDetailedInformation(Object topic,
                                              String message,
                                              String details)

Publish an information message with details

Parameters:

topic - the topic of the notification

message - the message of the notification

details - the details associated to the notification

publishResolvableError

public static void publishResolvableError(Object topic,
                                          String message,
                                          Graph graph,
                                          Object[] data,
                                          NotificationResolution resolution)

Publish an error message with its resolution options

Parameters:

topic - the topic of the notification

message - the message of the notification

graph - the graph concerned by the notification

data - the data required for the

resolution - the NotificationResolution containing the resolution options

publishResolvableWarning

public static void publishResolvableWarning(Object topic,
                                            String message,
                                            Graph graph,
                                            Object[] data,
                                            NotificationResolution resolution)

Publish a warning message with its resolution options

Parameters:

topic - the topic of the notification

message - the message of the notification

graph - the graph concerned by the notification

data - the data required for the

resolution - the NotificationResolution containing the resolution options

publishDeletion

public void publishDeletion(Notification message)

Publish a notification so NotificationListerner that were registered and have subscribe to the type of the given notification will remove it from their notification list (deletion is due to notification timeout)

Parameters:

message - the Notification to remove