org.kapott.hbci.GV

Class HBCIJobImpl

java.lang.Object

org.kapott.hbci.GV.HBCIJobImpl

All Implemented Interfaces:

HBCIJob

Direct Known Subclasses:

AbstractMultiGV, AbstractSEPAGV, GVAccInfo, GVCardList, GVChangePIN, GVCustomMsg, GVDauerDel, GVDauerEdit, GVDauerList, GVDauerNew, GVFestCondList, GVFestList, GVInfoList, GVInfoOrder, GVKontoauszug, GVKUmsAll, GVLast, GVSaldoReq, GVSEPAInfo, GVStatus, GVStornoLast, GVTAN2Step, GVTANList, GVTANMediaList, GVTemplate, GVTermUeb, GVTermUebDel, GVTermUebEdit, GVTermUebList, GVUeb, GVUebForeign, GVWPDepotList, GVWPDepotUms

public abstract class HBCIJobImpl
extends Object
implements HBCIJob

Field Summary

Fields

Modifier and Type	Field and Description
protected HBCIJobResultImpl	jobResult
protected HBCIPassport	passport

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HBCIJobImpl(HBCIPassport passport, MsgGen gen, String jobnameLL, HBCIJobResultImpl jobResult)

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptsParam(String hlParamName)
protected void	addConstraint(String frontendName, String destinationName, String defValue, int logFilterLevel)
protected void	addConstraint(String frontendName, String destinationName, String defValue, int logFilterLevel, boolean indexed)
protected void	checkAccountCRC(String frontendname)
SEG	createJobSegment()
SEG	createJobSegment(int segnum)
protected void	extractResults(HBCIMsgStatus msgstatus, String header, int idx)
void	fillJobResult(HBCIMsgStatus status, int offset)
String	getChallengeParam(String path)
String	getExternalId() Liefert eine optionalen Identifier, der von der Banking-Anwendung genutzt werden kann, um einen Bezug zum urspruenglichen Auftrag herstellen zu koennen.
String	getHBCICode()
String	getJobName()
List<String>	getJobParameterNames()
Properties	getJobRestrictions() Gibt für einen Job alle bekannten Einschränkungen zurück, die bei der Ausführung des jeweiligen Jobs zu beachten sind.
HBCIJobResult	getJobResult() Gibt ein Objekt mit den Rückgabedaten für diesen Job zurück.
List<String>	getJobResultNames() Gibt alle möglichen Property-Namen für die Lowlevel-Rückgabedaten dieses Jobs zurück.
String	getLowlevelParam(String key)
Properties	getLowlevelParams() Gibt alle für diesen Job gesetzten Parameter zurück.
int	getMaxNumberPerMsg()
int	getMinSigs()
String	getName() Gibt den internen Namen für diesen Job zurück.
Konto	getOrderAccount() Liefert das Auftraggeber-Konto, wie es ab HKTAN5 erforderlich ist.
int	getSecurityClass()
String	getSegVersion() Gibt die für diesen Job verwendete Segment-Versionsnummer zurück
boolean	needsContinue(int loop)
protected void	saveReturnValues(HBCIMsgStatus status, int sref)
void	setContinueOffset(int loop)
void	setExternalId(String id) Kann von der Banking-Anwendung genutzt werden, um einen eigenen Identifier im Job zu speichern, um im spaeteren Verlauf des HBCI-Dialoges (z.Bsp. bei der TAN-Eingabe) einen Bezug zum urspruenglichen Auftrag wiederherstellen zu koennen.
void	setIdx(int idx)
protected void	setLowlevelParam(String key, String value)
void	setLowlevelParams(Properties llParams)
void	setParam(String paramName, Date date) Setzen eines Job-Parameters, bei dem ein Datums als Wert erwartet wird.
void	setParam(String paramName, int i) Setzen eines Job-Parameters, bei dem ein Integer-Wert Da als Wert erwartet wird.
void	setParam(String paramName, Integer index, Date date)
void	setParam(String paramname, Integer index, Konto acc)
void	setParam(String paramName, Integer index, String value) Setzen eines Job-Parameters.
void	setParam(String paramname, Integer index, Value v)
void	setParam(String paramname, Konto acc) Setzen eines komplexen Job-Parameters (Kontodaten).
void	setParam(String paramName, String value) Setzen eines Job-Parameters.
void	setParam(String paramname, Value v) Setzen eines komplexen Job-Parameters (Geldbetrag).
void	setSegVersion(String version) Legt die Versionsnummer des Segments manuell fest.
protected boolean	twoDigitValueInList(String value, String list)
void	verifyConstraints()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

