com.google.enterprise.connector.util.diffing

Class DiffingConnectorTraversalManager

java.lang.Object

com.google.enterprise.connector.util.diffing.DiffingConnectorTraversalManager

All Implemented Interfaces:

TraversalContextAware, TraversalManager, TraversalScheduleAware

public class DiffingConnectorTraversalManager
extends java.lang.Object
implements TraversalManager, TraversalContextAware, TraversalScheduleAware

Implementation of TraversalManager for the DiffingConnector.

Since:

2.8

Constructor Summary

Constructors

Constructor and Description
DiffingConnectorTraversalManager(DocumentSnapshotRepositoryMonitorManager snapshotRepositoryMonitorManager, TraversalContextManager traversalContextManager) Creates a DiffingConnectorTraversalManager.

Method Summary

Modifier and Type	Method and Description
void	deactivate()
boolean	isActive() Public for testing.
DocumentList	resumeTraversal(java.lang.String checkpoint) Continues traversal from a supplied checkpoint.
void	setBatchHint(int batchHint) Sets the preferred batch size.
void	setTraversalContext(TraversalContext traversalContext) Supplies a TraversalContext object which the TraversalManager can use to get various information from the Connector Manager.
void	setTraversalSchedule(TraversalSchedule traversalSchedule) Sets the TraversalSchedule for this connector.
DocumentList	startTraversal() Start document crawling and piping as if from beginning.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiffingConnectorTraversalManager

public DiffingConnectorTraversalManager(DocumentSnapshotRepositoryMonitorManager snapshotRepositoryMonitorManager,
                                        TraversalContextManager traversalContextManager)

Creates a DiffingConnectorTraversalManager.

Parameters:

snapshotRepositoryMonitorManager - the DocumentSnapshotRepositoryMonitorManager for use accessing a ChangeSource

traversalContextManager - TraversalContextManager that holds the current TraversalContext

Method Detail

setBatchHint

public void setBatchHint(int batchHint)

Description copied from interface: TraversalManager

Sets the preferred batch size. The caller advises the implementation that the result sets returned by startTraversal or resumeTraversal should be as close to this number as is reasonable. The implementation may ignore this call or do its best to return approximately this number.

Specified by:

setBatchHint in interface TraversalManager

startTraversal

public DocumentList startTraversal()
                            throws RepositoryException

Start document crawling and piping as if from beginning.

Specified by:

startTraversal in interface TraversalManager

Returns:

A DocumentList of documents from the repository in natural order, or null if there are no documents.

Throws:

RepositoryException - if the Repository is unreachable or similar exceptional condition.

resumeTraversal

public DocumentList resumeTraversal(java.lang.String checkpoint)
                             throws RepositoryException

Description copied from interface: TraversalManager

Continues traversal from a supplied checkpoint. The checkPoint parameter will have been created by a call to the DocumentList.checkpoint() method. The DocumentList object returns objects from the repository in natural order starting just after the document that was used to create the checkpoint string.

Specified by:

resumeTraversal in interface TraversalManager

Parameters:

checkpoint - String that indicates from where to resume traversal.

Returns:

DocumentList object that returns documents starting just after the checkpoint, or null if there are no documents.

Throws:

RepositoryException

setTraversalContext

public void setTraversalContext(TraversalContext traversalContext)

Description copied from interface: TraversalContextAware

Supplies a TraversalContext object which the TraversalManager can use to get various information from the Connector Manager.

Specified by:

setTraversalContext in interface TraversalContextAware

Parameters:

traversalContext - the TraversalContext

setTraversalSchedule

public void setTraversalSchedule(TraversalSchedule traversalSchedule)

Description copied from interface: TraversalScheduleAware

Sets the TraversalSchedule for this connector.

Specified by:

setTraversalSchedule in interface TraversalScheduleAware

Parameters:

traversalSchedule - the TraversalSchedule

deactivate

public void deactivate()

isActive

public boolean isActive()

Public for testing.