hu.gov.nav.ebt.client.sdk.logic

Interface ClientStorage

All Known Implementing Classes:

ClientStorageImplDb

public interface ClientStorage

Ügyfél oldalon a EbtTransfer folyamatai által kezelt üzenetek tárolását és betöltését biztosítja.

Egy-egy példánya egy adott felhasználó több csatornájához tartozó üzenetforgalom tárolásáért felel.

A tároló, betöltő metódusok a messageIDRaw azonosítót használják kulcsként a mentésnél és betöltésnél, ami kisbetű-nagybetű érzéketlen, tehát a 2164c6b9-c4a1-45aa-a518-4d868bf03bc7 érték és a 2164C6B9-C4A1-45AA-A518-4D868BF03BC7 ugyanazt jelenti.

Autonóm tranzakcióban futtatott műveletek esetén amennyiben a metadatokat tranzakcionális adatbázisban tárolják, a BLOB adatokat pedig nem tranzakcionális tárhelyen, akkor mentésnél először a nem tranzakcionális tárhelyre kell letárolni az üzenetet, és utána kell tranzakcionális adatbázisba menteni.

Figyelem! A BusinessDataContainer, DownloadedSegmentContainer, EnvelopeContainer típusú paraméterekben levő DataSource típusú adattagok fájlrendszeren tárolt ideiglenes fájlokra hivatkoznak. A DataSource típus getInputStream() és DataSource típus getOutputStream() metódusával elkért stream példányokat a használat után be kell zárni az IOUtils.closeQuietly() metódussal (célszerűen egy try-finally blokkban), mert különben az SDK nem tudja törölni az ideiglenes fájlokat.

Method Summary

Modifier and Type	Method and Description
void	clientStorageTest() Kapcsolati teszt.
List<String>	listDownloadedMessageIds(String channelName) Fel nem dolgozott letöltött üzenetek azonosítóinak listázása időrend szerint.
DownloadedSegmentContainer[]	listDownloadedSegments(String orderTag, String channelName) Összetartozó letöltött, titkosítatlan, fel nem dolgozott üzenetdarabok listázása.
List<String>	listUploadableBusinessMessageIds(String channelName) Feltöltésre előkészítendő szakmai üzenetek azonosítóinak listázása időrend szerint.
List<String>	listUploadableEnvelopedMessageIds(String channelName) Feltöltendő üzenetek azonosítóinak listázása időrend szerint.
UploadedEnvelopedMessageReceiptStatus[]	listUploadedEnvelopedMessageReceiptStatuses(String orderTag, SdkConstants.NAV_RECEIPT_TYPE navReceiptType, String channelName) Feltöltött borítékolt üzenetdarabokra érkezett KKK2 nyugtaüzenetek (NAVReceipt) listázása.
EnvelopeContainer	loadDownloadedEnvelopedMessage(String messageIDRaw) Letöltött borítékolt üzenet betöltése.
DownloadedSegmentContainer	loadDownloadedSegment(String messageIDRaw, String channelName) Letöltött, titkosítatlan, fel nem dolgozott üzenetdarab betöltése.
BusinessDataContainer	loadUploadableBusinessMessage(String messageIDRaw) Feltöltésre előkészítendő szakmai üzenet betöltése.
EnvelopeContainer	loadUploadableEnvelopedMessage(String messageIDRaw) Feltöltendő borítékolt üzenet betöltése.
EnvelopeContainer	loadUploadedEnvelopedMessage(String messageIDRaw) Feltöltött borítékolt üzenet betöltése.
void	saveDownloadedCertificates(String channelName, SdkConstants.CERT_REQUEST_TYPE type, List<Collection<X509Certificate>> certificates) Letöltött NAV tanúsítvány lista mentése diagnosztikai célból.
void	saveDownloadedEnvelopedMessage(EnvelopeContainer envelopeContainer) Letöltött borítékolt üzenet mentése.
void	saveDownloadedSegment(DownloadedSegmentContainer downloadedSegmentContainer) Letöltött, titkosítatlan, fel nem dolgozott üzenetdarab mentése.
void	saveUploadableBusinessMessage(BusinessDataContainer businessDataContainer) Feltöltésre előkészítendő szakmai üzenet mentése.
void	saveUploadableEnvelopedMessage(EnvelopeContainer envelopeContainer) Feltöltendő borítékolt üzenet mentése.
void	saveUploadedEnvelopedMessage(EnvelopeContainer envelopeContainer) Feltöltött borítékolt üzenet mentése.
void	setDownloadedEnvelopedMessageHeader(String messageIDRaw, VPEnvelopeHeader header, SegmentHeader segmentHeader) Fel nem dolgozott letöltött üzenet fejléc információinak mentése.
void	setDownloadedMessageProcessed(String messageIDRaw, boolean success, MessageException messageException) Fel nem dolgozott letöltött üzenet feldolgozott állapotba állítása.
void	setDownloadedSegmentProcessed(String orderTag, boolean success, MessageException messageException) Letöltött, titkosítatlan üzenetdarabok feldolgozásának jelzése.
void	setUploadableBusinessMessageProcessed(String messageIDRaw, boolean success, MessageException messageException) Feltöltésre előkészítendő szakmai üzenet feldolgozott állapotba állítása.
void	setUploadableEnvelopedMessageProcessed(String messageIDRaw, boolean success, MessageException messageException) Feltöltendő üzenet feldolgozott állapotba állítása.
void	setUploadedEnvelopedMessageReceiptStatus(String messageIDRaw, SdkConstants.NAV_RECEIPT_TYPE navReceiptType, String receiptmessageIDRaw) Feltöltött borítékolt üzenetet nyugtázási állapotának mentése.

