eu.scape_project.watch.interfaces
Interface NotificationAdaptorInterface

All Superinterfaces:

PluginInterface

All Known Implementing Classes:

LogNotificationAdaptor

public interface NotificationAdaptorInterface
extends PluginInterface

Definition of Notification adaptor methods.

Author:

Luis Faria

Method Summary

Map<String,DataType>	getParametersInfo() Get list of parameters and their type.
Set<String>	getSupportedTypes() Get Notification types this adaptors supports.
boolean	send(Notification notification) Send a notification.

Methods inherited from interface eu.scape_project.watch.interfaces.PluginInterface

getDescription, getName, getPluginType, getVersion, init, shutdown

Method Detail

getSupportedTypes

Set<String> getSupportedTypes()

Get Notification types this adaptors supports.

Returns:

A set of types.

getParametersInfo

Map<String,DataType> getParametersInfo()

Get list of parameters and their type. TODO add parameter description, mandatory/optional flag, readable/password flag, etc.

Returns:

A map with possible parameter names as key and the data type as value.

send

boolean send(Notification notification)

Send a notification.

Parameters:

notification - The notification to send

Returns:

true if notification should be consumed, i.e. should not be relayed to any other adaptor