it.jnrpe.events
Class EventsUtil

java.lang.Object
  it.jnrpe.events.EventsUtil

public final class EventsUtil
extends Object

This is an utility class than can be used to send simply events to all the registered listeners.

Author:

Massimiliano Ziccardi

Method Summary

static void	sendEvent(Collection<IJNRPEEventListener> listenersList, Object sender, LogEvent evt, String message) This method sends log events to the registered listeners.
static void	sendEvent(Collection<IJNRPEEventListener> listenerList, Object sender, LogEvent evt, String message, Throwable exception) This method sends log events to the registered listeners.
static void	sendEvent(Collection<IJNRPEEventListener> listenerList, Object sender, String customEvtType, EventParam... paramsList) This method is used to send custom events to the registered listeners.
static void	sendEvent(JNRPEExecutionContext context, Object sender, LogEvent evt, String message)
static void	sendEvent(JNRPEExecutionContext context, Object sender, LogEvent evt, String message, Throwable exception)

Methods inherited from class java.lang.Object

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

Method Detail

sendEvent

public static void sendEvent(Collection<IJNRPEEventListener> listenersList,
                             Object sender,
                             LogEvent evt,
                             String message)

This method sends log events to the registered listeners. It is an. utility method that relieve the programmer from the need to create all. the EventParam object just to send log events. Supported event type are. TRACE, DEBUG, INFO, WARNING, ERROR, FATAL.

Parameters:

listenersList - The list of all the listeners that will receive the event

sender - The sender of the event (usually this)

evt - The event type

message - The log message

sendEvent

public static void sendEvent(JNRPEExecutionContext context,
                             Object sender,
                             LogEvent evt,
                             String message)

sendEvent

public static void sendEvent(JNRPEExecutionContext context,
                             Object sender,
                             LogEvent evt,
                             String message,
                             Throwable exception)

sendEvent

public static void sendEvent(Collection<IJNRPEEventListener> listenerList,
                             Object sender,
                             LogEvent evt,
                             String message,
                             Throwable exception)

This method sends log events to the registered listeners. It is an. utility method that relieve the programmer from the need to create all. the EventParam object just to send log events. Supported event type are. TRACE, DEBUG, INFO, WARNING, ERROR, FATAL.

Parameters:

listenerList - The list of all the listeners that will receive the event

sender - The sender of the event (usually this)

evt - The event type

message - The log message

exception - The exception to be, eventually, logged (can be null).

sendEvent

public static void sendEvent(Collection<IJNRPEEventListener> listenerList,
                             Object sender,
                             String customEvtType,
                             EventParam... paramsList)

This method is used to send custom events to the registered listeners. The event type can be a freely chosen string. A custom listener should be instructed to handle such event with its parameters.

Parameters:

listenerList - The list of all the listeners that will receive the event

sender - The sender of the event (usually this)

customEvtType - The custom event type

paramsList - The event parameters