de.willuhn.jameica.services
Class ReminderService

java.lang.Object
  java.util.TimerTask
      de.willuhn.jameica.services.ReminderService

All Implemented Interfaces:

de.willuhn.boot.Bootable, MessageConsumer, java.lang.Runnable

public class ReminderService
extends java.util.TimerTask
implements de.willuhn.boot.Bootable, MessageConsumer

Der Service stellt einen Reminder zur Verfuegung, mit dem sich andere Komponenten oder Plugins zu einem bestimmten Zeitpunkt ueber irgendwas erinnern lassen koennen. WICHTIG: Der Service arbeitet lediglich minutengenau. Der Dienst sollte also nicht verwendet werden, wenn eine Benachrichtigung sekundengenau erfolgen soll.

Constructor Summary

ReminderService()

Method Summary

void	add(Reminder reminder) Fuegt einen neuen Reminder hinzu.
boolean	autoRegister() Legt fest, ob der Messaging-Consumer automatisch registriert werden soll.
void	delete(Reminder reminder) Loescht einen Reminder.
java.lang.Class[]	depends()
java.lang.Class[]	getExpectedMessageTypes() Wenn der Message-Consumer nur ganz bestimmte Nachrichten empfangen will, dann kann er hier die Liste der gewuenschten Arten angeben.
Reminder[]	getReminders() Liefert eine Liste aller Reminder - sortiert nach Faelligkeit - aelteste zuerst.
void	handleMessage(Message message) Ueber diese Methode wird die Nachricht an den Verbraucher zugestellt.
void	init(de.willuhn.boot.BootLoader loader, de.willuhn.boot.Bootable caller)
void	run()
void	shutdown()

Methods inherited from class java.util.TimerTask

cancel, scheduledExecutionTime

Methods inherited from class java.lang.Object

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

Constructor Detail

ReminderService

public ReminderService()

Method Detail

delete

public void delete(Reminder reminder)

Loescht einen Reminder.

Parameters:

reminder -

add

public void add(Reminder reminder)

Fuegt einen neuen Reminder hinzu.

Parameters:

reminder -

getReminders

public Reminder[] getReminders()

Liefert eine Liste aller Reminder - sortiert nach Faelligkeit - aelteste zuerst.

Returns:

Liste der ueberfaelligen Reminder.

depends

public java.lang.Class[] depends()

Specified by:

depends in interface de.willuhn.boot.Bootable

See Also:

Bootable.depends()

init

public void init(de.willuhn.boot.BootLoader loader,
                 de.willuhn.boot.Bootable caller)
          throws de.willuhn.boot.SkipServiceException

Specified by:

init in interface de.willuhn.boot.Bootable

Throws:

de.willuhn.boot.SkipServiceException

See Also:

Bootable.init(de.willuhn.boot.BootLoader, de.willuhn.boot.Bootable)

shutdown

public void shutdown()

Specified by:

shutdown in interface de.willuhn.boot.Bootable

See Also:

Bootable.shutdown()

autoRegister

public boolean autoRegister()

Description copied from interface: MessageConsumer

Legt fest, ob der Messaging-Consumer automatisch registriert werden soll.

Specified by:

autoRegister in interface MessageConsumer

Returns:

true, wenn er automatisch registriert werden soll.

See Also:

MessageConsumer.autoRegister()

getExpectedMessageTypes

public java.lang.Class[] getExpectedMessageTypes()

Description copied from interface: MessageConsumer

Wenn der Message-Consumer nur ganz bestimmte Nachrichten empfangen will, dann kann er hier die Liste der gewuenschten Arten angeben. Liefert die Funktion null, werden alle Nachrichten an den Consumer zugestellt.

Specified by:

getExpectedMessageTypes in interface MessageConsumer

Returns:

Liste der gewuenschten Nachrichtenarten.

See Also:

MessageConsumer.getExpectedMessageTypes()

handleMessage

public void handleMessage(Message message)
                   throws java.lang.Exception

Description copied from interface: MessageConsumer

Ueber diese Methode wird die Nachricht an den Verbraucher zugestellt.

Specified by:

handleMessage in interface MessageConsumer

Parameters:

message - die eigentliche Nachricht.

Throws:

java.lang.Exception

See Also:

MessageConsumer.handleMessage(de.willuhn.jameica.messaging.Message)

run

public void run()

Specified by:

run in interface java.lang.Runnable

Specified by:

run in class java.util.TimerTask

See Also:

TimerTask.run()