org.kapott.hbci.status.HBCIMsgStatus Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hbci4j-adorsys Show documentation
Show all versions of hbci4j-adorsys Show documentation
HBCI4j - Home Banking Computer Interface for Java - Clone from https://github.com/hbci4j/hbci4java
/* $Id: HBCIMsgStatus.java,v 1.1 2011/05/04 22:38:02 willuhn Exp $
This file is part of HBCI4Java
Copyright (C) 2001-2008 Stefan Palme
HBCI4Java is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
HBCI4Java 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.kapott.hbci.status;
import org.kapott.hbci.manager.HBCIUtils;
import java.util.*;
/**
* Enthält alle Status-Informationen zu genau einem Nachrichtenaustausch.
* Es ist zu beachten, dass in einer Nachricht Informationen zu
* mehreren Geschäftsvorfällen enthalten sein können, wenn die
* gesendete Nachricht mehrere Aufträge enthalten hat.
*
* Die direkte Auswertung
* der Felder dieser Klasse wird nicht empfohlen, statt dessen sollten nur
* die Methoden benutzt werden, die den prinzipiellen Status (OK oder nicht OK)
* sowie die eigentlichen Fehler-Informationen zurückgeben.
*/
public final class HBCIMsgStatus {
private static final List invalidPinCodes = Arrays.asList("9931", "9942", "9340");
/**
* Globale Status-Informationen. Das sind Informationen, die die
* Nachricht als ganzes betreffen (z.B. wenn die Nachricht nicht signiert
* oder verschlüsselt war, oder wenn sie nicht dekodiert werden konnte etc.)
*/
public HBCIStatus globStatus;
/**
* Status-Informationen, die einzelne Segmente der Nachricht betreffen.
* Hier werden alle Rückgabecodes gespeichert, die sich konkret auf
* einzelne Segmente der gesendeten Nachricht beziehen.
*/
public HBCIStatus segStatus;
private HashMap data;
public HBCIMsgStatus() {
this.globStatus = new HBCIStatus();
this.segStatus = new HBCIStatus();
this.data = new HashMap<>();
}
/**
* Wird von der HBCI4Java-Dialog-Engine aufgerufen
*/
public void addException(Exception e) {
globStatus.addException(e);
}
/**
* Wird von der HBCI4Java-Dialog-Engine aufgerufen
*/
public void addData(Map _data) {
this.data.putAll(_data);
extractStatusData();
}
private void extractStatusData() {
this.globStatus = new HBCIStatus();
this.segStatus = new HBCIStatus();
// globale return-codes extrahieren
for (int i = 0; true; i++) {
HBCIRetVal rv;
try {
rv = new HBCIRetVal(data, HBCIUtils.withCounter("RetGlob.RetVal", i));
} catch (Exception e) {
break;
}
globStatus.addRetVal(rv);
}
// segment-codes extrahieren
for (int i = 0; true; i++) {
String segheader = HBCIUtils.withCounter("RetSeg", i);
String segref = data.get(segheader + ".SegHead.ref");
if (segref == null) {
break;
}
for (int j = 0; true; j++) {
HBCIRetVal rv = null;
try {
rv = new HBCIRetVal(data, HBCIUtils.withCounter(segheader + ".RetVal", j), segref);
} catch (Exception e) {
break;
}
segStatus.addRetVal(rv);
}
}
}
/**
* Gibt den eigentlichen Inhalt sowohl der gesendeten wie auch der
* empfangenen Nachricht zurück. Die keys des Property-Objektes
* enthalten die Lowlevelnamen der Datenelemente, die dazugehörigen
* values enthalten jeweils den Wert des entsprechenden Datenelementes.
* Die Bezeichnungen der Datenelemente der gesendeten Nachricht tragen
* zur Unterscheidung mit den Datenelementen der empfangenen Nachricht das
* Prefix "orig_".
*/
public HashMap getData() {
return data;
}
/**
* Wird von der HBCI4Java-Dialog-Engine aufgerufen
*/
public void setData(HashMap data) {
this.data = data;
extractStatusData();
}
/**
* Gibt zurück, ob bei der Ausführung eines Nachrichtenaustauschs Exceptions
* aufgetreten sind. Diese Exceptions können entweder beim Erzeugen bzw.
* Versenden der Kundennachricht oder aber beim Empfangen und Auswerten
* der Institutsnachricht aufgetreten sein.
*
* @return true, wenn Exceptions aufgetreten sind, sonst
* false
*/
public boolean hasExceptions() {
return globStatus.hasExceptions();
}
/**
* Gibt die Exceptions zurück, ob bei der Ausführung eines
* Nachrichtenaustauschs aufgetreten sind. Diese Exceptions können entweder
* beim Erzeugen bzw. Versenden der Kundennachricht oder aber beim Empfangen
* und Auswerten der Institutsnachricht aufgetreten sein.
*
* @return Array mit aufgetretenen Exceptions, ist niemals null,
* kann aber die Länge 0 haben
*/
public Exception[] getExceptions() {
return globStatus.getExceptions();
}
/**
* Gibt zurück, ob ein Nachrichtenaustausch erfolgreich durchgeführt wurde. Das
* ist dann der Fall, wenn bei der Abarbeitung keine Exceptions aufgetreten
* sind und die Antwortnachricht eine Erfolgsmeldung oder zumindest
* nur Warnungen (aber keine Fehlermeldung) enthält.
*
* @return true, wenn die Nachricht erfolgreich abgearbeitet
* wurde, sonst false
*/
public boolean isOK() {
// wenn bei einer CustomMsg mit mehreren GVs EINER fehlschlug,
// dann ist auch isOK()==false. Ist das so gewollt?
return globStatus.getStatusCode() == HBCIStatus.STATUS_OK;
}
/**
* Gibt einen String zurück, der alle aufgetretenen Fehler bei der
* Durchführung des Nachrichtenaustauschs beschreibt. Dieser String besteht aus
* allen Exception-Meldungen sowie allen evtl. empfangenen Fehlermeldungen.
* Die Meldungen werden aus den einzelnen
* {@link org.kapott.hbci.status.HBCIStatus}-Objekten durch
* Aufruf der Methode {@link org.kapott.hbci.status.HBCIStatus#getErrorList()}
* erzeugt.
*
* @return String mit allen aufgetretenen Fehlermeldungen
*/
public List getErrorList() {
List ret = new ArrayList<>();
ret.addAll(globStatus.getErrorList());
ret.addAll(segStatus.getErrorList());
return ret;
}
public List getWarningsList() {
List ret = new ArrayList<>();
ret.addAll(globStatus.getWarningsList());
ret.addAll(segStatus.getWarningsList());
return ret;
}
/**
* Fasst alle Status-Informationen zu einem Nachrichtenaustausch in einem einzigen
* String zusammen und gibt diesen zurück. Dazu gehören alle evtl.
* aufgetretenen Exception-Meldungen, alle Fehlermeldungen, Warnungen sowie
* Erfolgsmeldungen. Die Meldungen werden aus den einzelnen
* {@link org.kapott.hbci.status.HBCIStatus}-Objekten durch
* Aufruf der Methode {@link org.kapott.hbci.status.HBCIStatus#toString()}
* erzeugt.
*
* @return einen String, der alle Status-Informationen zu einer Nachricht enthält
*/
public String toString() {
StringBuilder ret = new StringBuilder();
ret.append(globStatus.toString());
ret.append(System.getProperty("line.separator"));
ret.append(segStatus.toString());
return ret.toString().trim();
}
/**
* Gibt zurück, ob der Fehler "PIN ungültig" zurückgemeldet wurde
*
* @return invalid pin code
*/
public String getInvalidPinCode() {
for (HBCIRetVal hbciRetVal : globStatus.getErrors()) {
if (invalidPinCodes.contains(hbciRetVal.code)) {
return hbciRetVal.code;
}
}
for (HBCIRetVal hbciRetVal : segStatus.getErrors()) {
if (invalidPinCodes.contains(hbciRetVal.code)) {
return hbciRetVal.code;
}
}
return null;
}
/**
* Gibt zurück, ob der Fehler "Dielog beendet" zurückgemeldet wurde
*
* @return true oder false
*/
public boolean isDialogClosed() {
for (HBCIRetVal hbciRetVal : globStatus.getErrors()) {
if (hbciRetVal.code.equals("9800")) {
return true;
}
}
for (HBCIRetVal hbciRetVal : segStatus.getErrors()) {
if (hbciRetVal.code.equals("9800")) {
return true;
}
}
return false;
}
/**
* Sucht in den Ergebnis-Daten des Kernels nach der ersten Segment-Nummer mit einem Task-Response.
*
* @return die Nummer des Segments oder -1, wenn keines gefunden wurde.
*/
public int findTaskSegment() {
HashMap result = getData();
// searching for first segment number that belongs to the custom_msg
// we look for entries like {"1","CustomMsg.GV*"} and so on (this data is inserted from the HBCIKernelImpl
// .rawDoIt() method),
// until we find the first segment containing a task
int segnum = 1;
while (segnum < 1000) // Wir brauchen ja nicht endlos suchen
{
final String path = result.get(Integer.toString(segnum));
// Wir sind am Ende der Segmente angekommen
if (path == null)
return -1;
// Wir haben ein GV-Antwort-Segment gefunden
if (path.startsWith("CustomMsg.GV"))
return segnum;
// naechstes Segment
segnum++;
}
return -1;
}
}