de.galan.dmsexchange.exchange

Interface DmsReader

All Known Implementing Classes:

DefaultDmsReader

public interface DmsReader

Contract for an export-archive importer. Reading an export-archive consists of two simple steps:

• Create the desired implementation, preferably using the DmsExchange factory methods
• Create and register a listener - or - provide a consumer (which registers a subscriber in the background)
• Call the readDocuments() methods

Potential event subscriber consumer either Documents or DocumentReadInvalidEvent (in case of beeing unable to read content from an export-archive). Take a look at the WrappingDocumentConsumer for an example how to implement an event subscriber.

Author:

daniel

Method Summary

Modifier and Type	Method and Description
void	readDocuments() Starts reading the provided export-archive and fires the appropiate events. Potential event subscriber consumer either Documents or DocumentReadInvalidEvent (in case of beeing unable to read content from an export-archive).
void	readDocuments(Consumer<Document> consumer) Starts reading the provided export-archive and calls the consumer for every successful Document that is read.
void	registerSubscriber(Object... subscriber) Registers an event subscriber. Potential event subscriber consumer either Documents or DocumentReadInvalidEvent (in case of beeing unable to read content from an export-archive).

Method Detail

readDocuments

void readDocuments()
            throws DmsExchangeException

Starts reading the provided export-archive and fires the appropiate events.

Potential event subscriber consumer either Documents or DocumentReadInvalidEvent (in case of beeing unable to read content from an export-archive). Take a look at the WrappingDocumentConsumer for an example how to implement an event subscriber.

Throws:

DmsExchangeException - Encapsulating parent Exception for erroneous behaviour

readDocuments

void readDocuments(Consumer<Document> consumer)
            throws DmsExchangeException

Starts reading the provided export-archive and calls the consumer for every successful Document that is read.

Throws:

DmsExchangeException - Encapsulating parent Exception for erroneous behaviour

registerSubscriber

void registerSubscriber(Object... subscriber)

Registers an event subscriber.

Potential event subscriber consumer either Documents or DocumentReadInvalidEvent (in case of beeing unable to read content from an export-archive). Take a look at the WrappingDocumentConsumer for an example how to implement an event subscriber.

Parameters:

subscriber - An event subscriber that is registered to the (Guava) EventBus