jobResult

protected HBCIJobResultImpl jobResult

passport

protected HBCIPassport passport

Constructor Detail

HBCIJobImpl

protected HBCIJobImpl(HBCIPassport passport,
                      MsgGen gen,
                      String jobnameLL,
                      HBCIJobResultImpl jobResult)

Method Detail

getJobName

public String getJobName()

getHBCICode

public String getHBCICode()

setSegVersion

public void setSegVersion(String version)

Legt die Versionsnummer des Segments manuell fest. Ist u.a. noetig, um HKTAN-Segmente in genau der Version zu senden, in der auch die HITANS empfangen wurden. Andernfalls koennte es passieren, dass wir ein HKTAN mit einem TAN-Verfahren senden, welches in dieser HKTAN-Version gar nicht von der Bank unterstuetzt wird. Das ist ein Dirty-Hack, ich weiss ;) Falls das noch IRGENDWO anders verwendet wird, muss man hoellisch aufpassen, dass alle Stellen, wo "this.name" bzw. "this.segVersion" direkt oder indirekt verwendet wurde, ebenfalls beruecksichtigt werden.

Parameters:

version - die neue Versionsnummer.

getMaxNumberPerMsg

public int getMaxNumberPerMsg()

getMinSigs

public int getMinSigs()

getSecurityClass

public int getSecurityClass()

addConstraint

protected void addConstraint(String frontendName,
                             String destinationName,
                             String defValue,
                             int logFilterLevel)

addConstraint

protected void addConstraint(String frontendName,
                             String destinationName,
                             String defValue,
                             int logFilterLevel,
                             boolean indexed)

verifyConstraints

public void verifyConstraints()

createJobSegment

public SEG createJobSegment()

createJobSegment

public SEG createJobSegment(int segnum)

getJobParameterNames

public List<String> getJobParameterNames()

getJobResultNames

public List<String> getJobResultNames()

Description copied from interface: HBCIJob

Gibt alle möglichen Property-Namen für die Lowlevel-Rückgabedaten dieses Jobs zurück. Die Lowlevel-Rückgabedaten können mit HBCIJob.getJobResult() und HBCIJobResult.getResultData() ermittelt werden. Diese Methode verwendet intern HBCIHandler.getLowlevelJobResultNames(String).

Specified by:

getJobResultNames in interface HBCIJob

Returns:

Liste aller prinzipiell möglichen Property-Keys für die Lowlevel-Rückgabedaten dieses Jobs

getJobRestrictions

public Properties getJobRestrictions()

Description copied from interface: HBCIJob

Gibt für einen Job alle bekannten Einschränkungen zurück, die bei der Ausführung des jeweiligen Jobs zu beachten sind. Diese Daten werden aus den Bankparameterdaten des aktuellen Passports extrahiert. Sie können von einer HBCI-Anwendung benutzt werden, um gleich entsprechende Restriktionen bei der Eingabe von Geschäftsvorfalldaten zu erzwingen (z.B. die maximale Anzahl von Verwendungszweckzeilen, ob das Ändern von terminierten Überweisungen erlaubt ist usw.).

Die einzelnen Einträge des zurückgegebenen Properties-Objektes enthalten als Key die Bezeichnung einer Restriktion (z.B. "maxusage"), als Value wird der entsprechende Wert eingestellt. Die Bedeutung der einzelnen Restriktionen ist zur Zeit nur der HBCI-Spezifikation zu entnehmen. In späteren Programmversionen werden entsprechende Dokumentationen zur internen HBCI-Beschreibung hinzugefügt, so dass dafür eine Abfrageschnittstelle implementiert werden kann.

Diese Methode verwendet intern org.kapott.hbci.manager.HBCIHandler#getLowlevelJobRestrictions(String)

.

Specified by:

getJobRestrictions in interface HBCIJob

Returns:

Properties-Objekt mit den einzelnen Restriktionen

setParam

public void setParam(String paramname,
                     Konto acc)

