Interface DocumentFetchRequest
- 
 public interface DocumentFetchRequestThis interface is implemented by the scanner. The scanner will queue an implementation of thisDocumentFetchRequestinterface for each document it wants to ingest. The connector framework will callgetDocument()concurrently for multipleDocumentFetchRequestobjects and publish the documents.
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description voidcancel()Cancel fetching if possible.DocumentAndAclgetDocument()Called by the framework to get the generated document.java.lang.Stringname()A name that identifies the document, typically a URL.voidpublished()This is called by the framework to let the fetcher know the document is published.voidsetContentStoreAccess(ContentStoreAccess contentStoreAccess)ContentStoreAccessis used by the fetcher to store content in the content store.
 
- 
- 
- 
Method Detail- 
setContentStoreAccessvoid setContentStoreAccess(ContentStoreAccess contentStoreAccess) ContentStoreAccessis used by the fetcher to store content in the content store.- Parameters:
- contentStoreAccess- the content store access set by the framework
 
 - 
getDocumentDocumentAndAcl getDocument() throws AttivioException Called by the framework to get the generated document. MultipleDocumentFetchRequestobjects will be queued by the scanner and their getDocument methods will be called concurrently by the framework's thread pool.- Returns:
- the generated document and optionally the generated ACL (null can be returned if the request was canceled)
- Throws:
- AttivioException- if document generation has failed
 
 - 
namejava.lang.String name() A name that identifies the document, typically a URL.- Returns:
- name
 
 - 
cancelvoid cancel() Cancel fetching if possible. This method should not block.This is called by the framework to cancel a pending requestthat has not completed.
 - 
publishedvoid published() This is called by the framework to let the fetcher know the document is published. It can be used, for example, to report IngestionHistoryApi that the document was published.
 
- 
 
-