org.apache.manifoldcf.agents.interfaces

Interface IOutputHistoryActivity

All Known Subinterfaces:

IOutputActivity, IOutputAddActivity, IOutputNotifyActivity, IOutputRemoveActivity

All Known Implementing Classes:

DocumentCleanupThread.OutputRemoveActivity, DocumentDeleteThread.OutputRemoveActivity, ExpireThread.OutputRemoveActivity, IncrementalIngester.MonitoredAddActivityWrapper, IncrementalIngester.OutputActivitiesWrapper, IncrementalIngester.OutputAddActivitiesWrapper, IncrementalIngester.OutputRecordingActivity, IncrementalIngester.OutputRemoveActivitiesWrapper, IncrementalIngester.PipelineAddFanout, IncrementalIngester.TransformationRecordingActivity, JobNotificationThread.OutputNotifyActivity, WorkerThread.OutputActivity

public interface IOutputHistoryActivity

This interface abstracts from the activities that an output connector can do.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid
static java.lang.String	CREATED_DIRECTORY
static java.lang.String	EXCEPTION
static java.lang.String	EXCLUDED_CONTENT
static java.lang.String	EXCLUDED_DATE
static java.lang.String	EXCLUDED_LENGTH
static java.lang.String	EXCLUDED_MIMETYPE
static java.lang.String	EXCLUDED_URL
static java.lang.String	HTTP_ERROR Use this result code when you get HTTP error from the service that you are connected.
static java.lang.String	IOEXCEPTION
static java.lang.String	UNKNOWN_SECURITY Use this result code when security info is not recognized.

Method Summary

Modifier and Type	Method and 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.

Field Detail

_rcsid

static final java.lang.String _rcsid

See Also:

Constant Field Values

EXCEPTION

static final java.lang.String EXCEPTION

See Also:

Constant Field Values

CREATED_DIRECTORY

static final java.lang.String CREATED_DIRECTORY

See Also:

Constant Field Values

IOEXCEPTION

static final java.lang.String IOEXCEPTION

See Also:

Constant Field Values

EXCLUDED_URL

static final java.lang.String EXCLUDED_URL

See Also:

Constant Field Values

EXCLUDED_LENGTH

static final java.lang.String EXCLUDED_LENGTH

See Also:

Constant Field Values

EXCLUDED_MIMETYPE

static final java.lang.String EXCLUDED_MIMETYPE

See Also:

Constant Field Values

EXCLUDED_DATE

static final java.lang.String EXCLUDED_DATE

See Also:

Constant Field Values

EXCLUDED_CONTENT

static final java.lang.String EXCLUDED_CONTENT

See Also:

Constant Field Values

UNKNOWN_SECURITY

static final java.lang.String UNKNOWN_SECURITY

Use this result code when security info is not recognized.

See Also:

Constant Field Values

HTTP_ERROR

static final java.lang.String HTTP_ERROR

Use this result code when you get HTTP error from the service that you are connected.

See Also:

Constant Field Values

Method Detail

recordActivity

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.

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