Setzen eines komplexen Job-Parameters (Kontodaten). Einige Jobs benötigten Kontodaten als Parameter. Diese müssten auf "normalem" Wege durch drei Aufrufe von setParam(String, String) erzeugt werden (je einer für die Länderkennung, die Bankleitzahl und die Kontonummer). Durch Verwendung dieser Methode wird dieser Weg abgekürzt. Es wird ein Kontoobjekt übergeben, für welches die entsprechenden drei setParam(String,String)-Aufrufe automatisch erzeugt werden.

Specified by:

setParam in interface HBCIJob

Parameters:

paramname - die Basis der Parameter für die Kontodaten (für "my.country", "my.blz", "my.number" wäre das also "my")

acc - ein Konto-Objekt, aus welchem die zu setzenden Parameterdaten entnommen werden

setParam

public void setParam(String paramname,
                     Integer index,
                     Konto acc)

Specified by:

setParam in interface HBCIJob

See Also:

HBCIJob.setParam(java.lang.String, java.lang.Integer, org.kapott.hbci.structures.Konto)

setParam

public void setParam(String paramname,
                     Value v)

Setzen eines komplexen Job-Parameters (Geldbetrag). Einige Jobs benötigten Geldbeträge als Parameter. Diese müssten auf "normalem" Wege durch zwei Aufrufe von setParam(String, String) erzeugt werden (je einer für den Wert und die Währung). Durch Verwendung dieser Methode wird dieser Weg abgekürzt. Es wird ein Value-Objekt übergeben, für welches die entsprechenden zwei setParam(String,String)-Aufrufe automatisch erzeugt werden.

Specified by:

setParam in interface HBCIJob

Parameters:

paramname - die Basis der Parameter für die Geldbetragsdaten (für "btg.value" und "btg.curr" wäre das also "btg")

v - ein Value-Objekt, aus welchem die zu setzenden Parameterdaten entnommen werden

setParam

public void setParam(String paramname,
                     Integer index,
                     Value v)

Specified by:

setParam in interface HBCIJob

setParam

public void setParam(String paramName,
                     Date date)

Setzen eines Job-Parameters, bei dem ein Datums als Wert erwartet wird. Diese Methode dient als Wrapper für setParam(String, String), um das Datum in einen korrekt formatierten String umzuwandeln. Das "richtige" Datumsformat ist dabei abhängig vom aktuellen Locale.

Specified by:

setParam in interface HBCIJob

Parameters:

paramName - Name des zu setzenden Job-Parameters

date - Datum, welches als Wert für den Job-Parameter benutzt werden soll

setParam

public void setParam(String paramName,
                     Integer index,
                     Date date)

Specified by:

setParam in interface HBCIJob

setParam

public void setParam(String paramName,
                     int i)

Setzen eines Job-Parameters, bei dem ein Integer-Wert Da als Wert erwartet wird. Diese Methode dient nur als Wrapper für setParam(String, String).

Specified by:

setParam in interface HBCIJob

Parameters:

paramName - Name des zu setzenden Job-Parameters

i - Integer-Wert, der als Wert gesetzt werden soll

acceptsParam

protected boolean acceptsParam(String hlParamName)

setParam

public void setParam(String paramName,
                     String value)

Setzen eines Job-Parameters. Für alle Highlevel-Jobs ist in der Package-Beschreibung zum Package org.kapott.hbci.GV eine Auflistung aller Jobs und deren Parameter zu finden. Für alle Lowlevel-Jobs kann eine Liste aller Parameter entweder mit dem Tool ShowLowlevelGVs oder zur Laufzeit durch Aufruf der Methode HBCIHandler.getLowlevelJobParameterNames(String) ermittelt werden.

Bei Verwendung dieser oder einer der anderen setParam()-Methoden werden zusätzlich einige der Job-Restriktionen (siehe getJobRestrictions()) analysiert. Beim Verletzen einer der überprüften Einschränkungen wird eine Exception mit einer entsprechenden Meldung erzeugt. Diese Überprüfung findet allerdings nur bei Highlevel-Jobs statt.

Specified by:

setParam in interface HBCIJob

Parameters:

paramName - der Name des zu setzenden Parameters.

value - Wert, auf den der Parameter gesetzt werden soll

setParam

public void setParam(String paramName,
                     Integer index,
                     String value)

