Package org.apache.manifoldcf.agents.incrementalingest

Class IncrementalIngester.OutputRecordingActivity

java.lang.Object

org.apache.manifoldcf.agents.incrementalingest.IncrementalIngester.OutputRecordingActivity

All Implemented Interfaces:

IOutputHistoryActivity

Direct Known Subclasses:

IncrementalIngester.OutputAddActivitiesWrapper, IncrementalIngester.OutputRemoveActivitiesWrapper

Enclosing class:

IncrementalIngester

protected static class IncrementalIngester.OutputRecordingActivity
extends java.lang.Object
implements IOutputHistoryActivity

Wrapper class for add activity. This handles conversion of output connector activity logging to qualified activity names

Field Summary

Fields

Modifier and Type	Field	Description
protected IOutputHistoryActivity	activityProvider
protected java.lang.String	outputConnectionName

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

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

Constructor Summary

Constructors

Constructor	Description
OutputRecordingActivity(IOutputHistoryActivity activityProvider, java.lang.String outputConnectionName)

Method Summary

Modifier and Type	Method	Description
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)	Record time-stamped information about the activity of the output connector.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

activityProvider

protected final IOutputHistoryActivity activityProvider

outputConnectionName

protected final java.lang.String outputConnectionName

Constructor Detail

OutputRecordingActivity

public OutputRecordingActivity(IOutputHistoryActivity activityProvider,
                               java.lang.String outputConnectionName)

Method Detail

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