addOrReplaceDocumentWithException
public int addOrReplaceDocumentWithException(String documentURI,
VersionContext pipelineDescription,
RepositoryDocument document,
String authorityNameString,
IOutputAddActivity activities)
throws ManifoldCFException,
ServiceInterruption,
IOException
Add (or replace) a document in the output data store using the connector.
This method presumes that the connector object has been configured, and it is thus able to communicate with the output data store should that be
necessary.
The OutputSpecification is *not* provided to this method, because the goal is consistency, and if output is done it must be consistent with the
output description, since that was what was partly used to determine if output should be taking place. So it may be necessary for this method to decode
an output description string in order to determine what should be done.
- Specified by:
addOrReplaceDocumentWithException
in interface IPipelineConnector
- Overrides:
addOrReplaceDocumentWithException
in class BaseTransformationConnector
- Parameters:
documentURI
- is the URI of the document. The URI is presumed to be the unique identifier which the output data store will use to process
and serve the document. This URI is constructed by the repository connector which fetches the document, and is thus universal across all output connectors.outputDescription
- is the description string that was constructed for this document by the getOutputDescription() method.document
- is the document data to be processed (handed to the output data store).authorityNameString
- is the name of the authority responsible for authorizing any access tokens passed in with the repository document. May be null.activities
- is the handle to an object that the implementer of a pipeline connector may use to perform operations, such as logging processing activity,
or sending a modified document to the next stage in the pipeline.
- Returns:
- the document status (accepted or permanently rejected).
- Throws:
IOException
- only if there's a stream error reading the document data.
ManifoldCFException
ServiceInterruption