Interface ApplicationCallback

All Known Implementing Classes:
AbstractApplicationCallback, ApplicationCallbackConsole, ApplicationCallbackSWT

public interface ApplicationCallback
Dieses Interface beschreibt Funktionen, die von Jameica aufgerufen werden, um mit dem Benutzer zu interagieren.

Dies betrifft Informationen, die den Jameica-Kern selbst betreffen und daher sowohl im Server- als auch im GUI- Mode abgefragt werden muessen.

Klassisches Beispiel: Jameica legt beim Start ein Lock-File an, um sicherzustellen, dass die Anwendung nicht zweimal gleichzeitig gestartet wird. Existiert das Lock-File bereits, fragt Jameica den Benutzer, ob der Start dennoch durchgefuehrt werden soll.

  • Method Summary

    Modifier and Type
    Method
    Description
    askPassword(String question)
    Benoetigt Jameica ein Passwort, wird diese Funktion aufgerufen.
    boolean
    askUser(String question)
    Wird von Jameica aufgerufen, wenn der Benutzer eine Frage mit Ja/Nein beantworten soll.
    boolean
    askUser(String question, boolean storeAnswer)
    Wird von Jameica aufgerufen, wenn der Benutzer eine Frage mit Ja/Nein beantworten soll.
    askUser(String question, String labeltext)
    Benoetigt Jameica eine Benutzereingabe (zum Beispiel zur Abfrage des Hostnamens) wird diese Funktion aufgerufen.
    boolean
    askUser(String question, String[] variables)
    Wird von Jameica aufgerufen, wenn der Benutzer eine Frage mit Ja/Nein beantworten soll.
    boolean
    askUser(String question, String[] variables, boolean storeAnswer)
    Wird von Jameica aufgerufen, wenn der Benutzer eine Frage mit Ja/Nein beantworten soll.
    void
    Ueber diese Funktion kann das Passwort des Keystores geaendert werden.
    boolean
    checkHostname(String hostname, X509Certificate[] certs)
    Wird aufgerufen, wenn Jameica versucht, sich via HTTPS mit einem Server zu verbinden, dessen Hostname mit keinem der uebertragenen SSL-Zertifikate uebereinstimmt.
    boolean
    Wird aufgerufen, wenn dem TrustManager von Jameica ein Zertifikat angeboten wird, dass er nicht in seinem Truststore hat.
    Wird beim ersten Start von Jameica aufgerufen, um ein neues Master-Passwort festzulegen.
    Liefert den Hostnamen des Systems.
    Liefert das Master-Passwort der Jameica-Installation.
    Liefert das Master-Passwort der Jameica-Installation.
    de.willuhn.util.ProgressMonitor
    Liefert einen Progress-Monitor ueber den der Fortschritt des System-Shutdown ausgegeben werden kann.
    de.willuhn.util.ProgressMonitor
    Liefert einen Progress-Monitor ueber den der Fortschritt des System-Starts ausgegeben werden kann.
    Liefert den eingegebenen Benutzernamen, insofern der Start im Masterpasswort-Dialog mit Benutzername erfolgte.
    boolean
    lockExists(String lockfile)
    Wird aufgerufen, wenn das Lock-File von Jameica beim Start bereits existiert.
    login(JameicaAuthenticator authenticator)
    Fragt vom User ein Login ab.
    void
    Kann benutzt werden, um z.Bsp.
    void
    startupError(String errorMessage, Throwable t)
    Diese Funktion wird von Jameica aufgerufen, wenn der Start voellig fehlschlug.
  • Method Details

    • lockExists

      boolean lockExists(String lockfile)
      Wird aufgerufen, wenn das Lock-File von Jameica beim Start bereits existiert. Es ist Sache der Implementierung, dies dem Benutzer darzulegen.
      Parameters:
      lockfile - Pfad und Dateiname des Lockfiles.
      Returns:
      true, wenn der Start von Jameica dennoch fortgesetzt werden soll. false, wenn der Start abgebrochen werden soll.
    • getUsername

      String getUsername()
      Liefert den eingegebenen Benutzernamen, insofern der Start im Masterpasswort-Dialog mit Benutzername erfolgte.
      Returns:
      der eingegebene Username oder null.
    • createPassword

      String createPassword() throws Exception
      Wird beim ersten Start von Jameica aufgerufen, um ein neues Master-Passwort festzulegen.

      Es ist dabei der implementierenden Klasse ueberlassen, wie diese Abfrage aussieht. Sprich: Ob sie nun nur ein Eingabefeld zur Vergabe des Passwortes anzeigt oder zwei, wovon letzteres zur Passwort-Wiederholung (Vermeidung von Tippfehlern) dient, ist der Implementierung ueberlassen.

      Returns:
      das neu zu verwendende Passwort.
      Throws:
      Exception
    • getPassword

      String getPassword() throws Exception
      Liefert das Master-Passwort der Jameica-Installation.

      Es ist der implementierenden Klasse ueberlassen, das eingegebene Passwort ueber die Dauer der aktuellen Jameica-Sitzung zu cachen, um den Benutzer nicht dauernd mit der Neueingabe des Passwortes zu nerven.

      Returns:
      das existierende Passwort.
      Throws:
      Exception
    • getPassword

      String getPassword(LoginVerifier verifier) throws Exception
      Liefert das Master-Passwort der Jameica-Installation.

      Es ist der implementierenden Klasse ueberlassen, das eingegebene Passwort ueber die Dauer der aktuellen Jameica-Sitzung zu cachen, um den Benutzer nicht dauernd mit der Neueingabe des Passwortes zu nerven.

      Parameters:
      verifier - optionaler Login-Verifier, der von der implementierenden Klasse verwendet werden kann, um das Passwort zu auf Korrektheit pruefen, bevor die Methode verlassen wird.
      Returns:
      das existierende Passwort.
      Throws:
      Exception
    • changePassword

      void changePassword() throws Exception
      Ueber diese Funktion kann das Passwort des Keystores geaendert werden.

      Alles, was die implementierende Klasse zu tun hat, ist einen Dialog zur Passwort-Aenderung anzuzeigen und von nun an in der Funktion getPassword() das neue Passwort zu liefern.

      Nochmal: Es ist nicht Aufgabe des ApplicationCallbacks, das Passwort im System zu aendern, sondern lediglich das neue Passwort vom Benutzer abzufragen und es anschliessend ueber getPassword() zur Verfuegung zu stellen.

      Throws:
      Exception
      See Also:
    • getStartupMonitor

      de.willuhn.util.ProgressMonitor getStartupMonitor()
      Liefert einen Progress-Monitor ueber den der Fortschritt des System-Starts ausgegeben werden kann. Im GUI-Mode ist das ein Splash-Screen.
      Returns:
      ein Progress-Monitor.
    • getShutdownMonitor

      de.willuhn.util.ProgressMonitor getShutdownMonitor()
      Liefert einen Progress-Monitor ueber den der Fortschritt des System-Shutdown ausgegeben werden kann. Im GUI-Mode ist das ein Splash-Screen.
      Returns:
      ein Progress-Monitor.
    • startupError

      void startupError(String errorMessage, Throwable t)
      Diese Funktion wird von Jameica aufgerufen, wenn der Start voellig fehlschlug. Die implementierende Klasse muss diese Fehlermeldung dem Benutzer anzeigen. Anschliessend beendet sich Jameica.
      Parameters:
      errorMessage - die anzuzeigende Fehlermeldung.
      t - Ein ggf. existierender Fehler.
    • askUser

      String askUser(String question, String labeltext) throws Exception
      Benoetigt Jameica eine Benutzereingabe (zum Beispiel zur Abfrage des Hostnamens) wird diese Funktion aufgerufen.
      Parameters:
      question - Die anzuzeigende Frage.
      labeltext - Der Name des Attributes oder Feldes, welches eingegeben werden soll.
      Returns:
      der vom User eingegebene Text.
      Throws:
      Exception
    • askPassword

      String askPassword(String question) throws Exception
      Benoetigt Jameica ein Passwort, wird diese Funktion aufgerufen.
      Parameters:
      question - Die anzuzeigende Frage.
      Returns:
      der vom User eingegebene Text.
      Throws:
      Exception
    • askUser

      boolean askUser(String question) throws Exception
      Wird von Jameica aufgerufen, wenn der Benutzer eine Frage mit Ja/Nein beantworten soll.
      Parameters:
      question - Die anzuzeigende Frage.
      Returns:
      true fuer ja, false fuer nein.
      Throws:
      Exception
    • askUser

      boolean askUser(String question, String[] variables) throws Exception
      Wird von Jameica aufgerufen, wenn der Benutzer eine Frage mit Ja/Nein beantworten soll.

      Hintergrund: Jameica speichert question als Key in einer Properties-Datei, falls der User die Option "Frage nicht mehr anzeigen" aktiviert hat. Enthaelt die Frage nun aber variablen Text, wuerde die selbe Frage immer wieder kommen - nur weil ein paar Variablen anders sind und somit der Key in der Properties-Datei nicht mehr uebereinstimmt. Daher kann man stattdessen diese Funktion hier verwenden. Im Text benutzt man (wie bei I18N.tr(String, String[])) die Platzhalter "{0}","{1}",... und uebergibt als String-Array die einzutragenden Variablen.

      Parameters:
      question - Die anzuzeigende Frage.
      variables - mittels MessageFormat einzutragende Variablen.
      Returns:
      true fuer ja, false fuer nein.
      Throws:
      Exception
    • askUser

      boolean askUser(String question, boolean storeAnswer) throws Exception
      Wird von Jameica aufgerufen, wenn der Benutzer eine Frage mit Ja/Nein beantworten soll.
      Parameters:
      question - Die anzuzeigende Frage.
      storeAnswer - true, wenn die Option "Diese Frage künftig nicht mehr anzeigen" angezeigt werden soll.
      Returns:
      true fuer ja, false fuer nein.
      Throws:
      Exception
    • askUser

      boolean askUser(String question, String[] variables, boolean storeAnswer) throws Exception
      Wird von Jameica aufgerufen, wenn der Benutzer eine Frage mit Ja/Nein beantworten soll.

      Hintergrund. Jameica speichert question als Key in einer Properties-Datei, falls der User die Option "Frage nicht mehr anzeigen" aktiviert hat. Enthaelt die Frage nun aber variablen Text, wuerde die selbe Frage immer wieder kommen - nur weil ein paar Variablen anders sind und somit der Key in der Properties-Datei nicht mehr uebereinstimmt. Daher kann man stattdessen diese Funktion hier verwenden. Im Text benutzt man (wie bei I18N.tr(String, String[])) die Platzhalter "{0}","{1}",... und uebergibt als String-Array die einzutragenden Variablen.

      Parameters:
      question - Die anzuzeigende Frage.
      variables - mittels MessageFormat einzutragende Variablen.
      storeAnswer - true, wenn die Option "Diese Frage künftig nicht mehr anzeigen" angezeigt werden soll.
      Returns:
      true fuer ja, false fuer nein.
      Throws:
      Exception
    • notifyUser

      void notifyUser(String text) throws Exception
      Kann benutzt werden, um z.Bsp. eine wichtig Fehlermeldung anzuzeigen.
      Parameters:
      text - der anzuzeigende Text.
      Throws:
      Exception
    • checkTrust

      boolean checkTrust(X509Certificate cert) throws Exception
      Wird aufgerufen, wenn dem TrustManager von Jameica ein Zertifikat angeboten wird, dass er nicht in seinem Truststore hat. Der Benutzer soll dann entscheiden, ob er dem Zertifikat vertraut.
      Parameters:
      cert - das dem Benutzer anzuzeigende Zertifikat.
      Returns:
      true, wenn der TrustManager das Zertifikate akzeptieren und zum Truststore hinzufuegen soll. Andernfalls false.
      Throws:
      Exception
    • checkHostname

      boolean checkHostname(String hostname, X509Certificate[] certs) throws Exception
      Wird aufgerufen, wenn Jameica versucht, sich via HTTPS mit einem Server zu verbinden, dessen Hostname mit keinem der uebertragenen SSL-Zertifikate uebereinstimmt. Der Benutzer soll dann entscheiden, ob der Hostname korrekt ist.
      Parameters:
      hostname - der Hostname des Servers.
      certs - die Zertifikate des Servers.
      Returns:
      true, wenn der Hostname akzeptiert werden soll, andernfalls false.
      Throws:
      Exception
    • getHostname

      String getHostname() throws Exception
      Liefert den Hostnamen des Systems.

      Dieser wird fuer die Erstellung des X.509-Zertifikats benoetigt.

      Die Funktion wirft nur dann eine Exception, wenn alle Stricke reissen - auch die manuelle Eingabe des Hostnamens durch den User.

      Returns:
      Hostname.
      Throws:
      Exception
    • login

      Login login(JameicaAuthenticator authenticator) throws Exception
      Fragt vom User ein Login ab.
      Parameters:
      authenticator - der Authenticator. Er liefert Context-Infos zum abgefragten Login.
      Returns:
      das Login.
      Throws:
      Exception