Interface SimpleMessageConnector
- All Superinterfaces:
Iterable<SimpleMessage>
,MessageConnector<SimpleMessage>
This interface is an extension point to implement message retrieval
from different source to the iAGENT system.
Implementations of the type SimpleMessageConnector
have to
provide the externally retrieved messages as objects of the type
SimpleMessage
- Since:
- 10.0.46
-
Method Summary
Modifier and TypeMethodDescriptioniterator()
As long as theSimpleMessageConnector
is running 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<SimpleMessage> iterator()As long as theSimpleMessageConnector
is running 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. Finally theMessageIterator.close()
method will be called to indicate the end of the iteration and therefore also the end of the iterator's life cycle. All further mails, that haven't been processed yet, will be processed during the next fetch period.- Specified by:
iterator
in interfaceIterable<SimpleMessage>
- Specified by:
iterator
in interfaceMessageConnector<SimpleMessage>
- Returns:
- a
MessageIterator
that allows to iterate the new mails waiting on the external source - Since:
- 10.0.46
-