org.apache.manifoldcf.agents.interfaces

Interface IIngestLogger

public interface IIngestLogger

This interface describes logging support that will be called by the ingestion engine to record its activities interacting with the ingestion API.

Method Summary

Modifier and Type	Method and Description
void	recordDeletionAttempt(java.lang.String documentIdentifier, java.lang.Long startTime, java.lang.String entityIdentifier, java.lang.String resultCode, java.lang.String resultDescription) Record time-stamped information about a deletion attempt.
void	recordIngestionAttempt(java.lang.String documentIdentifier, java.lang.Long startTime, java.lang.Long dataSize, java.lang.String entityIdentifier, java.lang.String resultCode, java.lang.String resultDescription) Record time-stamped information about an ingestion attempt.

Method Detail

recordIngestionAttempt

void recordIngestionAttempt(java.lang.String documentIdentifier,
                            java.lang.Long startTime,
                            java.lang.Long dataSize,
                            java.lang.String entityIdentifier,
                            java.lang.String resultCode,
                            java.lang.String resultDescription)
                     throws ManifoldCFException

Record time-stamped information about an ingestion attempt.

Parameters:

documentIdentifier - is the internal document identifier being described.

startTime - is either null or the time since the start of epoch in milliseconds (Jan 1, 1970). Every ingestion attempt 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.

dataSize - is the number of bytes of data ingested, or null if not applicable.

entityIdentifier - is a (possibly long) string which identifies the object involved in the ingestion attempt.

resultCode - contains a terse description of the result of the ingestion. The description is limited in size to 255 characters.

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

recordDeletionAttempt

void recordDeletionAttempt(java.lang.String documentIdentifier,
                           java.lang.Long startTime,
                           java.lang.String entityIdentifier,
                           java.lang.String resultCode,
                           java.lang.String resultDescription)
                    throws ManifoldCFException

Record time-stamped information about a deletion attempt.

Parameters:

documentIdentifier - is the internal document identifier being described.

startTime - is either null or the time since the start of epoch in milliseconds (Jan 1, 1970). Every deletion attempt 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.

entityIdentifier - is a (possibly long) string which identifies the object involved in the deletion attempt.

resultCode - contains a terse description of the result of the ingestion. The description is limited in size to 255 characters.

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