org.figure8.join.services.notification
Interface Notifier

All Superinterfaces:

Configurable

All Known Subinterfaces:

SubscribersNotifier

All Known Implementing Classes:

GoogleTalkNotifier, MailNotifier, XMPPNotifier

public interface Notifier
extends Configurable

This service interface defines basic services that a Notifier should provide

Version:

$Revision: 1.1 $

Author:

Laurent Broudoux

Method Summary

void	notify(java.lang.String[] recipients, java.lang.String title, java.lang.String content) Notifier are able to notify recipients and use a title and a content within their notification messages.

Methods inherited from interface org.figure8.join.core.Configurable

getParameterDefinitions, getParameterDefinitionsAsList, setParameter, setParameter, setParameters

Method Detail

notify

void notify(java.lang.String[] recipients,
            java.lang.String title,
            java.lang.String content)
            throws NotificationException

Notifier are able to notify recipients and use a title and a content within their notification messages. The definition of a recipients is voluntary abstract letting implementations or sub-interfaces defining what they consider as valid recipients (ex: mail addresses, IM identifies, etc...)

Parameters:

recipients - An array of recipients to noitify. Recipient is described with a String

title - The title of notification message to send

content - The content of notification message to send

Throws:

NotificationException - if an exception occurs during the notification operation (usually they are network related exceptions)