cz.abclinuxu.datoveschranky.common.interfaces

Interface DataBoxMessagesService

public interface DataBoxMessagesService

Získání seznamu přijatých, odeslaných zpráv, ověření haše zprávy.

Author:

Vaclav Rosecky <xrosecky 'at' gmail 'dot' com>

Method Summary

Modifier and Type	Method and Description
DeliveryInfo	getDeliveryInfo(MessageEnvelope env) Vrátí doručenku pro danou obálku zprávy.
List<MessageEnvelope>	getListOfReceivedMessages(Date from, Date to, EnumSet<MessageState> state, int offset, int limit) Stáhne seznam přijatých zpráv ve formě obálky (identifikace odesílatele, příjemce, předmět zprávy, bez příloh) v daném časovém rozmezí.
List<MessageEnvelope>	getListOfSentMessages(Date from, Date to, EnumSet<MessageState> filter, int offset, int limit) Stáhne seznam odeslaných zpráv ve formě obálky (identifikace odesílatele, příjemce, předmět zprávy, bez příloh) v daném časovém rozmezí.
List<MessageStateChange>	GetMessageStateChanges(Date from, Date to) Stáhne změny stavu u odeslaných zpráv.
void	getSignedDeliveryInfo(MessageEnvelope envelope, OutputStream os) Stáhne doručenku zprávy ve formátu PKCS7 a uloží ji do výstupního proudu.
void	markMessageAsDownloaded(MessageEnvelope env) Označí danou zprávu jako přečtenou.
Hash	verifyMessage(MessageEnvelope envelope) Vrátí hodnotu haše dané zprávy, který je uložený v datové schránce.

Method Detail

getListOfReceivedMessages

List<MessageEnvelope> getListOfReceivedMessages(Date from,
                                                Date to,
                                                EnumSet<MessageState> state,
                                                int offset,
                                                int limit)

Stáhne seznam přijatých zpráv ve formě obálky (identifikace odesílatele, příjemce, předmět zprávy, bez příloh) v daném časovém rozmezí.

Parameters:

from - čas dodání do ISDS od

to - čas dodání do ISDS do

filter - filter na stav zpráv, null nebo prázdná množina vybere všechny zprávy, v opačném případě se vyberou zprávy se stavem, který je obsažen v množině filter.

offset - číslo první požadavané obálky (indexuje se od jedne!!!)

limit - počet vrácených obálek

Throws:

DataBoxException - při vracení seznamu nastala chyba

getListOfSentMessages

List<MessageEnvelope> getListOfSentMessages(Date from,
                                            Date to,
                                            EnumSet<MessageState> filter,
                                            int offset,
                                            int limit)

Stáhne seznam odeslaných zpráv ve formě obálky (identifikace odesílatele, příjemce, předmět zprávy, bez příloh) v daném časovém rozmezí.

Parameters:

from - čas dodání do ISDS od

to - čas dodání do ISDS do

filter - filter na stav zpráv, null nebo prázdná množina vybere všechny zprávy, v opačném případě se vyberou zprávy se stavem, který je obsažen v množině filter.

offset - číslo první požadavané obálky (indexuje se od jedne!!!)

limit - počet vrácených obálek

Throws:

DataBoxException - při vracení seznamu nastala chyba

verifyMessage

Hash verifyMessage(MessageEnvelope envelope)

Vrátí hodnotu haše dané zprávy, který je uložený v datové schránce. Tento haš lze pak použít pro porovnání s hašem zprávy, která je uložená na disku.

Parameters:

envelope - obálka zprávy u které chceme znát has

Throws:

DataBoxException

getDeliveryInfo

DeliveryInfo getDeliveryInfo(MessageEnvelope env)

Vrátí doručenku pro danou obálku zprávy.

markMessageAsDownloaded

void markMessageAsDownloaded(MessageEnvelope env)

Označí danou zprávu jako přečtenou.

getSignedDeliveryInfo

void getSignedDeliveryInfo(MessageEnvelope envelope,
                           OutputStream os)

Stáhne doručenku zprávy ve formátu PKCS7 a uloží ji do výstupního proudu. Tento formát je vhodný pro zálohování. PKCS7 je binární formát, žádné XML ani zfo soubor. Po odstranění podpisu je výsledek XML.

Parameters:

envelope - obálka zprávy, ke které má stáhnout přílohy

os - kam se má uložit

Throws:

DataBoxException

GetMessageStateChanges

List<MessageStateChange> GetMessageStateChanges(Date from,
                                                Date to)

Stáhne změny stavu u odeslaných zpráv.

Parameters:

from - od

to - do

Returns:

seznam změn