org.apache.jackrabbit.oak.segment.file.tooling

Class ConsistencyChecker

java.lang.Object

org.apache.jackrabbit.oak.segment.file.tooling.ConsistencyChecker

All Implemented Interfaces:

Closeable, AutoCloseable

public class ConsistencyChecker
extends Object
implements Closeable

Utility for checking the files of a FileStore for inconsistency and reporting that latest consistent revision.

Constructor Summary

Constructors

Constructor and Description
ConsistencyChecker(File directory, long debugInterval, boolean ioStatistics, PrintWriter outWriter, PrintWriter errWriter) Create a new consistency checker instance

Method Summary

Modifier and Type	Method and Description
static void	checkConsistency(File directory, String journalFileName, long debugInterval, boolean checkBinaries, boolean checkHead, Set<String> checkpoints, Set<String> filterPaths, boolean ioStatistics, PrintWriter outWriter, PrintWriter errWriter) Run a full traversal consistency check.
void	close()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsistencyChecker

public ConsistencyChecker(File directory,
                          long debugInterval,
                          boolean ioStatistics,
                          PrintWriter outWriter,
                          PrintWriter errWriter)
                   throws IOException,
                          InvalidFileStoreVersionException

Create a new consistency checker instance

Parameters:

directory - directory containing the tar files

debugInterval - number of seconds between printing progress information to the console during the full traversal phase.

ioStatistics - if true prints I/O statistics gathered while consistency check was performed

outWriter - text output stream writer

errWriter - text error stream writer

Throws:

IOException

InvalidFileStoreVersionException

Method Detail

checkConsistency

public static void checkConsistency(File directory,
                                    String journalFileName,
                                    long debugInterval,
                                    boolean checkBinaries,
                                    boolean checkHead,
                                    Set<String> checkpoints,
                                    Set<String> filterPaths,
                                    boolean ioStatistics,
                                    PrintWriter outWriter,
                                    PrintWriter errWriter)
                             throws IOException,
                                    InvalidFileStoreVersionException

Run a full traversal consistency check.

Parameters:

directory - directory containing the tar files

journalFileName - name of the journal file containing the revision history

debugInterval - number of seconds between printing progress information to the console during the full traversal phase.

checkBinaries - if true full content of binary properties will be scanned

checkHead - if true will check the head

checkpoints - collection of checkpoints to be checked

filterPaths - collection of repository paths to be checked

ioStatistics - if true prints I/O statistics gathered while consistency check was performed

outWriter - text output stream writer

errWriter - text error stream writer

Throws:

IOException

InvalidFileStoreVersionException

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable