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

Class ConsistencyChecker

java.lang.Object

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

public class ConsistencyChecker
extends Object

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) Create a new consistency checker instance

Method Summary

Methods

Modifier and Type	Method and Description
String	check(String revision, Set<String> paths, long binLen) Check whether the nodes and all its properties of all given paths are consistent at the given revision.
static String	checkConsistency(File directory, String journalFileName, boolean fullTraversal, long debugInterval, long binLen) Run a consistency check.
void	close()
String	traverse(String revision, long binLen) Travers the given revision

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)
                   throws IOException

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.

Throws:

IOException

Method Detail

checkConsistency

public static String checkConsistency(File directory,
                      String journalFileName,
                      boolean fullTraversal,
                      long debugInterval,
                      long binLen)
                               throws IOException

Run a consistency check.

Parameters:

directory - directory containing the tar files

journalFileName - name of the journal file containing the revision history

fullTraversal - full traversal consistency check if true. Only try to access the root node otherwise.

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

binLen - number of bytes to read from binary properties. -1 for all.

Returns:

the latest consistent revision out of the revisions listed in the journal.

Throws:

IOException

check

public String check(String revision,
           Set<String> paths,
           long binLen)

Check whether the nodes and all its properties of all given paths are consistent at the given revision.

Parameters:

revision - revision to check

paths - paths to check

binLen - number of bytes to read from binary properties. -1 for all.

Returns:

Path of the first inconsistency detected or null if none.

traverse

public String traverse(String revision,
              long binLen)

Travers the given revision

Parameters:

revision - revision to travers

binLen - number of bytes to read from binary properties. -1 for all.

close

public void close()