public class DiffingConnectorDocumentList extends java.lang.Object implements DocumentList
DocumentList for the DiffingConnector.| Constructor and Description |
|---|
DiffingConnectorDocumentList(CheckpointAndChangeQueue queue,
java.lang.String checkpoint)
Creates a document list that returns a batch of documents from the provided
CheckpointAndChangeQueue. |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
checkpoint()
Provides a checkpoint that can be used to control traversal.
|
Document |
nextDocument()
Returns the next
Document in this document list, if there is one. |
public DiffingConnectorDocumentList(CheckpointAndChangeQueue queue, java.lang.String checkpoint) throws java.io.IOException
CheckpointAndChangeQueue.queue - a CheckpointAndChangeQueue containing document changescheckpoint - point into the change queue after which to start
returning documentsjava.io.IOException - if persisting failspublic java.lang.String checkpoint()
DocumentListTraversalManager.resumeTraversal(String).
If null is returned, then no new checkpoint will be saved,
and the existing checkpoint will be supplied to
TraversalManager.startTraversal() or
TraversalManager.resumeTraversal(String),
in effect, restarting the traversal from the last saved checkpoint.
checkpoint in interface DocumentListnull String that can be supplied
subsequently to TraversalManager.resumeTraversal(String)public Document nextDocument() throws RepositoryException
DocumentListDocument in this document list, if there is one.nextDocument in interface DocumentListnull
otherwiseRepositoryException - if a repository access error occurs
The Connector Manager will stop processing the
DocumentList, call DocumentList.checkpoint(), and wait
a short period of time before resuming traversal.RepositoryDocumentException - if this specific document
has unrecoverable errors. This document will be skipped,
and nextDocument() or DocumentList.checkpoint()
may be subsequently called.