com.persistit

Class Management.RecoveryInfo

java.lang.Object

com.persistit.Management.AcquisitionTimeBase

com.persistit.Management.RecoveryInfo

All Implemented Interfaces:

Serializable

Enclosing interface:

Management

public static class Management.RecoveryInfo
extends Management.AcquisitionTimeBase

A structure that holds information about the recovered database. Once recovery is complete, the values in this structure never change.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RecoveryInfo()
RecoveryInfo(String keystoneJournalFile, long keystoneJournalAddress, long blockSize, int pageMapSize, long baseAddress, long currentAddress, long lastValidCheckpointTimestamp, long lastValidCheckpointSystemTime, String lastValidCheckpointJournalFile, long lastValidCheckpointJournalAddress, int committedTransactions, int uncommittedTransactions, int errorCount, int appliedTransactions, long recoveryStatus, long recoveryEndAddress, String recoveryException, boolean copySuspended, boolean copyFast)

Method Summary

Modifier and Type	Method and Description
int	getAppliedTransactions()
long	getBaseAddress() Address of first record in the journal required for recovery.
long	getBlockSize()
int	getCommittedTransactions()
long	getCurrentAddress() Address within journal file from which records currently are being scanned.
int	getErrorCount()
long	getKeystoneJournalAddress()
String	getKeystoneJournalFile()
long	getLastValidCheckpointJournalAddress()
String	getLastValidCheckpointJournalFile()
long	getLastValidCheckpointSystemTime()
long	getLastValidCheckpointTimestamp()
int	getPageMapSize() Number of page entries in the recovered page map
long	getRecoveryEndAddress()
String	getRecoveryEndedException()
long	getRecoveryStatus() Return one of the following values: Long.MINVALUE if recovery has not begun yet -1 if recovery ended after a "dirty" (abruptly terminated) shutdown 0 if recovery completed after a "clean" (normal) shutdown N > 0 if recovery is in progress, in which case N represents the approximate number of remaining bytes of journal data to process.
int	getUncommittedTransactions()

Methods inherited from class com.persistit.Management.AcquisitionTimeBase

getAcquisitionTime, setAcquisitionTime

Methods inherited from class java.lang.Object

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

Constructor Detail

RecoveryInfo

public RecoveryInfo()

RecoveryInfo

@ConstructorProperties(value={"keystoneJournalFile","keystoneJournalAddress","blockSize","pageMapSize","baseAddress","currentAddress","lastValidCheckpointTimestamp","lastValidCheckpointSystemTime","lastValidCheckpointJournalFile","lastValidCheckpointJournalAddress","committedTransactions","uncommittedTransactions","errorCount","appliedTransactions","recoveryStatus","recoveryEndAddress","recoveryException","copySuspended","copyFast"})
public RecoveryInfo(String keystoneJournalFile,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          long keystoneJournalAddress,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          long blockSize,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          int pageMapSize,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          long baseAddress,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          long currentAddress,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          long lastValidCheckpointTimestamp,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          long lastValidCheckpointSystemTime,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          String lastValidCheckpointJournalFile,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          long lastValidCheckpointJournalAddress,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          int committedTransactions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          int uncommittedTransactions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          int errorCount,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          int appliedTransactions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          long recoveryStatus,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          long recoveryEndAddress,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          String recoveryException,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          boolean copySuspended,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          boolean copyFast)

Method Detail

getKeystoneJournalFile

public String getKeystoneJournalFile()

Returns:

the keystone Journal file name. This is the last-written valid journal file in the journal.

getKeystoneJournalAddress

public long getKeystoneJournalAddress()

Returns:

the keystone Journal file address

getBlockSize

public long getBlockSize()

Returns:

the max Journal file size

getPageMapSize

public int getPageMapSize()

Number of page entries in the recovered page map

Returns:

the pageMap size

getBaseAddress

public long getBaseAddress()

Address of first record in the journal required for recovery.

Returns:

the start generation

getLastValidCheckpointTimestamp

public long getLastValidCheckpointTimestamp()

Returns:

the time stamp of latest valid Checkpoint

getLastValidCheckpointSystemTime

public long getLastValidCheckpointSystemTime()

Returns:

the system time (in millis) of the latest valid Checkpoint

getLastValidCheckpointJournalFile

public String getLastValidCheckpointJournalFile()

Returns:

the name of the journal file to which the last valid checkpoint record was written

getLastValidCheckpointJournalAddress

public long getLastValidCheckpointJournalAddress()

Returns:

the file address of the last valid checkpoint record

getCurrentAddress

public long getCurrentAddress()

Address within journal file from which records currently are being scanned. After recovery is complete, the address after the last recovered record.

Returns:

the current recovery file address.

getRecoveryStatus

public long getRecoveryStatus()

Return one of the following values:

Long.MINVALUE	if recovery has not begun yet
-1	if recovery ended after a "dirty" (abruptly terminated) shutdown
0	if recovery completed after a "clean" (normal) shutdown
N > 0	if recovery is in progress, in which case N represents the approximate number of remaining bytes of journal data to process.

Returns:

the recovery status.

getCommittedTransactions

public int getCommittedTransactions()

Returns:

the number of committed Transactions found in the journal

getUncommittedTransactions

public int getUncommittedTransactions()

Returns:

the number of uncommitted Transactions found in the journal

getAppliedTransactions

public int getAppliedTransactions()

Returns:

the number of recovered committed Transactions that have been applied

getErrorCount

public int getErrorCount()

Returns:

the number of errors encountered while applying committed Transactions during recovery

getRecoveryEndAddress

public long getRecoveryEndAddress()

Returns:

journal address at which recovery processing stopped

getRecoveryEndedException

public String getRecoveryEndedException()

Returns:

Exception that caused recovery to end or the empty string for recovery after a clean shutdown.