Setzen eines Job-Parameters. Für alle Highlevel-Jobs ist in der Package-Beschreibung zum Package org.kapott.hbci.GV eine Auflistung aller Jobs und deren Parameter zu finden. Für alle Lowlevel-Jobs kann eine Liste aller Parameter entweder mit dem Tool ShowLowlevelGVs oder zur Laufzeit durch Aufruf der Methode HBCIHandler.getLowlevelJobParameterNames(String) ermittelt werden.

Bei Verwendung dieser oder einer der anderen setParam()-Methoden werden zusätzlich einige der Job-Restriktionen (siehe getJobRestrictions()) analysiert. Beim Verletzen einer der überprüften Einschränkungen wird eine Exception mit einer entsprechenden Meldung erzeugt. Diese Überprüfung findet allerdings nur bei Highlevel-Jobs statt.

Specified by:

setParam in interface HBCIJob

Parameters:

paramName - der Name des zu setzenden Parameters.

index - Der index oder null, wenn kein Index gewünscht ist

value - Wert, auf den der Parameter gesetzt werden soll

setContinueOffset

public void setContinueOffset(int loop)

setLowlevelParam

protected void setLowlevelParam(String key,
                                String value)

getLowlevelParams

public Properties getLowlevelParams()

Description copied from interface: HBCIJob

Gibt alle für diesen Job gesetzten Parameter zurück. In dem zurückgegebenen Properties-Objekt sind werden die Parameter als Lowlevel-Parameter abgelegt. Außerdem hat jeder Lowlevel-Parametername zusätzlich ein Prefix, welches den Lowlevel-Job angibt, für den der Parameter gilt (also z.B. Ueb3.BTG.value

Specified by:

getLowlevelParams in interface HBCIJob

Returns:

aktuelle gesetzte Lowlevel-Parameter für diesen Job

setLowlevelParams

public void setLowlevelParams(Properties llParams)

getLowlevelParam

public String getLowlevelParam(String key)

setIdx

public void setIdx(int idx)

getName

public String getName()

Description copied from interface: HBCIJob

Gibt den internen Namen für diesen Job zurück.

Specified by:

getName in interface HBCIJob

Returns:

Job-Name, wie er intern von HBCI4Java verwendet wird.

getSegVersion

public String getSegVersion()

Description copied from interface: HBCIJob

Gibt die für diesen Job verwendete Segment-Versionsnummer zurück

Specified by:

getSegVersion in interface HBCIJob

needsContinue

public boolean needsContinue(int loop)

fillJobResult

public void fillJobResult(HBCIMsgStatus status,
                          int offset)

saveReturnValues

protected void saveReturnValues(HBCIMsgStatus status,
                                int sref)

extractResults

protected void extractResults(HBCIMsgStatus msgstatus,
                              String header,
                              int idx)

getJobResult

public HBCIJobResult getJobResult()

Description copied from interface: HBCIJob

Gibt ein Objekt mit den Rückgabedaten für diesen Job zurück. Das zurückgegebene Objekt enthält erst nach der Ausführung des Jobs gültige Daten.

Specified by:

getJobResult in interface HBCIJob

Returns:

ein Objekt mit den Rückgabedaten und Statusinformationen zu diesem Job

checkAccountCRC

protected void checkAccountCRC(String frontendname)

getChallengeParam

public String getChallengeParam(String path)

getOrderAccount

public Konto getOrderAccount()

Liefert das Auftraggeber-Konto, wie es ab HKTAN5 erforderlich ist.

Returns:

das Auftraggeber-Konto oder NULL, wenn keines angegeben ist.

getExternalId

public String getExternalId()

Description copied from interface: HBCIJob

Liefert eine optionalen Identifier, der von der Banking-Anwendung genutzt werden kann, um einen Bezug zum urspruenglichen Auftrag herstellen zu koennen.

Specified by:

getExternalId in interface HBCIJob

Returns:

der Identifier.

See Also:

HBCIJob.getExternalId()

setExternalId

public void setExternalId(String id)

Description copied from interface: HBCIJob

Kann von der Banking-Anwendung genutzt werden, um einen eigenen Identifier im Job zu speichern, um im spaeteren Verlauf des HBCI-Dialoges (z.Bsp. bei der TAN-Eingabe) einen Bezug zum urspruenglichen Auftrag wiederherstellen zu koennen.

Specified by:

setExternalId in interface HBCIJob

Parameters:

id - optionale ID.

See Also:

HBCIJob.setExternalId(java.lang.String)

twoDigitValueInList

protected boolean twoDigitValueInList(String value,
                                      String list)