de.willuhn.jameica.plugin
Class AbstractPlugin

java.lang.Object
  de.willuhn.jameica.plugin.AbstractPlugin

public abstract class AbstractPlugin
extends java.lang.Object

Abstrakte Basis-Klasse aller Plugins. Jedes Plugin muss diese Klasse erweitern, damit es beim Start von Jameica erkannt wird.

Author:

willuhn

Constructor Summary

AbstractPlugin()

Method Summary

Manifest	getManifest() Liefert das Manifest des Plugins.
PluginResources	getResources() Liefert ein Objekt mit Resourcen, auf die das Plugin zugreifen kann.
void	init() Diese Funktion wird beim Start der Anwendung ausgefuehrt.
void	install() Diese Funktion wird beim Start der Anwendung aufgerufen, wenn das Plugin zum ersten mal gestartet wird.
void	shutDown() Diese Funktion wird beim Beenden der Anwendung ausgefuehrt.
void	update(double oldVersion) Deprecated. Bitte kuenftig update(Version) implementieren
void	update(Version oldVersion) Diese Funktion wird beim Start der Anwendung genau dann aufgerufen, wenn das Plugin bereits erfolgreich installiert wurde, jedoch jetzt in einer anderen Version vorliegt als die vorherige.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPlugin

public AbstractPlugin()

Method Detail

getResources

public final PluginResources getResources()

Liefert ein Objekt mit Resourcen, auf die das Plugin zugreifen kann.

Returns:

Resource-Pack.

getManifest

public final Manifest getManifest()

Liefert das Manifest des Plugins.

Returns:

Manifest.

init

public void init()
          throws de.willuhn.util.ApplicationException

Diese Funktion wird beim Start der Anwendung ausgefuehrt. Hier kann die Plugin- Implementierung also diverse Dinge durchfuehren, die es beim Start gern automatisch durchgefuehrt haben moechte. Nur wenn die Funktion fehlerfrei durchlaeuft, wird das Plugin aktiviert. Andernfalls wird der Text der geworfenen Exception dem Benutzer auf der Start-Seite von Jameica angezeigt. Von daher empfiehlt es sich, verstaendliche Formulierungen fuer ggf aufgetretene Fehler zu verwenden. Hinweis: Diese Funktion wird von Jameica vor dem Initialisieren der Services aufgerufen.

Throws:

de.willuhn.util.ApplicationException - muss geworfen werden, wenn das Plugin nicht aktiviert werden soll.

install

public void install()
             throws de.willuhn.util.ApplicationException

Diese Funktion wird beim Start der Anwendung aufgerufen, wenn das Plugin zum ersten mal gestartet wird. Die install() Funktion wird solange bei jedem Start aufgerufen, bis sie fehlerfrei durchlaeuft. Andernfalls wird der Text der geworfenen Exception dem Benutzer auf der Start-Seite von Jameica angezeigt. Von daher empfiehlt es sich, verstaendliche Formulierungen fuer ggf aufgetretene Fehler zu verwenden. Hinweis: Diese Funktion wird von Jameica vor dem Initialisieren der Services aufgerufen.

Throws:

de.willuhn.util.ApplicationException - muss geworfen werden, wenn die Installation fehlschlug und das Plugin nicht aktiviert werden soll.

update

public void update(double oldVersion)
            throws de.willuhn.util.ApplicationException

Deprecated. Bitte kuenftig update(Version) implementieren

Diese Funktion wird beim Start der Anwendung genau dann aufgerufen, wenn das Plugin bereits erfolgreich installiert wurde, jedoch jetzt in einer anderen Version vorliegt als die vorherige. Sie wird solange bei jedem Start aufgerufen, bis sie fehlerfrei durchlaeuft. Andernfalls wird der Text der geworfenen Exception dem Benutzer auf der Start-Seite von Jameica angezeigt. Von daher empfiehlt es sich, verstaendliche Formulierungen fuer ggf aufgetretene Fehler zu verwenden. Hinweis: Diese Funktion wird von Jameica vor dem Initialisieren der Services aufgerufen.

Parameters:

oldVersion - Version, die vorher installiert war.

Throws:

de.willuhn.util.ApplicationException - muss geworfen werden, wenn das Update fehlschlug und das Plugin nicht aktiviert werden soll.

update

public void update(Version oldVersion)
            throws de.willuhn.util.ApplicationException

Diese Funktion wird beim Start der Anwendung genau dann aufgerufen, wenn das Plugin bereits erfolgreich installiert wurde, jedoch jetzt in einer anderen Version vorliegt als die vorherige. Sie wird solange bei jedem Start aufgerufen, bis sie fehlerfrei durchlaeuft. Andernfalls wird der Text der geworfenen Exception dem Benutzer auf der Start-Seite von Jameica angezeigt. Von daher empfiehlt es sich, verstaendliche Formulierungen fuer ggf aufgetretene Fehler zu verwenden. Hinweis: Diese Funktion wird von Jameica vor dem Initialisieren der Services aufgerufen.

Parameters:

oldVersion - Version, die vorher installiert war.

Throws:

de.willuhn.util.ApplicationException - muss geworfen werden, wenn das Update fehlschlug und das Plugin nicht aktiviert werden soll.

shutDown

public void shutDown()

Diese Funktion wird beim Beenden der Anwendung ausgefuehrt.