org.kapott.hbci.tools.ShowLowlevelGVRs Maven / Gradle / Ivy
Show all versions of hbci4j-core Show documentation
/**********************************************************************
*
* This file is part of HBCI4Java.
* Copyright (c) 2001-2008 Stefan Palme
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
**********************************************************************/
package org.kapott.hbci.tools;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import org.kapott.hbci.callback.HBCICallbackConsole;
import org.kapott.hbci.manager.HBCIKernelImpl;
import org.kapott.hbci.manager.HBCIUtils;
import org.kapott.hbci.manager.MsgGen;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
/** Dieses Tool dient zum Anzeigen der Struktur von HBCI-Job-Ergebnisdaten im
Rohformat. Diese Struktur wird benötigt, wenn Job-Ergebnisdaten nicht über
die Methoden und Felder der entsprechenden Highlevel-Klassen ausgewertet
werden sollen (Klassen org.kapott.hbci.GV_Result.GVR*), sondern
wenn die Daten benutzt werden, die durch
{@link org.kapott.hbci.GV_Result.HBCIJobResult#getResultData()}
zurückgegeben werden.
In diesem Property-Objekt werden die Job-Ergebnisdaten nämlich nach der HBCI4Java-internen
Struktur benannt. Um nun die Bezeichnungen für die einzelnen Datenelemente zu erfahren,
kann dieses Tool benutzt werden.
Der Aufruf erfolgt durch
java org.kapott.hbci.tools.ShowLowlevelGVRs [hbciversion]
Ist keine
hbciversion angegeben, so wird diese über STDIN erfragt.
Das Tool gibt eine baumartige Struktur aus, welche die Lowlevelnamen der Geschäftsvorfälle
(plus dem zusätzlichen Suffix "Res") sowie die Bezeichnungen für die
dazugehörigen Datenfelder enthält. Eine Erklärung der Ausgaben im Detail ist in der Dokumentation
zum Tool {@link ShowLowlevelGVs} enthalten.
Innerhalb einer Anwendung kann mit der Methode
{@link org.kapott.hbci.manager.HBCIHandler#getSupportedLowlevelJobs()}
eine Liste aller unterstützten Lowlevel-Jobs in Erfahrung gebracht werden. Zusätzlich gibt diese
Methode zu jedem Jobnamen die Versionsnummer zurück, welche für diesen Job von HBCI4Java benutzt
werden wird (das hängt von der aktuellen HBCI-Version und dem benutzten Passport ab, kann von
außen also nicht direkt beeinflusst werden). In der Ausgabe dieses Tool kann nun nach einem
bestimmten Lowlevelnamen eines Jobs und der von HBCI4Java dafür verwendeten Versionsnummer gesucht werden.
Ist der entsprechende Eintrag gefunden, so hat man eine Übersicht über alle möglichen
Job-Ergebnisdaten und wie oft die jeweiligen Datenelemente in einem Antwortsegment auftreten
können. Die gleiche Übersicht erhält man übrigens, wenn man innerhalb der Anwendung die Methode
{@link org.kapott.hbci.manager.HBCIHandler#getLowlevelJobResultNames(String)}
aufruft, allerdings fehlen in der Ausgabe dieser Methode die Informationen über die möglichen
Häufigkeiten der einzelnen Datenelemente, dafür wird hier automatisch die richtige Versionsnummer
des Jobs ausgewählt.
*/
public class ShowLowlevelGVRs
extends AbstractShowLowlevelData
{
public static void main(String[] args)
throws Exception
{
HBCIUtils.init(null,new HBCICallbackConsole());
String hbciversion;
if (args.length>=1) {
hbciversion=args[0];
} else {
System.out.print("hbciversion: ");
System.out.flush();
hbciversion=new BufferedReader(new InputStreamReader(System.in)).readLine();
}
HBCIKernelImpl kernel=new HBCIKernelImpl(null,hbciversion);
MsgGen msggen=kernel.getMsgGen();
Document syntax=msggen.getSyntax();
Element gvlist=syntax.getElementById("GVRes");
NodeList gvnodes=gvlist.getChildNodes();
int len=gvnodes.getLength();
for (int i=0;i