Package com.google.enterprise.connector.util.diffing

The diffing package provides a framework for writing connectors to repositories that do not provide information about added, deleted, or updated documents.

See: Description

Interface Summary

Interface	Description
ChangeQueue.CrawlActivityLogger	Interface to log the crawl activity for each crawl.
ChangeQueue.QueuePropertyFetcher	Interface to retrieve the properties required for ChangeQueue.
ChangeSource	A source of Change objects.
DocumentHandle	Interface for constructing a Document representing a change to be applied to the GSA after fetching any needed information from the repository holding the document.
DocumentHandleFactory	Interface for constructing a DocumentHandle from its String representation.
DocumentSink	A destination for tracking documents that are filtered and not sent on to the GSA.
DocumentSnapshot	Interface for a local copy of a document that is stored on the GSA.
DocumentSnapshotFactory	Interface for constructing a DocumentSnapshot from its String representation.
DocumentSnapshotRepositoryMonitor.Callback	The client provides an implementation of this interface to receive notification of changes to the repository.
DocumentSnapshotRepositoryMonitorManager	Management interface to DocumentSnapshotRepositoryMonitor threads.
SnapshotReader.RecordReader	Reads the snapshot file one record at a time.
SnapshotRepository<T extends DocumentSnapshot>	Interface for accessing a sequence of DocumentSnapshot objects from a repository.

Class Summary

Class	Description
Change	Description of a change to be sent to the Search Appliance.
ChangeQueue	Bounded buffer of Change objects for buffering between the DocumentSnapshotRepositoryMonitor and the CheckpointAndChangeQueue.
ChangeQueue.DefaultCrawlActivityLogger
CheckpointAndChangeQueue	Queue of CheckpointAndChange objects to be processed by the DiffingConnectorTraversalManager.
DeleteDocumentHandle	A DocumentHandle implementation for deleting documents.
DeleteDocumentHandleFactory	A DocumentHandleFactory for DeleteDocumentHandle objects.
DiffingConnector	Diffing connector implementation of the SPI Connector interface.
DiffingConnectorCheckpoint	Checkpoint for the DiffingConnector.
DiffingConnectorDocumentList	An implementation of DocumentList for the DiffingConnector.
DiffingConnectorTraversalManager	Implementation of TraversalManager for the DiffingConnector.
DocIdUtil	Static methods to convert paths to doc-ids and vice-versa.
DocumentSnapshotComparator	A comparator for DocumentSnapshot objects that supports both snapshots that implement the Comparable interface and legacy comparisons using the document IDs.
DocumentSnapshotRepositoryMonitor	A service that monitors a SnapshotRepository and makes callbacks when changes occur.
DocumentSnapshotRepositoryMonitorManagerImpl	A DocumentSnapshotRepositoryMonitorManager implementation.
GenericDocument	An generic implementation of Document.
LoggingDocumentSink	A DocumentSink that logs filtered documents.
MonitorCheckpoint	A checkpoint for a single DocumentSnapshotRepositoryMonitor.
SnapshotReader	Reader for a SnapshotStore.
SnapshotStore	An API for storing and retrieving snapshots.
SnapshotWriter	Write snapshot records in CSV format.
TraversalContextManager	Holder for the TraversalContext.

Enum Summary

Enum	Description
Change.FactoryType	Indication of the DocumentHandleFactory needed to un-serialize a Change from its JSON representation.
FilterReason	Enumerations for reasons for filtering a document rather than sending it to the GSA.

Exception Summary

Exception	Description
SnapshotReaderException	An Exception for errors reading the SnapshotStore.
SnapshotRepositoryRuntimeException	Exception for reporting a problem (such as loss of network connectivity to a repository) that precludes getting or using the Iterator for a SnapshotRepository
SnapshotStoreException	An Exception for problems accessing a SnapshotStore.
SnapshotWriterException	An Exception for errors writing the SnapshotStore.

Package com.google.enterprise.connector.util.diffing Description

The diffing package provides a framework for writing connectors to repositories that do not provide information about added, deleted, or updated documents. For repositories that support detecting updated documents, but not added or deleted documents, implementing the Lister and Retriever interfaces is a better alternative.

A diffing connector, written using this package, provides an iterable, fully-ordered SnapshotRepository of lightweight snapshots. A DocumentSnapshot can be compared to another snapshot, stringified, or used to obtain a Document via a DocumentHandle class.

Since:

2.8