org.figure8.join.services.notification
Interface SubscribersNotifier

All Superinterfaces:

Configurable, Notifier

All Known Implementing Classes:

GoogleTalkNotifier, MailNotifier, XMPPNotifier

public interface SubscribersNotifier
extends Notifier

This is an extension of Notifier interface. Implementations should define how to extract notifier recipients from the RemoteSubscriber objects.
The method extractRecipients(RemoteSubscriber[]) would be typically used before calling notify(). Implementations may also provide the helper notify() method using RemoteSubscribers as argument.

Version:

$Revision: 1.1 $

Author:

Laurent Broudoux

Method Summary

java.lang.String[]	extractRecipients(RemoteSubscriber[] subscribers) Defines how to extract Notifier recipients from RemoteSubscriber objects
void	notify(RemoteSubscriber[] subscribers, java.lang.String title, java.lang.String content) Notify subscribers of mailing list defined into Join application

Methods inherited from interface org.figure8.join.services.notification.Notifier

notify

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

getParameterDefinitions, getParameterDefinitionsAsList, setParameter, setParameter, setParameters

Method Detail

extractRecipients

java.lang.String[] extractRecipients(RemoteSubscriber[] subscribers)

Defines how to extract Notifier recipients from RemoteSubscriber objects

Parameters:

subscribers - The subscribers to get recipients for

Returns:

The list of corresponding recipients.

notify

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

Notify subscribers of mailing list defined into Join application

Parameters:

subscribers - The subscriber of mailing list to notify

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)