Method Detail

saveDownloadedEnvelopedMessage

void saveDownloadedEnvelopedMessage(EnvelopeContainer envelopeContainer)

Letöltött borítékolt üzenet mentése.

Az SDK EbtTransfer.download folyamata a letöltött üzenet mentését kéri a helyi tárhelye. A mentendő üzenet azonosítója a messageIDRaw mezőben található. Ha az üzenet már létezik a megadott azonosítóval, akkor nem kell az üzenetet elmenteni, mivel valószínűleg hálózati hiba miatt töltötte le újra a kliens.

A mentés a listDownloadedMessageIds metódus által visszaadott fel nem dolgozott letöltött üzenetek azonosítói listát is bővíti a mentett üzenet azonosítójával.

Tranzakció: Required.

Parameters:

envelopeContainer - Menteni kívánt üzenet.

Megadott EnvelopeContainer adatok:

• MessageIDRaw: Borítékolt üzenet azonosítója az "uuid:" prefix nélkül.
• ContentStream: Borítékolt XML tartalom bináris formátumban (BLOB)
• Created: Az üzenet létrehozásának időpontja
• ChannelName: Az üzenet csatornája

Throws:

ClientInternalException - Egyéb hiba esetén

loadDownloadedEnvelopedMessage

EnvelopeContainer loadDownloadedEnvelopedMessage(String messageIDRaw)

Letöltött borítékolt üzenet betöltése.

Az SDK EbtTransfer.processDownloaded folyamata a letöltött üzenet betöltését kéri a helyi tárhelyről.

Tranzakció: Mandatory.

Parameters:

messageIDRaw - A betöltendő üzenet azonosítója

Returns:

A betöltött borítékolt üzenet

A betöltésnél megadandó EnvelopeContainer adatok:

• MessageIDRaw: Borítékolt üzenet azonosítója az "uuid:" prefix nélkül.
• ContentStream: Borítékolt XML tartalom bináris formátumban (BLOB)
• Created: Az üzenet létrehozásának időpontja
• ChannelName: Az üzenet csatornája

Throws:

ClientInternalException - Egyéb hiba esetén

listDownloadedMessageIds

List<String> listDownloadedMessageIds(String channelName)

Fel nem dolgozott letöltött üzenetek azonosítóinak listázása időrend szerint.

A listát a channelName alapján kell szűrni.

Tranzakció: Mandatory.

Az SDK nem használja a metódust, egyedül az ügyfél oldali ClientExample megvalósítás használja, amitől az ügyfél eltérhet.

Parameters:

channelName - Csatorna neve

Returns:

Fel nem dolgozott üzenetek azonosítóit tartalmazó lista

Throws:

ClientInternalException - Egyéb hiba esetén

setDownloadedMessageProcessed

void setDownloadedMessageProcessed(String messageIDRaw,
                                   boolean success,
                                   MessageException messageException)

Fel nem dolgozott letöltött üzenet feldolgozott állapotba állítása.

A letöltött üzenet feldolgozása után az üzenet kivehető feldolgozási listából.

Tranzakció: Mandatory.

