Package org.apache.manifoldcf.agents.incrementalingest

Class IncrementalIngester.MonitoredAddActivityWrapper

    • Field Detail

      • documentProcessed

        protected boolean documentProcessed

    • Constructor Detail

      • MonitoredAddActivityWrapper

        public MonitoredAddActivityWrapper​(IOutputAddActivity activities)

    • Method Detail

      • wasDocumentActedUpon

        public boolean wasDocumentActedUpon()

      • sendDocument

        public 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.
        Specified by:
        sendDocument in interface IOutputAddActivity
        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

      • qualifyAccessToken

        public java.lang.String qualifyAccessToken​(java.lang.String authorityNameString,
                                           java.lang.String accessToken)
                                    throws ManifoldCFException
        Qualify an access token appropriately, to match access tokens as returned by mod_aa. This method includes the authority name with the access token, if any, so that each authority may establish its own token space.
        Specified by:
        qualifyAccessToken in interface IOutputQualifyActivity
        Parameters:
        authorityNameString - is the name of the authority to use to qualify the access token.
        accessToken - is the raw, repository access token.
        Returns:
        the properly qualified access token.
        Throws:
        ManifoldCFException

      • recordActivity

        public void recordActivity​(java.lang.Long startTime,
                           java.lang.String activityType,
                           java.lang.Long dataSize,
                           java.lang.String entityURI,
                           java.lang.String resultCode,
                           java.lang.String resultDescription)
                    throws ManifoldCFException
        Record time-stamped information about the activity of the output connector.
        Specified by:
        recordActivity in interface IOutputHistoryActivity
        Parameters:
        startTime - is either null or the time since the start of epoch in milliseconds (Jan 1, 1970). Every activity has an associated time; the startTime field records when the activity began. A null value indicates that the start time and the finishing time are the same.
        activityType - is a string which is fully interpretable only in the context of the connector involved, which is used to categorize what kind of activity is being recorded. For example, a web connector might record a "fetch document" activity. Cannot be null.
        dataSize - is the number of bytes of data involved in the activity, or null if not applicable.
        entityURI - is a (possibly long) string which identifies the object involved in the history record. The interpretation of this field will differ from connector to connector. May be null.
        resultCode - contains a terse description of the result of the activity. The description is limited in size to 255 characters, and can be interpreted only in the context of the current connector. May be null.
        resultDescription - is a (possibly long) human-readable string which adds detail, if required, to the result described in the resultCode field. This field is not meant to be queried on. May be null.
        Throws:
        ManifoldCFException

      • checkDocumentIndexable

        public boolean checkDocumentIndexable​(java.io.File localFile)
                               throws ManifoldCFException,
                                      ServiceInterruption
        Pre-determine whether a document (passed here as a File object) is acceptable downstream. This method is used to determine whether a document needs to be actually transferred. This hook is provided mainly to support search engines that only handle a small set of accepted file types.
        Specified by:
        checkDocumentIndexable in interface IOutputCheckActivity
        Parameters:
        localFile - is the local file to check.
        Returns:
        true if the file is acceptable by the downstream connection.
        Throws:
        ManifoldCFException
        ServiceInterruption