com.google.enterprise.connector.util.diffing

Interface DocumentSnapshotRepositoryMonitorManager

All Known Implementing Classes:

DocumentSnapshotRepositoryMonitorManagerImpl, FakeDocumentSnapshotRepositoryMonitorManager

public interface DocumentSnapshotRepositoryMonitorManager

Management interface to DocumentSnapshotRepositoryMonitor threads.

Since:

2.8

Method Summary

Modifier and Type	Method and Description
void	acceptGuarantees(java.util.Map<java.lang.String,MonitorCheckpoint> guarantees) Receives information specifying what is guaranteed to be delivered to GSA.
void	clean() Removes persisted state for DocumentSnapshotRepositoryMonitor threads.
CheckpointAndChangeQueue	getCheckpointAndChangeQueue() Returns the CheckpointAndChangeQueue for this DocumentSnapshotRepositoryMonitorManager
int	getThreadCount() Returns the number of DocumentSnapshotRepositoryMonitor threads that are alive.
boolean	isRunning() Returns whether we are after a start() call and before a stop().
void	setTraversalSchedule(TraversalSchedule traversalSchedule) Receives TraversalSchedule from TraversalManager which is TraversalScheduleAware.
void	start(java.lang.String checkpoint) Ensures all monitor threads are running.
void	stop() Stops all the configured DocumentSnapshotRepositoryMonitor threads.

Method Detail

start

void start(java.lang.String checkpoint)
    throws RepositoryException

Ensures all monitor threads are running.

Parameters:

checkpoint - for the last completed document or null if none have been completed.

Throws:

RepositoryException

stop

void stop()

Stops all the configured DocumentSnapshotRepositoryMonitor threads.

clean

void clean()

Removes persisted state for DocumentSnapshotRepositoryMonitor threads. After calling this DocumentSnapshotRepositoryMonitor threads will no longer be able to resume from where they left off last time.

getThreadCount

int getThreadCount()

Returns the number of DocumentSnapshotRepositoryMonitor threads that are alive. This method is for testing purposes.

getCheckpointAndChangeQueue

CheckpointAndChangeQueue getCheckpointAndChangeQueue()

Returns the CheckpointAndChangeQueue for this DocumentSnapshotRepositoryMonitorManager

isRunning

boolean isRunning()

Returns whether we are after a start() call and before a stop().

acceptGuarantees

void acceptGuarantees(java.util.Map<java.lang.String,MonitorCheckpoint> guarantees)

Receives information specifying what is guaranteed to be delivered to GSA. Every entry in passed in Map is a monitor name and MonitorCheckpoint. The monitor of that name can expect that all documents before and including document related with MonitorCheckpoint will be delivered to GSA. This information is for the convenience and efficiency of the Monitor so that it knows how many changes it has to resend. It's valid for a monitor to ignore these updates if it feels like it for some good reason. FileConnectorSystemMonitor instances use this information to trim their file system snapshots.

setTraversalSchedule

void setTraversalSchedule(TraversalSchedule traversalSchedule)

Receives TraversalSchedule from TraversalManager which is TraversalScheduleAware.