Az SDK nem használja a metódust, egyedül az ügyfél oldali ClientExample megvalósítás használja, amitől az ügyfél eltérhet.

Sikertelen üzenet feldolgozás (pl. sikertelen kititkosítás, sikertelen aláírás ellenőrzés) esetén a success, messageException tulajdonságok alapján leválogatható, hogy mely üzenetekkel volt gond, és amennyiben szükséges, az állapotuk manuálisan fel nem dolgozottra állítható.

Parameters:

messageIDRaw - A feldolgozott letöltött üzenet azonosítója

success - Sikeres volt-e a feldolgozás?

messageException - Feldolgozás közben keletkezett üzenet hiba (opcionális, ha success == false, akkor lehet megadva).

Throws:

ClientInternalException - Egyéb hiba esetén

setDownloadedEnvelopedMessageHeader

void setDownloadedEnvelopedMessageHeader(String messageIDRaw,
                                         VPEnvelopeHeader header,
                                         SegmentHeader segmentHeader)

Fel nem dolgozott letöltött üzenet fejléc információinak mentése.

A letöltött üzenet feldolgozása során kiolvasott fejléc információkat visssza lehet menteni az üzenethez. Az információ a későbbiekben nincs felhasználva, a nyomon követhetőség érdekében érdemes tárolni.

Tranzakció: Mandatory.

Parameters:

messageIDRaw - A feldolgozott letöltött üzenet azonosítója

header - Boríték fejléc adatok

segmentHeader - Üzenet szegmens fejléc adatok

Throws:

ClientInternalException - Egyéb hiba esetén

saveDownloadedSegment

void saveDownloadedSegment(DownloadedSegmentContainer downloadedSegmentContainer)

Letöltött, titkosítatlan, fel nem dolgozott üzenetdarab mentése.

Az SDK EbtTransfer.processDownloaded folyamata darabolt üzenet érkezése esetén a letöltött titkosítatlan üzenetdarab üzenet mentését kéri a helyi tárhelye. A mentendő üzenet azonosítója a messageIDRaw mezőben található. Ha az üzenet már létezik a megadott azonosítóval, akkor nem kell az üzenetet elmenteni, mivel valószínűleg hálózati hiba miatt töltötte le újra a kliens. Ha van már ilyen üzenetdarab SegmentHeader.OrderTag és SegmentHeader.Ordinal értékkel, de MÁS messageIDRaw üzenet azonosítóval, akkor ClientMessageException-t kell dobnia client_storage.duplicated_message_ordertag hibakóddal, mivel ugyazt az üzenetdarab összetett kulcsot egy másik darab is megkapta.

Tranzakció: Mandatory.

Parameters:

downloadedSegmentContainer - A letöltött, titkosítatlan üzenetdarab

Throws:

ClientMessageException - Ha ugyazt az üzenetdarab összetett kulcsot egy másik darab is megkapta

ClientInternalException - Egyéb hiba esetén

loadDownloadedSegment

DownloadedSegmentContainer loadDownloadedSegment(String messageIDRaw,
                                                 String channelName)

Letöltött, titkosítatlan, fel nem dolgozott üzenetdarab betöltése.

Az SDK EbtTransfer.processDownloaded folyamata darabolt üzenet összeállításához a titkosítatlan üzenetdarab betöltését kéri a helyi tárhelyről.

Tranzakció: Mandatory.

Parameters:

messageIDRaw - A letöltött, titkosítatlan üzenetdarab azonosítója

channelName - Csatorna neve

Returns:

A letöltött, titkosítatlan üzenetdarab

Minden adattagját fel kell tölteni

Throws:

ClientInternalException - Egyéb hiba esetén

listDownloadedSegments

DownloadedSegmentContainer[] listDownloadedSegments(String orderTag,
                                                    String channelName)

Összetartozó letöltött, titkosítatlan, fel nem dolgozott üzenetdarabok listázása.

Az SDK EbtTransfer.processDownloaded folyamata darabolt üzenet összeállításához a letöltött titkosítatlan üzenetdarabok listáját kéri helyi tárhelyről. A listát az orderTag és a channelName alapján kell szűrni.

Tranzakció: Mandatory.

Parameters:

orderTag - Az összetartozó darabok közös azonosítója

channelName - Csatorna neve

Returns:

A letöltött, titkosítatlan üzenetdarabok listája

Kitöltendő DownloadedSegmentContainer adatok:

