Package de.willuhn.jameica.plugin
Class AbstractPlugin
java.lang.Object
de.willuhn.jameica.plugin.AbstractPlugin
- All Implemented Interfaces:
Plugin
Abstrakte Basis-Klasse aller Plugins.
Jedes Plugin muss diese Klasse erweitern, damit es beim Start von
Jameica erkannt wird.
- Author:
- willuhn
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal Manifest
Liefert das Manifest des Plugins.final PluginResources
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
uninstall
(boolean deleteUserData) Wird aufgerufen, wenn das Plugin ueber Datei->Einstellungen->Plugins deinstalliert wird.void
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.
-
Constructor Details
-
AbstractPlugin
public AbstractPlugin()
-
-
Method Details
-
getResources
Description copied from interface:Plugin
Liefert ein Objekt mit Resourcen, auf die das Plugin zugreifen kann.- Specified by:
getResources
in interfacePlugin
- Returns:
- Resource-Pack.
- See Also:
-
getManifest
Description copied from interface:Plugin
Liefert das Manifest des Plugins.- Specified by:
getManifest
in interfacePlugin
- Returns:
- Manifest.
- See Also:
-
init
public void init() throws de.willuhn.util.ApplicationExceptionDescription copied from interface:Plugin
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. -
install
public void install() throws de.willuhn.util.ApplicationExceptionDescription copied from interface:Plugin
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. -
update
Description copied from interface:Plugin
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. -
shutDown
public void shutDown()Description copied from interface:Plugin
Diese Funktion wird beim Beenden der Anwendung ausgefuehrt. -
uninstall
public void uninstall(boolean deleteUserData) throws de.willuhn.util.ApplicationException Description copied from interface:Plugin
Wird aufgerufen, wenn das Plugin ueber Datei->Einstellungen->Plugins deinstalliert wird. Hier kann das Plugin bei Bedarf eigene Aufraeum-Arbeiten durchfuehren. VOR dem Aufruf dieser Funktion wird "shutDown" aufgerufen. Falls dort also z.Bsp. Datenbankverbindungen geschlossen wurden, dann stehen diese hier nicht mehr zur Verfuegung.- Specified by:
uninstall
in interfacePlugin
- Parameters:
deleteUserData
- true, wenn der User bei der Deinstallation angegeben hat, dass auch die Benutzer-Daten des Plugins geloescht werden sollen.- Throws:
de.willuhn.util.ApplicationException
- kann geworfen werden, um die Deinstallation abzubrechen.- See Also:
-