com.neeve.rog.log

Class RogLogCompactor

java.lang.Object

com.neeve.root.RootObject

com.neeve.rog.RogObject

com.neeve.rog.log.RogLogCompactor

public final class RogLogCompactor
extends RogObject

Compacts a log's live log file

Threading:

A log compactor is not safe for concurrent access by multiple threads.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RogLogCompactor.Params Contains parameters for compaction.
static class	RogLogCompactor.State Enmerates the various compactor states

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_COMPACTION_THRESHOLD See RogLogCompactor.Params.PROP_COMPACTION_THRESHOLD

Method Summary

Modifier and Type	Method and Description
RogLogCompactor	compact() Perform the log compaction This method kicks off the background compaction of the live transaction log file.
RogLogCompactor.State	getState() Get the current compaction state
boolean	isCompactionInProgress() Get is compaction is in progress
void	stop() Stop any running compaction
void	waitForCompactionToComplete() Wait for compaction to complete

Methods inherited from class com.neeve.root.RootObject

getChecked, getThreaded, getTracer

Methods inherited from class java.lang.Object

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

Field Detail

PROP_COMPACTION_THRESHOLD

public static final String PROP_COMPACTION_THRESHOLD

See RogLogCompactor.Params.PROP_COMPACTION_THRESHOLD

See Also:

Constant Field Values

Method Detail

getState

public final RogLogCompactor.State getState()

Get the current compaction state

compact

public final RogLogCompactor compact()

Perform the log compaction

This method kicks off the background compaction of the live transaction log file. The caller can track the status of the compaction by polling the state via the getState() method.

isCompactionInProgress

public final boolean isCompactionInProgress()

Get is compaction is in progress

waitForCompactionToComplete

public final void waitForCompactionToComplete()
                                       throws Exception

Wait for compaction to complete

Throws:

Exception

stop

public final void stop()

Stop any running compaction