com.google.enterprise.connector.util.diffing

Class DocumentSnapshotRepositoryMonitorManagerImpl

java.lang.Object

com.google.enterprise.connector.util.diffing.DocumentSnapshotRepositoryMonitorManagerImpl

All Implemented Interfaces:

DocumentSnapshotRepositoryMonitorManager

public class DocumentSnapshotRepositoryMonitorManagerImpl
extends java.lang.Object
implements DocumentSnapshotRepositoryMonitorManager

A DocumentSnapshotRepositoryMonitorManager implementation. There is one instance of this class per DiffingConnector created by Spring. That instance gets signals from DiffingConnectorTraversalManager to start (go from "cold" to "warm") and does so from scratch or from recovery state. It creates the SnapshotStore instances and invokes their recovery method. It creates and manages the DocumentSnapshotRepositoryMonitor instances and passes guaranteed checkpoints to these monitors.

Since:

2.8

Constructor Summary

Constructors

Constructor and Description

DocumentSnapshotRepositoryMonitorManagerImpl(java.util.List<? extends SnapshotRepository<? extends DocumentSnapshot>> repositories, DocumentSnapshotFactory documentSnapshotFactory, java.io.File snapshotDir, ChecksumGenerator checksumGenerator, ChangeQueue changeQueue, CheckpointAndChangeQueue checkpointAndChangeQueue) Constructs DocumentSnapshotRepositoryMonitorManagerImpl for the DiffingConnector.

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 connectorManagerCheckpoint) Go from "cold" to "warm" including CheckpointAndChangeQueue.
void	stop() Stops all the configured DocumentSnapshotRepositoryMonitor threads.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentSnapshotRepositoryMonitorManagerImpl

public DocumentSnapshotRepositoryMonitorManagerImpl(java.util.List<? extends SnapshotRepository<? extends DocumentSnapshot>> repositories,
                                                    DocumentSnapshotFactory documentSnapshotFactory,
                                                    java.io.File snapshotDir,
                                                    ChecksumGenerator checksumGenerator,
                                                    ChangeQueue changeQueue,
                                                    CheckpointAndChangeQueue checkpointAndChangeQueue)

Constructs DocumentSnapshotRepositoryMonitorManagerImpl for the DiffingConnector.

Parameters:

repositories - a List of SnapshotRepositorys

documentSnapshotFactory - a DocumentSnapshotFactory

snapshotDir - directory to store SnapshotRepository

checksumGenerator - a ChecksumGenerator used to detect changes in a document's content

changeQueue - a ChangeQueue

checkpointAndChangeQueue - a CheckpointAndChangeQueue

Method Detail

stop

public void stop()

Description copied from interface: DocumentSnapshotRepositoryMonitorManager

Stops all the configured DocumentSnapshotRepositoryMonitor threads.

Specified by:

stop in interface DocumentSnapshotRepositoryMonitorManager

start

public void start(java.lang.String connectorManagerCheckpoint)
           throws RepositoryException

Go from "cold" to "warm" including CheckpointAndChangeQueue.

Specified by:

start in interface DocumentSnapshotRepositoryMonitorManager

Parameters:

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

Throws:

RepositoryException

clean

public void clean()

Description copied from interface: DocumentSnapshotRepositoryMonitorManager

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.

Specified by:

clean in interface DocumentSnapshotRepositoryMonitorManager

getThreadCount

public int getThreadCount()

Description copied from interface: DocumentSnapshotRepositoryMonitorManager

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

Specified by:

getThreadCount in interface DocumentSnapshotRepositoryMonitorManager

getCheckpointAndChangeQueue

public CheckpointAndChangeQueue getCheckpointAndChangeQueue()

Description copied from interface: DocumentSnapshotRepositoryMonitorManager

Returns the CheckpointAndChangeQueue for this DocumentSnapshotRepositoryMonitorManager

Specified by:

getCheckpointAndChangeQueue in interface DocumentSnapshotRepositoryMonitorManager

isRunning

public boolean isRunning()

Description copied from interface: DocumentSnapshotRepositoryMonitorManager

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

Specified by:

isRunning in interface DocumentSnapshotRepositoryMonitorManager

acceptGuarantees

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

Description copied from interface: DocumentSnapshotRepositoryMonitorManager

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.

Specified by:

acceptGuarantees in interface DocumentSnapshotRepositoryMonitorManager

setTraversalSchedule

public void setTraversalSchedule(TraversalSchedule traversalSchedule)

Description copied from interface: DocumentSnapshotRepositoryMonitorManager

Receives TraversalSchedule from TraversalManager which is TraversalScheduleAware.

Specified by:

setTraversalSchedule in interface DocumentSnapshotRepositoryMonitorManager