• MessageIDRaw: Borítékolt üzenet azonosítója az "uuid:" prefix nélkül.
• VPEnvelopeHeader: Boríték címzési adatok.
• SegmentHeader: Üzenetdarab adatok

Throws:

ClientInternalException - Egyéb hiba esetén

setDownloadedSegmentProcessed

void setDownloadedSegmentProcessed(String orderTag,
                                   boolean success,
                                   MessageException messageException)

Letöltött, titkosítatlan üzenetdarabok feldolgozásának jelzése.

Az SDK EbtTransfer.processDownloaded folyamata titkosítatlan üzenetdarabok feldolgozását jelzi az összetartozó darabok közös azonosítójávaval.

Tranzakció: Mandatory.

Parameters:

orderTag - Az összetartozó darabok közös azonosítója

success - Sikeres volt-e a feldolgozás?

messageException - Feldolgozás közben keletkezett üzenet hiba (opcionális, ha success == false, akkor lehet megadva).

Throws:

ClientInternalException - Egyéb hiba esetén

saveUploadableBusinessMessage

void saveUploadableBusinessMessage(BusinessDataContainer businessDataContainer)

Feltöltésre előkészítendő szakmai üzenet mentése.

A szakmai rendszer vagy az SDK EbtTransfer.processDownloaded folyamata ezen a metóduson kereszül indítja el szakmai (borítékolatnal, nyers) üzenetet a KKK2 felé. Ha az üzenet már létezik a megadott azonosítóval, akkor ClientMessageException-t kell dobnia client_storage.duplicated_message hibakóddal, mivel ugyazzal az azonosítóval nem küldhet kétszer üzenetet.

A mentés a listUploadableBusinessMessageIds metódus által visszaadott feltöltésre előkészítendő szakmai üzenetek azonosítói listát is bővíti a mentett üzenet azonosítójával.

Ha a szakmai rendszer küldi az üzenetet, akkor a boríték fejlécben szereplő messageIDRaw értékét neki kell generálnia, és el kell mentenie, hogy a később visszaérkező válaszokat kötni tudja a kiküldött üzenethet.

Ha az üzenet nem jutott el sikeresen a NAV szakmai rendszeréig, mert a feltöltés során a szerver elutasította a feltöltést egy üzleti hibával, vagy később a szakmai rendszer utasította el VPFault válasszal jogosultsági hiba, kititkosítási hiba, vagy aláírás ellenőrzési hiba miatt az üzenetet, akkor az ügyfélnek a hiba elhárítása után újra kell küldenie a szakmai üzenetet a szakmai rendszerből egy új messageIDRaw azonosítóval. A szakmai rendszer CSAK akkor lehet biztos, hogy az üzenete célba ért, ha a tértivevényt visszakapta a feldolgozásról.

Tranzakció: Mandatory.

Parameters:

businessDataContainer - A küldendő szakmai üzenet adatai

Mentendő BusinessDataContainer adatok:

• VPEnvelopeHeader: Boríték címzési adatok
• BusinessMessageStream: Szakmai üzenet (boríték nélkül)
• Attachments: Szakmai üzenethez tartozó csatolmányok (opcionális)
• ChannelName: Csatorna neve. (Megegyezik a boríték címzési adatoknál megadott To mezővel)

Kitöltött VPEnvelopeHeader adatok:

