com.sleepycat.je.utilint

Class LogVerifier

java.lang.Object

com.sleepycat.je.utilint.LogVerifier

public class LogVerifier
extends Object

Verifies the checksums in the contents of a log file in a JE Environment.

The caller supplies the contents of the log file by passing arrays of bytes in a series of calls to the verify(byte[], int, int) method, which verifies the checksums for log records, and by calling the verifyAtEof() when the entire contents are complete, to detect incomplete entries at the end of the file. The primary intended use of this class is to verify the contents of log files that are being copied as part of a programmatic backup. It is critical that invalid files are not added to a backup set, since then both the live environment and the backup will be invalid.

See Also:

LogVerificationInputStream

Constructor Summary

Constructors

Constructor and Description
LogVerifier(EnvironmentImpl envImpl, String fileName) Creates a log verifier.
LogVerifier(EnvironmentImpl envImpl, String fileName, long fileNum) Creates a log verifier for use with an internal environment.
LogVerifier(Environment env, String fileName) Creates a log verifier.

Method Summary

Modifier and Type	Method and Description
void	verify(byte[] buf, int off, int len) Verifies the next portion of the log file.
void	verifyAtEof() Checks that the log file ends with a complete log entry, after having completed verifying the log file contents through calls to verify(byte[], int, int).

Methods inherited from class java.lang.Object

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

Constructor Detail

LogVerifier

public LogVerifier(Environment env,
                   String fileName)

Creates a log verifier.

Parameters:

env - the Environment associated with the log

fileName - the file name of the log, for reporting in the LogVerificationException. This should be a simple file name of the form NNNNNNNN.jdb, where NNNNNNNN is the file number in hexadecimal format.

Throws:

EnvironmentFailureException - if an unexpected, internal or environment-wide failure occurs

LogVerifier

public LogVerifier(EnvironmentImpl envImpl,
                   String fileName)

Creates a log verifier.

Parameters:

envImpl - the EnvironmentImpl associated with the log

fileName - the file name of the log, for reporting in the LogVerificationException. This should be a simple file name of the form NNNNNNNN.jdb, where NNNNNNNN is the file number in hexadecimal format.

Throws:

EnvironmentFailureException - if an unexpected, internal or environment-wide failure occurs

LogVerifier

public LogVerifier(EnvironmentImpl envImpl,
                   String fileName,
                   long fileNum)

Creates a log verifier for use with an internal environment. If fileNum is less than zero, it is derived from fileName.

Parameters:

envImpl - the EnvironmentImpl associated with the log

fileName - the file name of the log, for reporting in the LogVerificationException. This should be a simple file name of the form NNNNNNNN.jdb, where NNNNNNNN is the file number in hexadecimal format.

fileNum - the file number

Method Detail

verify

public void verify(byte[] buf,
                   int off,
                   int len)
            throws LogVerificationException

Verifies the next portion of the log file.

Parameters:

buf - the buffer containing the log file bytes

off - the start offset of the log file bytes in the buffer

len - the number of log file bytes in the buffer

Throws:

LogVerificationException - if a checksum cannot be verified or a log entry is determined to be invalid by examining its contents

EnvironmentFailureException - if an unexpected, internal or environment-wide failure occurs

verifyAtEof

public void verifyAtEof()
                 throws LogVerificationException

Checks that the log file ends with a complete log entry, after having completed verifying the log file contents through calls to verify(byte[], int, int).

Throws:

LogVerificationException - if the stream does not end with a complete log entry

EnvironmentFailureException - if an unexpected, internal or environment-wide failure occurs