Class ApplicationCallbackConsole

java.lang.Object
de.willuhn.jameica.system.AbstractApplicationCallback
de.willuhn.jameica.system.ApplicationCallbackConsole
All Implemented Interfaces:
ApplicationCallback

public class ApplicationCallbackConsole extends AbstractApplicationCallback
Implementierung des ApplicationCallback fuer den Server-Mode. Dieser Callback kommuniziert mit dem Benutzer ueber die Console.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • 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
    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 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.
    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.

    Methods inherited from class de.willuhn.jameica.system.AbstractApplicationCallback

    checkHostname, getHostname

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • ApplicationCallbackConsole

      public ApplicationCallbackConsole()
  • Method Details

    • lockExists

      public boolean lockExists(String lockfile)
      Description copied from interface: ApplicationCallback
      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.
      See Also:
    • getUsername

      public String getUsername()
      Description copied from interface: ApplicationCallback
      Liefert den eingegebenen Benutzernamen, insofern der Start im Masterpasswort-Dialog mit Benutzername erfolgte.
      Returns:
      der eingegebene Username oder null.
      See Also:
    • createPassword

      public String createPassword() throws Exception
      Description copied from interface: ApplicationCallback
      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
      See Also:
    • getPassword

      public String getPassword() throws Exception
      Description copied from interface: ApplicationCallback
      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
      See Also:
    • getPassword

      public String getPassword(LoginVerifier verifier) throws Exception
      Description copied from interface: ApplicationCallback
      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
      See Also:
    • changePassword

      public void changePassword() throws Exception
      Description copied from interface: ApplicationCallback
      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 ApplicationCallback.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 ApplicationCallback.getPassword() zur Verfuegung zu stellen.

      Throws:
      Exception
      See Also:
    • getStartupMonitor

      public de.willuhn.util.ProgressMonitor getStartupMonitor()
      Description copied from interface: ApplicationCallback
      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.
      See Also:
    • getShutdownMonitor

      public de.willuhn.util.ProgressMonitor getShutdownMonitor()
      Description copied from interface: ApplicationCallback
      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.
      See Also:
    • startupError

      public void startupError(String errorMessage, Throwable t)
      Description copied from interface: ApplicationCallback
      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.
      See Also:
    • askUser

      public String askUser(String question, String labeltext) throws Exception
      Description copied from interface: ApplicationCallback
      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
      See Also:
    • askPassword

      public String askPassword(String question) throws Exception
      Description copied from interface: ApplicationCallback
      Benoetigt Jameica ein Passwort, wird diese Funktion aufgerufen.
      Parameters:
      question - Die anzuzeigende Frage.
      Returns:
      der vom User eingegebene Text.
      Throws:
      Exception
      See Also:
    • checkTrust

      public boolean checkTrust(X509Certificate cert) throws Exception
      Description copied from interface: ApplicationCallback
      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
      See Also:
    • notifyUser

      public void notifyUser(String text) throws Exception
      Description copied from interface: ApplicationCallback
      Kann benutzt werden, um z.Bsp. eine wichtig Fehlermeldung anzuzeigen.
      Parameters:
      text - der anzuzeigende Text.
      Throws:
      Exception
      See Also:
    • askUser

      public boolean askUser(String question) throws Exception
      Description copied from interface: ApplicationCallback
      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
      See Also:
    • askUser

      public boolean askUser(String question, String[] variables) throws Exception
      Description copied from interface: ApplicationCallback
      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
      See Also:
    • askUser

      public boolean askUser(String question, boolean storeAnswer) throws Exception
      Description copied from interface: ApplicationCallback
      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
      See Also:
    • askUser

      public boolean askUser(String question, String[] variables, boolean storeAnswer) throws Exception
      Description copied from interface: ApplicationCallback
      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
      See Also:
    • login

      public Login login(JameicaAuthenticator auth) throws Exception
      Description copied from interface: ApplicationCallback
      Fragt vom User ein Login ab.
      Specified by:
      login in interface ApplicationCallback
      Overrides:
      login in class AbstractApplicationCallback
      Parameters:
      auth - der Authenticator. Er liefert Context-Infos zum abgefragten Login.
      Returns:
      das Login.
      Throws:
      Exception
      See Also: