Interface Plugin

All Known Implementing Classes:
AbstractPlugin, PlaceholderPlugin

public interface Plugin
Basis-Interface aller Plugins.
  • Method Summary

    Modifier and Type
    Method
    Description
    Liefert das Manifest des Plugins.
    Liefert ein Objekt mit Resourcen, auf die das Plugin zugreifen kann.
    void
    Diese Funktion wird beim Start der Anwendung ausgefuehrt.
    void
    Diese Funktion wird beim Start der Anwendung aufgerufen, wenn das Plugin zum ersten mal gestartet wird.
    void
    Diese Funktion wird beim Beenden der Anwendung ausgefuehrt.
    void
    uninstall(boolean deleteUserData)
    Wird aufgerufen, wenn das Plugin ueber Datei->Einstellungen->Plugins deinstalliert wird.
    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.
  • Method Details

    • getResources

      PluginResources getResources()
      Liefert ein Objekt mit Resourcen, auf die das Plugin zugreifen kann.
      Returns:
      Resource-Pack.
    • getManifest

      Manifest getManifest()
      Liefert das Manifest des Plugins.
      Returns:
      Manifest.
    • init

      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

      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

      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

      void shutDown()
      Diese Funktion wird beim Beenden der Anwendung ausgefuehrt.
    • uninstall

      void uninstall(boolean deleteUserData) throws de.willuhn.util.ApplicationException
      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.
      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.