Package org.kapott.hbci.callback

Class HBCICallbackIOStreams

  • All Implemented Interfaces:
    HBCICallback
    Direct Known Subclasses:
    HBCICallbackConsole
    public class HBCICallbackIOStreams
extends AbstractHBCICallback
    Callback-Klasse für Ein-/Ausgabe über IO-Streams. Dabei handelt es sich eine Callback-Klasse, die Ausgaben auf einem PrintStream ausgibt und Eingaben über einen BufferedReader liest. Die Klasse HBCICallbackConsole ist eine abgeleitete Klasse, welche STDOUT und STDIN für die beiden I/O-Streams verwendet.

    • Constructor Detail

      • HBCICallbackIOStreams

        public HBCICallbackIOStreams​(PrintStream outStream,
                             BufferedReader inStream)
        Instanz mit vorgegebenem OUT- und INPUT-Stream erzeugen.
        Parameters:
        outStream - Stream, welcher für die Ausgabe verwendet wird.
        inStream - Stream, der für das Einlesen von Antworten verwendet wird

    • Method Detail

      • getInStream

        protected BufferedReader getInStream()
        Gibt des INPUT-Stream zurück.

      • setInStream

        protected void setInStream​(BufferedReader in)
        TODO: doc

      • getOutStream

        protected PrintStream getOutStream()
        Gibt den verwendeten OUTPUT-Stream zurück.

      • setOutStream

        protected void setOutStream​(PrintStream out)
        TODO: doc

      • log

        public void log​(String msg,
                int level,
                Date date,
                StackTraceElement trace)
        Schreiben von Logging-Ausgaben in einen PrintStream. Diese Methode implementiert die Logging-Schnittstelle des HBCICallback-Interfaces. Die Log-Informationen, die dieser Methode übergeben werden, werden formatiert auf dem jeweiligen outStream ausgegeben. In dem ausgegebenen String sind in enthalten das Log-Level der Message, ein Zeitstempel im Format "yyyy.MM.dd HH:mm:ss.SSS", die Namen der ThreadGroup und des Threads, aus dem heraus die Log-Message erzeugt wurde, der Klassenname der Klasse, welche die Log-Ausgabe erzeugt hat sowie die eigentliche Log-Message

      • callback

        public void callback​(int reason,
                     List<String> msg,
                     int datatype,
                     StringBuilder retData)
        Diese Methode reagiert auf alle möglichen Callback-Ursachen. Bei Callbacks, die nur Informationen an den Anwender übergeben sollen, werden diese auf dem outStream ausgegeben. Bei Callbacks, die Aktionen vom Anwender erwarten (Einlegen der Chipkarte), wird eine entsprechende Aufforderung ausgegeben. Bei Callbacks, die eine Eingabe vom Nutzer erwarten, wird die entsprechende Eingabeaufforderung ausgegeben und die Eingabe vom inStream gelesen.
        Specified by:
        callback in interface HBCICallback
        Overrides:
        callback in class AbstractHBCICallback
        Parameters:
        reason - gibt den Grund für diesen Aufruf an. Dieser Parameter kann alle Werte annehmen, die als "Ursache des Callback-Aufrufes" in der Dokumentation aufgeführt sind. Je nach Wert dieses Parameters werden vom Nutzer Aktionen oder Eingaben erwartet.
        datatype - legt fest, welchen Datentyp die vom HBCI-Kernel erwarteten Antwortdaten haben müssen. Ist dieser Wert gleich TYPE_NONE, so werden keine Antwortdaten (also keine Nutzereingabe) erwartet, bei TYPE_SECRET und TYPE_TEXT wird ein normaler String erwartet.
        Der Unterschied zwischen beiden ist der, dass bei TYPE_SECRET sensible Daten (Passwörter usw.) eingegeben werden sollen, so dass die Eingaberoutine evtl. anders arbeiten muss (z.B. Sternchen anstatt dem eingegebenen Text darstellen).
        retData - In diesem StringBuffer-Objekt müssen die Antwortdaten abgelegt werden. Beim Aufruf der Callback-Methode von HBCI4Java wird dieser StringBuffer u.U. mit einem vorgeschlagenen default-Wert für die Nutzereingabe gefüllt.

      • status

        public void status​(int statusTag,
                   Object[] o)
        Wird diese Methode von HBCI4Java aufgerufen, so wird der aktuelle Bearbeitungsschritt (mit evtl. vorhandenen zusätzlichen Informationen) auf outStream ausgegeben.
        Specified by:
        status in interface HBCICallback
        Overrides:
        status in class AbstractHBCICallback
        Parameters:
        statusTag - gibt an, welche Stufe der Abarbeitung gerade erreicht wurde (alle oben beschriebenen Konstanten, die mit STATUS_ beginnen)
        o - ein Array aus Objekten, das zusätzliche Informationen zum jeweiligen Status enthält. In den meisten Fällen handelt es sich um einen String, der zusätzliche Informationen im Klartext enthält. Welche Informationen das jeweils sind, ist der Beschreibung zu den einzelnen STATUS_*-Tag-Konstanten zu entnehmen.

      • createDefaultLogLine

        protected String createDefaultLogLine​(String msg,
                                      int level,
                                      Date date,
                                      StackTraceElement trace)
        Erzeugt einen Log-Eintrag. Diese Methode wird von den mitgelieferten Callback-Klassen für die Erzeugung von Log-Einträgen verwendet. Um ein eigenes Format für die Log-Eintrage zu definieren, kann diese Methode mit einer eigenen Implementierung überschrieben werden.
        Die Parameter entsprechen denen der log-Methode
        Returns:
        ein Log-Eintrag