org.apache.directory.mavibot.btree

Class MavibotInspector

java.lang.Object

org.apache.directory.mavibot.btree.MavibotInspector

public class MavibotInspector
extends java.lang.Object

A class to examine a Mavibot database file.

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.BufferedReader	br
private static java.util.Map<java.lang.String,int[]>	checkedPages
private java.io.File	dbFile
private static java.lang.String	FREE_PAGES_NAME
private static java.lang.String	GLOBAL_PAGES_NAME
private static java.util.Set<java.lang.String>	knownPagesArrays
private static RecordManager	rm

Constructor Summary

Constructors

Constructor and Description
MavibotInspector(java.io.File dbFile) A private class to store a few informations about a btree private static BtreeInfo btreeInfo; static { btreeInfo = new BtreeInfo(); } /** Create an instance of MavibotInspector

Method Summary

Modifier and Type	Method and Description
(package private) static void	check(RecordManager recordManager) Check the whole file
private static <K,V> void	checkBtree(RecordManager recordManager, long btreeOffset, java.util.Map<java.lang.String,int[]> checkedPages) Check a user's B-tree
private static <K,V> BtreeInfo<K,V>	checkBtreeInfo(RecordManager recordManager, java.util.Map<java.lang.String,int[]> checkedPages, long btreeInfoOffset, long btreeRevision) Check the Btree info page
private static <K,V> void	checkBtreeLeaf(RecordManager recordManager, BtreeInfo<K,V> btreeInfo, java.util.Map<java.lang.String,int[]> checkedPages, int nbElems, long revision, java.nio.ByteBuffer byteBuffer, PageIO[] pageIos) Check a Btree leaf.
private static <K,V> long[]	checkBtreeNode(RecordManager recordManager, BtreeInfo<K,V> btreeInfo, java.util.Map<java.lang.String,int[]> checkedPages, int nbElems, long revision, java.nio.ByteBuffer byteBuffer, PageIO[] pageIos) Check a Btree node.
private static <K,V> void	checkBtreeOfBtrees(RecordManager recordManager, java.util.Map<java.lang.String,int[]> checkedPages) Check the Btree of Btrees
private static <K,V> void	checkBtreeOfBtreesLeaf(RecordManager recordManager, java.util.Map<java.lang.String,int[]> checkedPages, int nbElems, long revision, java.nio.ByteBuffer byteBuffer, PageIO[] pageIos) Check a Btree of Btrees leaf.
private static <K,V> long[]	checkBtreeOfBtreesNode(RecordManager recordManager, java.util.Map<java.lang.String,int[]> checkedPages, int nbElems, long revision, java.nio.ByteBuffer byteBuffer, PageIO[] pageIos) Check a Btree of Btrees Node
private static <K,V> void	checkBtreeOfBtreesPage(RecordManager recordManager, java.util.Map<java.lang.String,int[]> checkedPages, long pageOffset) Check the Btree of Btrees rootPage
private static <K,V> void	checkBtreePage(RecordManager recordManager, BtreeInfo<K,V> btreeInfo, java.util.Map<java.lang.String,int[]> checkedPages, long pageOffset) Check the Btree of Btrees rootPage
private boolean	checkFilePresence() Check that the file exists
private static void	checkFreePages(RecordManager recordManager, java.util.Map<java.lang.String,int[]> checkedPages) Check the free pages
private static void	checkOffset(RecordManager recordManager, long offset) Check the offset to be sure it's a valid one : It's >= 0 It's below the end of the file It's a multiple of the pageSize
private static int[]	createPageArray(RecordManager recordManager) Create an array of bits for pages
private static void	dumpCheckedPages(RecordManager recordManager, java.util.Map<java.lang.String,int[]> checkedPages) Output the pages that has been seen ('1') and those which has not been seen ('0').
private static java.lang.String	dumpPageArray(RecordManager recordManager, int[] checkedPages) Process a page array
static java.util.List<java.lang.Long>	getFreePages()
static java.util.List<java.lang.Long>	getGlobalPages()
static java.util.List<java.lang.Long>	getPageOffsets(java.lang.String pageArrayName) Gives a list of offsets of pages from the page array associated wit the given name.
private static <T> ElementSerializer<T>	getSerializer(java.lang.String serializerFqcn) Get back the serializer instance
void	inspectBTree() Check a B-tree
private boolean	loadRm() Load the full fie into a new RecordManager
static void	main(java.lang.String[] args) Main method
void	printBTreeNames() Print the B-tree's name
void	printFileSize() Pretty print the file size
void	printNumberOfBTrees() Print the number of B-trees
private java.lang.String	readLine() Read the user's interaction
private char	readOption() Process the input and get back the selected choice
private void	readPageAt()
private static void	setCheckedPage(RecordManager recordManager, int[] checkedPages, long offset) Update the ChekcedPages array
void	start() The entry point method
private static void	updateCheckedPages(int[] checkedPages, int pageSize, PageIO... pageIos) Update the array of seen pages.

Methods inherited from class java.lang.Object

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

Field Detail

dbFile

private java.io.File dbFile

rm

private static RecordManager rm

br

private java.io.BufferedReader br

GLOBAL_PAGES_NAME

private static final java.lang.String GLOBAL_PAGES_NAME

See Also:

Constant Field Values

FREE_PAGES_NAME

private static final java.lang.String FREE_PAGES_NAME

See Also:

Constant Field Values

knownPagesArrays

private static java.util.Set<java.lang.String> knownPagesArrays

checkedPages

private static java.util.Map<java.lang.String,int[]> checkedPages

Constructor Detail

MavibotInspector

public MavibotInspector(java.io.File dbFile)

A private class to store a few informations about a btree private static BtreeInfo btreeInfo; static { btreeInfo = new BtreeInfo(); } /** Create an instance of MavibotInspector

Parameters:

dbFile - The file to read

Method Detail

checkFilePresence

private boolean checkFilePresence()

Check that the file exists

printFileSize

public void printFileSize()
                   throws java.io.IOException

Pretty print the file size

Throws:

java.io.IOException

printNumberOfBTrees

public void printNumberOfBTrees()

Print the number of B-trees

printBTreeNames

public void printBTreeNames()

Print the B-tree's name

inspectBTree

public void inspectBTree()

Check a B-tree

loadRm

private boolean loadRm()

Load the full fie into a new RecordManager

check

static void check(RecordManager recordManager)

Check the whole file

checkBtreeOfBtrees

private static <K,V> void checkBtreeOfBtrees(RecordManager recordManager,
                                             java.util.Map<java.lang.String,int[]> checkedPages)
                                      throws java.lang.Exception

Check the Btree of Btrees

Throws:

java.lang.Exception

checkBtree

private static <K,V> void checkBtree(RecordManager recordManager,
                                     long btreeOffset,
                                     java.util.Map<java.lang.String,int[]> checkedPages)
                              throws java.lang.Exception

Check a user's B-tree

Throws:

java.lang.Exception

checkBtreePage

private static <K,V> void checkBtreePage(RecordManager recordManager,
                                         BtreeInfo<K,V> btreeInfo,
                                         java.util.Map<java.lang.String,int[]> checkedPages,
                                         long pageOffset)
                                  throws java.lang.Exception

Check the Btree of Btrees rootPage

Throws:

java.lang.Exception

checkBtreeInfo

private static <K,V> BtreeInfo<K,V> checkBtreeInfo(RecordManager recordManager,
                                                   java.util.Map<java.lang.String,int[]> checkedPages,
                                                   long btreeInfoOffset,
                                                   long btreeRevision)
                                            throws java.io.IOException

Check the Btree info page

Throws:

java.lang.ClassNotFoundException

java.io.IOException

getSerializer

private static <T> ElementSerializer<T> getSerializer(java.lang.String serializerFqcn)

Get back the serializer instance

checkBtreeOfBtreesPage

private static <K,V> void checkBtreeOfBtreesPage(RecordManager recordManager,
                                                 java.util.Map<java.lang.String,int[]> checkedPages,
                                                 long pageOffset)
                                          throws java.lang.Exception

Check the Btree of Btrees rootPage

Throws:

java.lang.Exception

checkBtreeOfBtreesLeaf

private static <K,V> void checkBtreeOfBtreesLeaf(RecordManager recordManager,
                                                 java.util.Map<java.lang.String,int[]> checkedPages,
                                                 int nbElems,
                                                 long revision,
                                                 java.nio.ByteBuffer byteBuffer,
                                                 PageIO[] pageIos)
                                          throws java.lang.Exception

Check a Btree of Btrees leaf. It contains -> offset.

Throws:

java.lang.Exception

checkBtreeLeaf

private static <K,V> void checkBtreeLeaf(RecordManager recordManager,
                                         BtreeInfo<K,V> btreeInfo,
                                         java.util.Map<java.lang.String,int[]> checkedPages,
                                         int nbElems,
                                         long revision,
                                         java.nio.ByteBuffer byteBuffer,
                                         PageIO[] pageIos)
                                  throws java.lang.Exception

Check a Btree leaf.

Throws:

java.lang.Exception

checkBtreeOfBtreesNode

private static <K,V> long[] checkBtreeOfBtreesNode(RecordManager recordManager,
                                                   java.util.Map<java.lang.String,int[]> checkedPages,
                                                   int nbElems,
                                                   long revision,
                                                   java.nio.ByteBuffer byteBuffer,
                                                   PageIO[] pageIos)
                                            throws java.io.IOException

Check a Btree of Btrees Node

Throws:

java.io.IOException

checkBtreeNode

private static <K,V> long[] checkBtreeNode(RecordManager recordManager,
                                           BtreeInfo<K,V> btreeInfo,
                                           java.util.Map<java.lang.String,int[]> checkedPages,
                                           int nbElems,
                                           long revision,
                                           java.nio.ByteBuffer byteBuffer,
                                           PageIO[] pageIos)
                                    throws java.lang.Exception

Check a Btree node.

Throws:

java.lang.Exception

createPageArray

private static int[] createPageArray(RecordManager recordManager)
                              throws java.io.IOException

Create an array of bits for pages

Throws:

java.io.IOException

updateCheckedPages

private static void updateCheckedPages(int[] checkedPages,
                                       int pageSize,
                                       PageIO... pageIos)

Update the array of seen pages.

checkOffset

private static void checkOffset(RecordManager recordManager,
                                long offset)
                         throws java.io.IOException

Check the offset to be sure it's a valid one :

• It's >= 0
• It's below the end of the file
• It's a multiple of the pageSize

Throws:

java.io.IOException

checkFreePages

private static void checkFreePages(RecordManager recordManager,
                                   java.util.Map<java.lang.String,int[]> checkedPages)
                            throws java.io.IOException

Check the free pages

Throws:

java.io.IOException

setCheckedPage

private static void setCheckedPage(RecordManager recordManager,
                                   int[] checkedPages,
                                   long offset)

Update the ChekcedPages array

dumpCheckedPages

private static void dumpCheckedPages(RecordManager recordManager,
                                     java.util.Map<java.lang.String,int[]> checkedPages)
                              throws java.io.IOException

Output the pages that has been seen ('1') and those which has not been seen ('0'). The '.' represent non-pages at the end of the file.

Throws:

java.io.IOException

getFreePages

public static java.util.List<java.lang.Long> getFreePages()
                                                   throws java.io.IOException

Throws:

java.io.IOException

See Also:

#getPageOffsets()

getGlobalPages

public static java.util.List<java.lang.Long> getGlobalPages()
                                                     throws java.io.IOException

Throws:

java.io.IOException

See Also:

#getPageOffsets()

getPageOffsets

public static java.util.List<java.lang.Long> getPageOffsets(java.lang.String pageArrayName)
                                                     throws java.io.IOException

Gives a list of offsets of pages from the page array associated wit the given name. This method should always be called after calling check() method.

Returns:

a list of offsets

Throws:

java.io.IOException

dumpPageArray

private static java.lang.String dumpPageArray(RecordManager recordManager,
                                              int[] checkedPages)
                                       throws java.io.IOException

Process a page array

Throws:

java.io.IOException

start

public void start()
           throws java.lang.Exception

The entry point method

Throws:

java.lang.Exception

readLine

private java.lang.String readLine()

Read the user's interaction

readOption

private char readOption()

Process the input and get back the selected choice

readPageAt

private void readPageAt()
                 throws java.io.IOException

Throws:

java.io.IOException

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Main method

Throws:

java.lang.Exception