org.apache.manifoldcf.agents.interfaces

Interface IOutputAddActivity

All Superinterfaces:

IOutputCheckActivity, IOutputHistoryActivity, IOutputQualifyActivity

All Known Subinterfaces:

IOutputActivity

All Known Implementing Classes:

IncrementalIngester.MonitoredAddActivityWrapper, IncrementalIngester.OutputActivitiesWrapper, IncrementalIngester.OutputAddActivitiesWrapper, IncrementalIngester.PipelineAddFanout, WorkerThread.OutputActivity

public interface IOutputAddActivity
extends IOutputQualifyActivity, IOutputHistoryActivity, IOutputCheckActivity

This interface abstracts from the activities that an output connector can do when adding or replacing documents.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid

Fields inherited from interface org.apache.manifoldcf.agents.interfaces.IOutputHistoryActivity

CREATED_DIRECTORY, EXCEPTION, EXCLUDED_CONTENT, EXCLUDED_DATE, EXCLUDED_LENGTH, EXCLUDED_MIMETYPE, EXCLUDED_URL, HTTP_ERROR, IOEXCEPTION, UNKNOWN_SECURITY

Method Summary

Modifier and Type	Method and Description
void	noDocument() Send NO document via the pipeline to the next output connection.
int	sendDocument(java.lang.String documentURI, RepositoryDocument document) Send a document via the pipeline to the next output connection.

Methods inherited from interface org.apache.manifoldcf.agents.interfaces.IOutputQualifyActivity

qualifyAccessToken

Methods inherited from interface org.apache.manifoldcf.agents.interfaces.IOutputHistoryActivity

recordActivity

Methods inherited from interface org.apache.manifoldcf.agents.interfaces.IOutputCheckActivity

checkDateIndexable, checkDocumentIndexable, checkLengthIndexable, checkMimeTypeIndexable, checkURLIndexable

Field Detail

_rcsid

static final java.lang.String _rcsid

See Also:

Constant Field Values

Method Detail

sendDocument

int sendDocument(java.lang.String documentURI,
                 RepositoryDocument document)
          throws ManifoldCFException,
                 ServiceInterruption,
                 java.io.IOException

Send a document via the pipeline to the next output connection.

Parameters:

documentURI - is the document's URI.

document - is the document data to be processed (handed to the output data store).

Returns:

the document status (accepted or permanently rejected); return codes are listed in IPipelineConnector.

Throws:

java.io.IOException - only if there's an IO error reading the data from the document.

ManifoldCFException

ServiceInterruption

noDocument

void noDocument()
         throws ManifoldCFException,
                ServiceInterruption

Send NO document via the pipeline to the next output connection. This is equivalent to sending an empty document placeholder.

Throws:

ManifoldCFException

ServiceInterruption