com.google.enterprise.connector.util.diffing

Class SnapshotStore

java.lang.Object

com.google.enterprise.connector.util.diffing.SnapshotStore

public class SnapshotStore
extends java.lang.Object

An API for storing and retrieving snapshots.

Since:

2.8

Constructor Summary

Constructors

Constructor and Description
SnapshotStore(java.io.File snapshotDirectory, DocumentSnapshotFactory documentSnapshotFactory)

Method Summary

Modifier and Type	Method and Description
void	deleteOldSnapshots()
long	getOldestSnapsotToKeep() Deprecated. This method will be removed in a future release
SnapshotReader	openMostRecentSnapshot()
SnapshotWriter	openNewSnapshotWriter()
static void	stitch(java.io.File snapshotDir, MonitorCheckpoint checkpoint, DocumentSnapshotFactory documentSnapshotFactory)

Methods inherited from class java.lang.Object

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

Constructor Detail

SnapshotStore

public SnapshotStore(java.io.File snapshotDirectory,
                     DocumentSnapshotFactory documentSnapshotFactory)
              throws SnapshotStoreException

Parameters:

snapshotDirectory - the directory in which to store the snapshots. Must be non-null. If it does not exist, it will be created.

documentSnapshotFactory - factory for creating DocumentSnapshots

Throws:

SnapshotStoreException - if the snapshot directory does not exist and cannot be created

Method Detail

openNewSnapshotWriter

public SnapshotWriter openNewSnapshotWriter()
                                     throws SnapshotStoreException

Returns:

a writer for the next snapshot

Throws:

SnapshotStoreException

openMostRecentSnapshot

public SnapshotReader openMostRecentSnapshot()
                                      throws SnapshotStoreException

Returns:

the most recent snapshot. If no snapshot is available, return an empty snapshot.

Throws:

SnapshotStoreException

deleteOldSnapshots

public void deleteOldSnapshots()

getOldestSnapsotToKeep

@Deprecated
public long getOldestSnapsotToKeep()

Deprecated. This method will be removed in a future release

Internal method.

stitch

public static void stitch(java.io.File snapshotDir,
                          MonitorCheckpoint checkpoint,
                          DocumentSnapshotFactory documentSnapshotFactory)
                   throws java.io.IOException,
                          SnapshotStoreException,
                          java.lang.InterruptedException

Throws:

java.io.IOException

SnapshotStoreException

java.lang.InterruptedException