• messageIDRaw: Generált UUID azonosító (http://www.ietf.org/rfc/rfc4122.txt)
• relatesToRaw: Hivatkozott üzenet UUID azonosítója (amennyiben hivatkozik egy előzményre)
• messageType: Üzenet típusa. pl.: http://schemas.nav.gov.hu/EBT/VHR/1.0#VegrehajtasiValaszok
• to: címzett csatorna. pl.: http://nav.gov.hu/EBT/VHR

Throws:

ClientMessageException - Duplikált üzenet esetén

ClientInternalException - Egyéb hiba esetén

loadUploadableBusinessMessage

BusinessDataContainer loadUploadableBusinessMessage(String messageIDRaw)

Feltöltésre előkészítendő szakmai üzenet betöltése.

Az SDK EbtTransfer.prepareForUpload folyamata a feltöltendő üzenet betöltését kéri a helyi tárhelyről.

Tranzakció: Mandatory.

Parameters:

messageIDRaw - A betöltendő üzenet azonosítója

Returns:

Szakmai üzenet konténer

A betöltésnél megadandó BusinessDataContainer adatok:

• VPEnvelopeHeader: Boríték címzési adatok
• BusinessMessageStream: Szakmai üzenet (boríték nélkül)
• Attachments: Szakmai üzenethez tartozó csatolmányok (opcionális)
• ChannelName: Csatorna neve. (Megegyezik a boríték címzési adatoknál mmegadott To mezővel)

Throws:

ClientInternalException - Egyéb hiba esetén

listUploadableBusinessMessageIds

List<String> listUploadableBusinessMessageIds(String channelName)

Feltöltésre előkészítendő szakmai üzenetek azonosítóinak listázása időrend szerint.

A listát a channelName alapján kell szűrni.

Tranzakció: Required.

Az SDK nem használja a metódust, egyedül az ügyfél oldali ClientExample megvalósítás használja, amitől az ügyfél eltérhet.

Parameters:

channelName - Csatorna neve

Returns:

Feltöltésre előkészítendő szakmai üzenetek azonosítóit tartalmazó lista

Throws:

ClientInternalException - Egyéb hiba esetén

setUploadableBusinessMessageProcessed

void setUploadableBusinessMessageProcessed(String messageIDRaw,
                                           boolean success,
                                           MessageException messageException)

Feltöltésre előkészítendő szakmai üzenet feldolgozott állapotba állítása.

A feltöltendő üzenet előkészítése után az üzenet kivehető feldolgozási listából.

Tranzakció: Mandatory.

Az SDK nem használja a metódust, egyedül az ügyfél oldali ClientExample megvalósítás használja, amitől az ügyfél eltérhet.

Sikertelen üzenet feldolgozás esetén a success, messageException tulajdonságok alapján leválogatható, hogy mely üzenetekkel volt gond, és amennyiben szükséges, az állapotuk manuálisan fel nem dolgozottra állítható, vagy a szakmai rendszerből új üzenet azonosítóval újra küldhetőek.

Parameters:

messageIDRaw - A feldolgozott előkészített üzenet azonosítója

success - Sikeres volt-e a feldolgozás?

messageException - Feldolgozás közben keletkezett üzenet hiba (opcionális, ha success == false, akkor lehet megadva).

Throws:

ClientInternalException - Egyéb hiba esetén

saveUploadableEnvelopedMessage

void saveUploadableEnvelopedMessage(EnvelopeContainer envelopeContainer)

Feltöltendő borítékolt üzenet mentése.

Az SDK prepareForUpload folyamata a feltöltendő üzenet mentését kéri a helyi tárhelye. A mentendő üzenet azonosítója a messageIDRaw mezőben található. Ha az üzenet már létezik a megadott azonosítóval, akkor ClientMessageException-t kell dobnia client_storage.duplicated_message hibakóddal, mivel ugyazzal az azonosítóval nem küldhet kétszer üzenetet.

A mentés a listUploadableEnvelopedMessageIds metódus által visszaadott Feltöltendő üzenetek azonosítói listát is bővíti a mentett üzenet azonosítójával.

Tranzakció: Mandatory.

Parameters:

envelopeContainer - Menteni kívánt üzenet.

Megadott EnvelopeContainer adatok:

• MessageIDRaw: Borítékolt üzenet azonosítója az "uuid:" prefix nélkül.
• ContentStream: Borítékolt XML tartalom bináris formátumban (BLOB)
• Created: Az üzenet létrehozásának időpontja
• ChannelName: Csatorna neve
• VPEnvelopeHeader: Boríték címzési adatok
• SegmentHeader: Üzenetdarab adatok

Throws:

ClientMessageException - Duplikált üzenet esetén

ClientInternalException - Egyéb hiba esetén

loadUploadableEnvelopedMessage

EnvelopeContainer loadUploadableEnvelopedMessage(String messageIDRaw)

Feltöltendő borítékolt üzenet betöltése.

Az SDK EbtTransfer.upload folyamat a feltöltendő üzenet betöltését kéri a helyi tárhelyről.

Tranzakció: Required.

Parameters:

messageIDRaw -

Returns:

borítékolt üzenet konténer

Kitöltendő EnvelopeContainer adatok:

• MessageIDRaw: Borítékolt üzenet azonosítója az "uuid:" prefix nélkül.
• ContentStream: Borítékolt XML tartalom bináris formátumban (BLOB)
• Created: Az üzenet létrehozásának időpontja
• ChannelName: Csatorna neve
• VPEnvelopeHeader: Boríték címzési adatok
• SegmentHeader: Üzenetdarab adatok

Throws:

ClientInternalException - Egyéb hiba esetén

listUploadableEnvelopedMessageIds

List<String> listUploadableEnvelopedMessageIds(String channelName)

Feltöltendő üzenetek azonosítóinak listázása időrend szerint.

A listát a channelName alapján kell szűrni.

Tranzakció: Required.

Az SDK nem használja a metódust, egyedül az ügyfél oldali ClientExample megvalósítás használja, amitől az ügyfél eltérhet.

Parameters:

channelName - Csatorna neve

Returns:

Feltöltendő üzenetek azonosítóit tartalmazó lista

Throws:

ClientInternalException - Egyéb hiba esetén

setUploadableEnvelopedMessageProcessed

void setUploadableEnvelopedMessageProcessed(String messageIDRaw,
                                            boolean success,
                                            MessageException messageException)

Feltöltendő üzenet feldolgozott állapotba állítása.

A feltöltendő üzenet feltöltése után az üzenet kivehető feldolgozási listából.

Tranzakció: Required.

Az SDK nem használja a metódust, egyedül az ügyfél oldali ClientExample megvalósítás használja, amitől az ügyfél eltérhet.

Sikertelen üzenet feldolgozás esetén a success, messageException tulajdonságok alapján leválogatható, hogy mely üzenetekkel volt gond, és amennyiben szükséges, az állapotuk manuálisan fel nem dolgozottra állítható, vagy a szakmai rendszerből új üzenet azonosítóval újra küldhetőek.

Parameters:

messageIDRaw - A feltöltött üzenet azonosítója

success - Sikeres volt-e a feldolgozás?

messageException - Feldolgozás közben keletkezett üzenet hiba (opcionális, ha success == false, akkor lehet megadva).

Throws:

ClientInternalException - Egyéb hiba esetén

saveUploadedEnvelopedMessage

void saveUploadedEnvelopedMessage(EnvelopeContainer envelopeContainer)

Feltöltött borítékolt üzenet mentése.

Az SDK EbtTransfer.uploadvagy az EbtTransfer.download folyamata a feltöltött üzenet mentését kéri a helyi tárhelye. A mentendő üzenet azonosítója a messageIDRaw mezőben található. Ha az üzenet már létezik a megadott azonosítóval, akkor nem kell elmenteni.

Tranzakció: Required.

Parameters:

envelopeContainer - borítékolt üzenet konténer

Megadott EnvelopeContainer adatok:

• MessageIDRaw: Borítékolt üzenet azonosítója az "uuid:" prefix nélkül.
• ContentStream: Borítékolt XML tartalom bináris formátumban (BLOB)
• Created: Az üzenet létrehozásának időpontja
• ChannelName: Csatorna neve
• VPEnvelopeHeader: Boríték címzési adatok
• SegmentHeader: Üzenetdarab adatok

Throws:

ClientInternalException - Egyéb hiba esetén

setUploadedEnvelopedMessageReceiptStatus

void setUploadedEnvelopedMessageReceiptStatus(String messageIDRaw,
                                              SdkConstants.NAV_RECEIPT_TYPE navReceiptType,
                                              String receiptmessageIDRaw)

Feltöltött borítékolt üzenetet nyugtázási állapotának mentése.

Amikor sikeresen feldolgozta a letöltött KKK2 nyugtaüzenet (NAVReceipt) az SDK EbtTransfer.processDownloaded folyamata a feltöltött üzenetre vonatkozóan, akkor el kell menteni a megadott típusú nyugta megérkezésének tényét a feltöltött borítékolt üzenethez.

Ha az üzenet nem létezik a megadott azonosítóval, akkor ClientMessageException-t kell dobnia client_storage.message_not_found hibakóddal, mivel az előzmény nem létezik.

A funkcióra a következők miatt van szükség: ha a feltöltött üzenetet darabolni kell a feltöltésnél, akkor a feltöltés után válaszul érkező nyugtákról csak akkor értesíthető az ügyfél szakmai rendszere, ha minden üzenetdarabra válaszul megérkezett az adott típusú nyugta. Emiatt a feltöltött üzenetdarabokhoz kapcsodóan tárolni kell a nyugtázás tényét.

Tranzakció: Mandatory.

Parameters:

messageIDRaw - A feltöltöttt borítékolt üzenet azonosítója

navReceiptType - A feltöltött üzenetre érkezett nyugta típusa

receiptmessageIDRaw - A feltöltött üzenetre érkezett nyugta azonosítója

Throws:

ClientMessageException - Ha a keresett üzenet nem található

ClientInternalException - Egyéb hiba esetén

listUploadedEnvelopedMessageReceiptStatuses

UploadedEnvelopedMessageReceiptStatus[] listUploadedEnvelopedMessageReceiptStatuses(String orderTag,
                                                                                    SdkConstants.NAV_RECEIPT_TYPE navReceiptType,
                                                                                    String channelName)

Feltöltött borítékolt üzenetdarabokra érkezett KKK2 nyugtaüzenetek (NAVReceipt) listázása.

Az SDK EbtTransfer.processDownloaded folyamata a daraboltan feltöltött üzenetre válaszul érkező KKK2 nyugtaüzenetről (NAVReceipt) csak akkor értesíti a szakmai rendszert, ha minden feltöltött üzenetdarabra vonatkozóan megérkezett a nyugta. Ennek megállapításához a sikeresen feltöltött üzenetdarabok listáját kéri helyi tárhelyről. A listát az orderTag, a channelName és a navReceiptType alapján kell szűrni. A feltöltött üzenetdarabokra vonatkozó nyugtázási információt a ClientStorage.setUploadedEnvelopedMessageReceiptStatus adta át.

Tranzakció: Mandatory.

Parameters:

orderTag - Az összetartozó, sikeresen feltöltött üzenetdarabok közös azonosítója

navReceiptType - Az üzenetdarabokra vonatkozóan kért nyugta típusa

channelName - Csatorna neve

Returns:

A sikeresen feltöltött üzenetdarabok és nyugtázásainak listája

Throws:

ClientInternalException - Egyéb hiba esetén

loadUploadedEnvelopedMessage

EnvelopeContainer loadUploadedEnvelopedMessage(String messageIDRaw)

Feltöltött borítékolt üzenet betöltése.

Az SDK EbtTransfer.processDownloaded folyamata korábban feltöltött borítékolt üzenet betöltését kéri a helyi tárhelyről. A folyamat a KKK2 nyugtaüzenet (NAVReceipt) feldolgozásakor ellenőrzi, hogy a nyugtában (tértivevény, feladóvevény) szereplő HASH kód értéke megegyezik-e az előzmény feltöltött borítékolt üzenetre kiszámolt HASH értékkel. Ha az üzenet nem létezik a megadott azonosítóval, akkor ClientMessageException-t kell dobnia client_storage.message_not_found hibakóddal, mivel az előzmény nem létezik, és a hívó folyamatnál a vizsgált KKK2 nyugtaüzenetet nem lehet ellenőrizni.

Tranzakció: Mandatory.

Parameters:

messageIDRaw - A betöltendő üzenet azonosítója

Returns:

Szakmai üzenet konténer

Kitöltendő EnvelopeContainer adatok:

• MessageIDRaw: Borítékolt üzenet azonosítója az "uuid:" prefix nélkül.
• ContentStream: Borítékolt XML tartalom bináris formátumban (BLOB)
• Created: Az üzenet létrehozásának időpontja
• ChannelName: Csatorna neve
• VPEnvelopeHeader: Boríték címzési adatok
• SegmentHeader: Üzenetdarab adatok

Throws:

ClientMessageException - Ha a keresett üzenet nem található

ClientInternalException - Egyéb hiba esetén

saveDownloadedCertificates

void saveDownloadedCertificates(String channelName,
                                SdkConstants.CERT_REQUEST_TYPE type,
                                List<Collection<X509Certificate>> certificates)

Letöltött NAV tanúsítvány lista mentése diagnosztikai célból.

Az SDK EbtTransfer.downloadCertificates folyamata használja, ami diagnosztikai célból lett létrehozva.

Tranzakció: Required.

Parameters:

channelName - A csatorna technikai neve, amelyhez a tanúsítványok tartoznak

type - Tanúsítványok típusa

certificates - Letöltött NAV tanúsítványok

Throws:

ClientInternalException - Egyéb hiba esetén

clientStorageTest

void clientStorageTest()

Kapcsolati teszt.

A teszt ellenőrzi, hogy az adatbázishoz való kapcsolódás sikerül-e.

Tranzakció: Required.

*

Throws:

ClientInternalException - Egyéb hiba esetén