Interface ExtendedMessageConnector
- All Superinterfaces:
Iterable<ExtendedMessage>
,MessageConnector<ExtendedMessage>
This interface is an extension point to implement message retrieval
from different sources to the iAGENT system.
Implementations of the type ExtendedMessageConnector
have
to provide the externally retrieved messages as objects of the type
ExtendedMessage
A ExtendedMessage
contains a Message
and
stores additional information about the retrieved message.
- Since:
- 11.32
-
Method Summary
Modifier and TypeMethodDescriptioniterator()
As long as theExtendedMessageConnector
is active this method will be called periodically to retrieve messages from an external source.Methods inherited from interface java.lang.Iterable
forEach, spliterator
Methods inherited from interface com.novomind.ecom.api.imail.core.connector.MessageConnector
init, release, sendMessage
-
Method Details
-
iterator
MessageIterator<ExtendedMessage> iterator()As long as theExtendedMessageConnector
is active this method will be called periodically to retrieve messages from an external source. TheMessageIterator
may not be iterated until it's end. TheMessageIterator
has to implement theMessageIterator.remove()
method, that will be called to remove a message permanently from the source after being processed successfully. A message that has been removed, must not be retrieved again by anyMessageIterator
in the future. Finally theMessageIterator.close()
method will be called to indicate the end of the iteration and therefore the also the end of the iterator's life cycle. All further messages, that haven't been processed yet, will be processed during the next fetch period.- Specified by:
iterator
in interfaceIterable<ExtendedMessage>
- Specified by:
iterator
in interfaceMessageConnector<ExtendedMessage>
- Returns:
- a
MessageIterator
that allows to iterate the new messages waiting on the external source - Since:
- 11.32
-