RogLog (Rumi 4.0.595 API)

java.lang.Object
- com.neeve.root.RootObject
- - com.neeve.ods.OdsObject
  - - com.neeve.ods.impl.StorePacketPersisterBase
    - - com.neeve.rog.log.RogLog

All Implemented Interfaces:: IEventSource, IStorePersister, IStoreReader, IStoreWriter

public final class RogLog
extends com.neeve.ods.impl.StorePacketPersisterBase
implements IStorePersister, IEventSource

The ROG transaction log

Nested Class Summary
- Nested classes/interfaces inherited from interface com.neeve.ods.IStorePersister
  IStorePersister.ErrorHandler, IStorePersister.LogEmptinessExpectation, IStorePersister.LogPresenceExpectation, IStorePersister.StartupExpectation
- Nested classes/interfaces inherited from interface com.neeve.ods.IStoreWriter
  IStoreWriter.LogCounters, IStoreWriter.Parameters
- Nested classes/interfaces inherited from interface com.neeve.ods.IStoreReader
  IStoreReader.IterativeReader, IStoreReader.ReadCallback

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PROP_AUTO_FLUSH_SIZE` Deprecated. use `PROP_WRITE_BUFFER_SIZE` instead.
`static String`	`PROP_AUTO_REPAIR` Property used to indicate whether should attempt to repair files on open.
`static boolean`	`PROP_AUTO_REPAIR_DEFAULT` The default value for `PROP_AUTO_REPAIR`.
`static String`	`PROP_CDC_ENABLED` Property used to indicate whether CDC is enabled on the log If CDC is not enabled, then a CDC processor run on a log will not dispatch any events.
`static boolean`	`PROP_CDC_ENABLED_DEFAULT` The default value for `PROP_CDC_ENABLED`.
`static String`	`PROP_DETACHED` Property used to indicate whether to persist in 'detached' mode
`static String`	`PROP_DETACHED_QUEUE_DEPTH` Property used to specify the depth of the detached thread feeder queue
`static String`	`PROP_DETACHED_QUEUE_DRAINER_CPU_AFFINITIZATION_MASK` Property used to specify the affinity mask of the detached thread.
`static String`	`PROP_DETACHED_QUEUE_OFFER_STRATEGY` Property used to specify the offer strategy of the detached thread feeder queue
`static String`	`PROP_DETACHED_QUEUE_WAIT_STRATEGY` Property used to specify the wait strategy of the detached thread feeder queue
`static String`	`PROP_FLUSH_ON_COMMIT` Property used to indicate whether a flush should be performed on commit.
`static String`	`PROP_FLUSH_USING_MAPPED_MEMORY` Property used to indicate that flush should be performed using a memory mapped region of the log rather than via a RandomAccessFile handle
`static boolean`	`PROP_FLUSH_USING_MAPPED_MEMORY_DEFAULT` The default value for `PROP_FLUSH_USING_MAPPED_MEMORY`.
`static String`	`PROP_INITIAL_LOG_LENGTH` Property used to set the initial file length of the log in gigabytes.
`static float`	`PROP_INITIAL_LOG_LENGTH_DEFAULT` The default value for `PROP_INITIAL_LOG_LENGTH`.
`static String`	`PROP_INTEGRITY_CHECK` Property used to indicate whether to perform an integrity check of the log on open Note:Specifying a value of false for this parameter automatically disables transaction integrity check
`static boolean`	`PROP_INTEGRITY_CHECK_DEFAULT` The default value for `PROP_INTEGRITY_CHECK`.
`static String`	`PROP_LOG_BACKUP_RETENTION_COUNT` Property used to indicate the maximum number of log backups to retain
`static int`	`PROP_LOG_BACKUP_RETENTION_COUNT_DEFAULT` The default value for `PROP_LOG_BACKUP_RETENTION_COUNT`.
`static String`	`PROP_LOG_EMPTINESS_EXPECTATION` Property used to specify the log's emptiness expectation This property can take the following values (caseless): - "empty" - "notempty" If this property is not set, then no expectation is assumed This expectation is checked for existing and freshly created logs
`static String`	`PROP_LOG_EMPTINESS_EXPECTATION_DEFAULT` The default value for `PROP_LOG_EMPTINESS_EXPECTATION`.
`static String`	`PROP_LOG_MODE` Property used to indicate that mode in which the log should be opened
`static String`	`PROP_LOG_PRESENCE_EXPECTATION` Property used to specify the log's presence expectation This property can take the following values (caseless): - "present" - "absent" If this property is not set, then no expectation is assumed
`static String`	`PROP_LOG_PRESENCE_EXPECTATION_DEFAULT` The default value for `PROP_LOG_PRESENCE_EXPECTATION`.
`static String`	`PROP_LOG_SCAVENGE_POLICY` Property used to indicate policy used to scavenge logs A log with number N is considered a candidate for scavenging when N < live log number and N < CDC log number.
`static String`	`PROP_LOG_SCAVENGE_POLICY_DEFAULT` The default value for `PROP_LOG_SCAVENGE_POLICY`.
`static String`	`PROP_PAGE_SIZE` Property used to specify the log's page size.
`static String`	`PROP_PAGE_SIZE_DEFAULT` The default value for `PROP_PAGE_SIZE`.
`static String`	`PROP_READ_BUFFER_SIZE` Property used to specify the log's read buffer size.
`static String`	`PROP_READ_BUFFER_SIZE_DEFAULT` The default value for `PROP_READ_BUFFER_SIZE`.
`static String`	`PROP_SHARED` Property used to indicate whether this a shared persister or not.
`static String`	`PROP_STORE_ROOT` Property used to indicate the directory in which the log should be placed.
`static String`	`PROP_TRANSACTIONAL_INTEGRITY_CHECK` Property used to indicate whether to do a transactional integrity check of the log on open Note:This property is only applicable if `PROP_INTEGRITY_CHECK` is true
`static boolean`	`PROP_TRANSACTIONAL_INTEGRITY_CHECK_DEFAULT` The default value for `PROP_TRANSACTIONAL_INTEGRITY_CHECK`.
`static String`	`PROP_WRITE_BUFFER_SIZE` Property used to specify the log's write buffer size.
`static String`	`PROP_WRITE_BUFFER_SIZE_DEFAULT` The default value for `PROP_WRITE_BUFFER_SIZE`.
`static String`	`PROP_ZERO_OUT_INITIAL` Property used to indicate whether the log should be zeroed out when freshly created This property is only applicable if `PROP_INITIAL_LOG_LENGTH` is set.
`static boolean`	`PROP_ZERO_OUT_INITIAL_DEFAULT` The default value for `PROP_ZERO_OUT_INITIAL`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`File`	`archive(File archiveFolder, String archiveId)` Archives a transaction log's files to the specified folder, using the given archive id.
`RogLogQueryRepository`	`asRepository()` Return the log as a query repository
`String`	`backupLog(boolean shrinkToSize)` Backup a persister's log file.
`static String`	`backupLog(String logName, Properties props, boolean shrinkToSize)` Convenience method for backing up a log file.
`void`	`close()` Implementation of `IStorePersister.close()`
`static RogLog`	`create(String name)` Create a new log.
`static RogLog`	`create(String name, Properties props)` Create a new log using a set of properties to configure it
`static RogLog`	`create(String name, StorePersisterDescriptor descriptor)` Create a new log using a store persister descriptor to configure it.
`RogLogCdcProcessor`	`createCdcProcessor(IRogChangeDataCaptureHandler handler)` Create a log CDC processor.
`RogLogReader`	`createReader()` Create a reader of the live log file.
`RogLogReader`	`createReader(int logNumber)` Create a private reader of the numbered log file.
`void`	`delete()` Delete a log file and associated metadata files
`void`	`fail()` Force fail the log.
`void`	`fail(Exception cause)` Force fail the log.
`static void`	`failOpen(boolean val)` Force fail the next open.
`long`	`getAllocatedSize()` Get the log file's allocated size.
`long`	`getCompactionThreshold()` Get the compaction threshold (in bytes).
`RogLogCompactor`	`getCompactor()` Get the log compactor
`StorePersisterDescriptor`	`getDescriptor()` Implementation of `IStorePersister.getDescriptor()` Note: This method will return null if the log was created directly using a property table rather than a store persister descriptor.
`IStorePersister.ErrorHandler`	`getErrorHandler()` Implementation of `IStorePersister.getErrorHandler()`
`IEventHandler`	`getEventHandler()` Get a persister's event handler.
`File`	`getLogFile()` Get the underlying log file
`com.eaio.uuid.UUID`	`getLogUUID()` Get the log UUID.
`RogLogMetadata`	`getMetadata()` Get the log metadata
`File`	`getMetadataFile()` Get the underlying log metadata file
`String`	`getName()` Implementation of `IStorePersister.getName()`
`com.neeve.pkt.log.PktRecoveryLog`	`getPacketLog()` Get the backing packet log
`long`	`getSize()` Get the log file size.
`IStorePersisterStats`	`getStats()` Implementation of `IStorePersister.getStats()`
`boolean`	`isCompactionEnabled()` Get if compaction is enabled
`boolean`	`isOpen()` Implementation of `IStorePersister.isOpen()`
`IStoreReader.IterativeReader`	`iterativeReader(int flags)` Implementation of `IStoreReader.iterativeReader(int)`
`void`	`open()` Implementation of `IStorePersister.open(com.neeve.io.IOElasticBuffer, int, boolean, boolean)`
`void`	`open(boolean concurrentReadWrite)` Implementation of `IStorePersister.open(boolean)`
`void`	`open(IOElasticBuffer serializedMetadata, int serializedMetadataOffset, boolean truncateLive)` Implementation of `IStorePersister.open(IOElasticBuffer, int, boolean)`
`void`	`open(IOElasticBuffer serializedMetadata, int serializedMetadataOffset, boolean truncateLive, boolean concurrentReadWrite)` Implementation of `IStorePersister.open(IOElasticBuffer, int boolean, boolean)`
`boolean`	`read(IStoreReader.ReadCallback cb)` Implementation of `IStoreReader.read(com.neeve.ods.IStoreReader.ReadCallback)`
`boolean`	`read(IStoreReader.ReadCallback cb, int flags)` Implementation of `IStoreReader.read(com.neeve.ods.IStoreReader.ReadCallback)`
`void`	`readMetadata(IOElasticBuffer buffer)` Implementation of `IStoreReader.readMetadata(com.neeve.io.IOElasticBuffer)`
`void`	`scheduleCompaction()` Schedule a log compaction
`void`	`scheduleCompactionOnNextWrite()` Deprecated. Use `scheduleCompaction()` instead
`void`	`setCompactionThreshold(int val)` Set the compaction threshold.
`void`	`setErrorHandler(IStorePersister.ErrorHandler errorHandler)` Implementation of `IStorePersister.setErrorHandler(com.neeve.ods.IStorePersister.ErrorHandler)`
`void`	`setEventHandler(IEventHandler eventHandler)` Set a persister's event handler.
`void`	`setStartupExpectation(IStorePersister.StartupExpectation expectation, Enum<?> value)` Implementation of `IStorePersister.setStartupExpectation(com.neeve.ods.IStorePersister.StartupExpectation, java.lang.Enum<?>)`
`String`	`toString()`
`boolean`	`wasRepaired()` Implementation of `IStorePersister.wasRepaired()`

Methods inherited from class com.neeve.ods.impl.StorePacketPersisterBase
flush, getParameters, isShared, onRoleChange, writeCommitEntry

Methods inherited from class com.neeve.root.RootObject
getChecked, getThreaded, getTracer

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.neeve.ods.IStoreWriter
flush, getParameters, isShared, onRoleChange, writeCommitEntry

- Field Detail
  - PROP_STORE_ROOT
```
public static final String PROP_STORE_ROOT
```
    Property used to indicate the directory in which the log should be placed.
    
    See Also:
    
    Constant Field Values
  - PROP_LOG_MODE
```
public static final String PROP_LOG_MODE
```
    Property used to indicate that mode in which the log should be opened
    
    See Also:
    
    Constant Field Values
  - PROP_SHARED
```
public static final String PROP_SHARED
```
    Property used to indicate whether this a shared persister or not.
    
    See Also:
    
    StorePacketPersisterBase.PROP_SHARED, Constant Field Values
  - PROP_LOG_PRESENCE_EXPECTATION
```
public static final String PROP_LOG_PRESENCE_EXPECTATION
```
    Property used to specify the log's presence expectation
    This property can take the following values (caseless):
    - "present"
    - "absent"
    If this property is not set, then no expectation is assumed
    
    See Also:
    
    Constant Field Values
  - PROP_LOG_PRESENCE_EXPECTATION_DEFAULT
```
public static final String PROP_LOG_PRESENCE_EXPECTATION_DEFAULT
```
    The default value for PROP_LOG_PRESENCE_EXPECTATION.
  - PROP_LOG_EMPTINESS_EXPECTATION
```
public static final String PROP_LOG_EMPTINESS_EXPECTATION
```
    Property used to specify the log's emptiness expectation
    This property can take the following values (caseless):
    - "empty"
    - "notempty"
    If this property is not set, then no expectation is assumed
    
    This expectation is checked for existing and freshly created logs
    
    See Also:
    
    Constant Field Values
  - PROP_LOG_EMPTINESS_EXPECTATION_DEFAULT
```
public static final String PROP_LOG_EMPTINESS_EXPECTATION_DEFAULT
```
    The default value for PROP_LOG_EMPTINESS_EXPECTATION.
  - PROP_INTEGRITY_CHECK
```
public static final String PROP_INTEGRITY_CHECK
```
    Property used to indicate whether to perform an integrity check of the log on open
    Note:Specifying a value of false for this parameter automatically disables transaction integrity check
    
    See Also:
    
    PROP_TRANSACTIONAL_INTEGRITY_CHECK, Constant Field Values
  - PROP_INTEGRITY_CHECK_DEFAULT
```
public static final boolean PROP_INTEGRITY_CHECK_DEFAULT
```
    The default value for PROP_INTEGRITY_CHECK.
    
    See Also:
    
    Constant Field Values
  - PROP_TRANSACTIONAL_INTEGRITY_CHECK
```
public static final String PROP_TRANSACTIONAL_INTEGRITY_CHECK
```
    Property used to indicate whether to do a transactional integrity check of the log on open
    Note:This property is only applicable if PROP_INTEGRITY_CHECK is true
    
    See Also:
    
    PROP_INTEGRITY_CHECK, Constant Field Values
  - PROP_TRANSACTIONAL_INTEGRITY_CHECK_DEFAULT
```
public static final boolean PROP_TRANSACTIONAL_INTEGRITY_CHECK_DEFAULT
```
    The default value for PROP_TRANSACTIONAL_INTEGRITY_CHECK.
    
    See Also:
    
    Constant Field Values
  - PROP_AUTO_REPAIR
```
public static final String PROP_AUTO_REPAIR
```
    Property used to indicate whether should attempt to repair files on open.
    
    See Also:
    
    Constant Field Values
  - PROP_AUTO_REPAIR_DEFAULT
```
public static final boolean PROP_AUTO_REPAIR_DEFAULT
```
    The default value for PROP_AUTO_REPAIR.
    
    See Also:
    
    Constant Field Values
  - PROP_INITIAL_LOG_LENGTH
```
public static final String PROP_INITIAL_LOG_LENGTH
```
    Property used to set the initial file length of the log in gigabytes.
    The initial length of the recovery log this can be set to the maximum size to which the log is expected to grow to avoid costs with growing the file.
    
    See Also:
    
    Constant Field Values
  - PROP_INITIAL_LOG_LENGTH_DEFAULT
```
public static final float PROP_INITIAL_LOG_LENGTH_DEFAULT
```
    The default value for PROP_INITIAL_LOG_LENGTH.
    
    See Also:
    
    Constant Field Values
  - PROP_ZERO_OUT_INITIAL
```
public static final String PROP_ZERO_OUT_INITIAL
```
    Property used to indicate whether the log should be zeroed out when freshly created
    This property is only applicable if PROP_INITIAL_LOG_LENGTH is set. If set to true, then the log is zeroed out after initial creation.
    
    See Also:
    
    Constant Field Values
  - PROP_ZERO_OUT_INITIAL_DEFAULT
```
public static final boolean PROP_ZERO_OUT_INITIAL_DEFAULT
```
    The default value for PROP_ZERO_OUT_INITIAL.
    
    See Also:
    
    Constant Field Values
  - PROP_LOG_BACKUP_RETENTION_COUNT
```
public static final String PROP_LOG_BACKUP_RETENTION_COUNT
```
    Property used to indicate the maximum number of log backups to retain
    
    See Also:
    
    Constant Field Values
  - PROP_LOG_BACKUP_RETENTION_COUNT_DEFAULT
```
public static final int PROP_LOG_BACKUP_RETENTION_COUNT_DEFAULT
```
    The default value for PROP_LOG_BACKUP_RETENTION_COUNT.
    
    See Also:
    
    Constant Field Values
  - PROP_LOG_SCAVENGE_POLICY
```
public static final String PROP_LOG_SCAVENGE_POLICY
```
    Property used to indicate policy used to scavenge logs
    A log with number N is considered a candidate for scavenging when N < live log number and N < CDC log number. This parameter specifies how such logs need to be scavenged. Currently, the only permissible value is 'Delete'
    
    See Also:
    
    Constant Field Values
  - PROP_LOG_SCAVENGE_POLICY_DEFAULT
```
public static final String PROP_LOG_SCAVENGE_POLICY_DEFAULT
```
    The default value for PROP_LOG_SCAVENGE_POLICY.
  - PROP_CDC_ENABLED
```
public static final String PROP_CDC_ENABLED
```
    Property used to indicate whether CDC is enabled on the log
    If CDC is not enabled, then a CDC processor run on a log will not dispatch any events. If CDC is not enabled on a log and then reenabled later, CDC will start from the live log at the time the CDC is enabled. If a compaction occurred while CDC was disabled, then the change events that occurred during that time will be lost.
    
    See Also:
    
    Constant Field Values
  - PROP_CDC_ENABLED_DEFAULT
```
public static final boolean PROP_CDC_ENABLED_DEFAULT
```
    The default value for PROP_CDC_ENABLED.
    
    See Also:
    
    Constant Field Values
  - PROP_FLUSH_USING_MAPPED_MEMORY
```
public static final String PROP_FLUSH_USING_MAPPED_MEMORY
```
    Property used to indicate that flush should be performed using a memory mapped region of the log rather than via a RandomAccessFile handle
    
    See Also:
    
    Constant Field Values
  - PROP_FLUSH_USING_MAPPED_MEMORY_DEFAULT
```
public static final boolean PROP_FLUSH_USING_MAPPED_MEMORY_DEFAULT
```
    The default value for PROP_FLUSH_USING_MAPPED_MEMORY.
    
    See Also:
    
    Constant Field Values
  - PROP_READ_BUFFER_SIZE
```
public static final String PROP_READ_BUFFER_SIZE
```
    Property used to specify the log's read buffer size.
    
    See Also:
    
    Constant Field Values
  - PROP_READ_BUFFER_SIZE_DEFAULT
```
public static final String PROP_READ_BUFFER_SIZE_DEFAULT
```
    The default value for PROP_READ_BUFFER_SIZE.
    
    See Also:
    
    Constant Field Values
  - PROP_WRITE_BUFFER_SIZE
```
public static final String PROP_WRITE_BUFFER_SIZE
```
    Property used to specify the log's write buffer size.
    
    See Also:
    
    Constant Field Values
  - PROP_WRITE_BUFFER_SIZE_DEFAULT
```
public static final String PROP_WRITE_BUFFER_SIZE_DEFAULT
```
    The default value for PROP_WRITE_BUFFER_SIZE.
    
    See Also:
    
    Constant Field Values
  - PROP_AUTO_FLUSH_SIZE
```
@Deprecated
public static final String PROP_AUTO_FLUSH_SIZE
```
    Deprecated. use PROP_WRITE_BUFFER_SIZE instead.
    
    Property used to specify the log's auto flush size.
    
    See Also:
    
    Constant Field Values
  - PROP_PAGE_SIZE
```
public static final String PROP_PAGE_SIZE
```
    Property used to specify the log's page size.
    
    See Also:
    
    Constant Field Values
  - PROP_PAGE_SIZE_DEFAULT
```
public static final String PROP_PAGE_SIZE_DEFAULT
```
    The default value for PROP_PAGE_SIZE.
    
    See Also:
    
    Constant Field Values
  - PROP_FLUSH_ON_COMMIT
```
public static final String PROP_FLUSH_ON_COMMIT
```
    Property used to indicate whether a flush should be performed on commit.
    
    See Also:
    
    StorePacketPersisterBase.PROP_FLUSH_ON_COMMIT, Constant Field Values
  - PROP_DETACHED
```
public static final String PROP_DETACHED
```
    Property used to indicate whether to persist in 'detached' mode
    
    See Also:
    
    StorePacketPersisterBase.PROP_DETACHED, Constant Field Values
  - PROP_DETACHED_QUEUE_DEPTH
```
public static final String PROP_DETACHED_QUEUE_DEPTH
```
    Property used to specify the depth of the detached thread feeder queue
    
    See Also:
    
    StorePacketPersisterBase.PROP_DETACHED_QUEUE_DEPTH, Constant Field Values
  - PROP_DETACHED_QUEUE_OFFER_STRATEGY
```
public static final String PROP_DETACHED_QUEUE_OFFER_STRATEGY
```
    Property used to specify the offer strategy of the detached thread feeder queue
    
    See Also:
    
    StorePacketPersisterBase.PROP_DETACHED_QUEUE_OFFER_STRATEGY, Constant Field Values
  - PROP_DETACHED_QUEUE_WAIT_STRATEGY
```
public static final String PROP_DETACHED_QUEUE_WAIT_STRATEGY
```
    Property used to specify the wait strategy of the detached thread feeder queue
    
    See Also:
    
    StorePacketPersisterBase.PROP_DETACHED_QUEUE_WAIT_STRATEGY, Constant Field Values
  - PROP_DETACHED_QUEUE_DRAINER_CPU_AFFINITIZATION_MASK
```
public static final String PROP_DETACHED_QUEUE_DRAINER_CPU_AFFINITIZATION_MASK
```
    Property used to specify the affinity mask of the detached thread.
    
    See Also:
    
    StorePacketPersisterBase.PROP_DETACHED_QUEUE_DRAINER_CPU_AFFINITIZATION_MASK, Constant Field Values
- Method Detail
  - create
```
public static final RogLog create(String name,
                                  Properties props)
                           throws OdsException
```
    Create a new log using a set of properties to configure it
    
    Parameters:
    
    name - The name of the log
    
    props - Properties to configure the log.
    
    Throws:
    
    OdsException
  - create
```
public static final RogLog create(String name)
                           throws OdsException
```
    Create a new log.
    This method calls create(name, (Properties)null)
    
    Throws:
    
    OdsException
  - create
```
public static final RogLog create(String name,
                                  StorePersisterDescriptor descriptor)
                           throws OdsException
```
    Create a new log using a store persister descriptor to configure it.
    
    Parameters:
    
    name - The name of the log
    
    descriptor - The store persister descriptor used to configure the log
    
    Throws:
    
    OdsException
  - failOpen
```
public static final void failOpen(boolean val)
```
    Force fail the next open.
  - backupLog
```
public static final String backupLog(String logName,
                                     Properties props,
                                     boolean shrinkToSize)
                              throws Exception
```
    Convenience method for backing up a log file.
    
    Parameters:
    
    logName - The log file name
    
    props - The log properties
    
    shrinkToSize - If the log should be shrinked down to size.
    
    Returns:
    
    The name of the backed up file.
    
    Throws:
    
    Exception - If ther is an error backing up the log
  - getPacketLog
```
public final com.neeve.pkt.log.PktRecoveryLog getPacketLog()
```
    Get the backing packet log
  - getLogFile
```
public final File getLogFile()
```
    Get the underlying log file
  - getMetadataFile
```
public final File getMetadataFile()
```
    Get the underlying log metadata file
  - getMetadata
```
public final RogLogMetadata getMetadata()
```
    Get the log metadata
  - getCompactionThreshold
```
public final long getCompactionThreshold()
```
    Get the compaction threshold (in bytes).
    
    Returns:
    
    the compaction threshold in bytes.
  - isCompactionEnabled
```
public final boolean isCompactionEnabled()
```
    Get if compaction is enabled
    
    Returns:
    
    whether compaction is enabled or not
  - setCompactionThreshold
```
public final void setCompactionThreshold(int val)
```
    Set the compaction threshold.
    
    Parameters:
    
    val - The compaction threshold to set in megabytes. A value of 0 will switch off compaction
    
    Threading:
    
    This method can be invoked fron any thread
  - scheduleCompactionOnNextWrite
```
@Deprecated
public final void scheduleCompactionOnNextWrite()
```
    Deprecated. Use scheduleCompaction() instead
    
    Schedule a compaction
  - scheduleCompaction
```
public final void scheduleCompaction()
```
    Schedule a log compaction
  - delete
```
public final void delete()
                  throws IOException
```
    Delete a log file and associated metadata files
    
    Throws:
    
    IOException
  - backupLog
```
public final String backupLog(boolean shrinkToSize)
                       throws Exception
```
    Backup a persister's log file.
    
    Parameters:
    
    shrinkToSize - Specifies whether the backed up file should be shrunk to the amount of space actually used in the file.
    
    Returns:
    
    Returns the fully qualified backup file name.
    
    Throws:
    
    IllegalStateException - Thrown if this method is invoked after the persister has been opened.
    This method backs up the persister's transaction log file. The method first shrinks the log to the amount of space actually used in the log (only if shrinkToSize is set to true) and then renames the log to a log named by appending the current date and time to the log file name. The backup file name is returned by the method.
    
    Exception
  - setStartupExpectation
```
public final void setStartupExpectation(IStorePersister.StartupExpectation expectation,
                                        Enum<?> value)
```
    Implementation of IStorePersister.setStartupExpectation(com.neeve.ods.IStorePersister.StartupExpectation, java.lang.Enum<?>)
    
    Specified by:
    
    setStartupExpectation in interface IStorePersister
  - open
```
public final void open(IOElasticBuffer serializedMetadata,
                       int serializedMetadataOffset,
                       boolean truncateLive,
                       boolean concurrentReadWrite)
                throws Exception
```
    Implementation of IStorePersister.open(IOElasticBuffer, int boolean, boolean)
    
    Specified by:
    
    open in interface IStorePersister
    
    Parameters:
    
    serializedMetadata - Buffer containined the serialized form of the metadata to use for the log being opened. A value of null indicates that the existing metadata be used for the log and, if any metadata does not exist, then start with a fresh metadata object
    
    serializedMetadataOffset - The offset into the serialized metadata buffer where the serialized form of the metadata starts
    
    truncateLive - If true, then the live log file is truncated during open. If metadata is supplied to this method, then the live log is determined from that metadata.
    
    concurrentReadWrite - If true, the log is opened in a manner that permits for concurrent read/write to occur on the log.
    
    Throws:
    
    Exception
  - open
```
public final void open(IOElasticBuffer serializedMetadata,
                       int serializedMetadataOffset,
                       boolean truncateLive)
                throws Exception
```
    Implementation of IStorePersister.open(IOElasticBuffer, int, boolean)
    
    Specified by:
    
    open in interface IStorePersister
    
    Throws:
    
    Exception
  - open
```
public final void open(boolean concurrentReadWrite)
                throws Exception
```
    Implementation of IStorePersister.open(boolean)
    
    Specified by:
    
    open in interface IStorePersister
    
    Parameters:
    
    concurrentReadWrite - If true, the log is opened in a manner that permits for concurrent read/write to occur on the log.
    Invoking this method is equivalent to invoking open(null, false, concurrentReadWrite)
    
    Throws:
    
    Exception
  - open
```
public final void open()
                throws Exception
```
    Implementation of IStorePersister.open(com.neeve.io.IOElasticBuffer, int, boolean, boolean)
    
    Specified by:
    
    open in interface IStorePersister
    
    Throws:
    
    Exception
  - getLogUUID
```
public final com.eaio.uuid.UUID getLogUUID()
```
    Get the log UUID.
    
    Returns:
    
    The UUID for this log file.
  - isOpen
```
public final boolean isOpen()
```
    Implementation of IStorePersister.isOpen()
    
    Specified by:
    
    isOpen in interface IStorePersister
  - getName
```
public final String getName()
```
    Implementation of IStorePersister.getName()
    
    Specified by:
    
    getName in interface IEventSource
    
    Specified by:
    
    getName in interface IStorePersister
  - getDescriptor
```
public final StorePersisterDescriptor getDescriptor()
```
    Implementation of IStorePersister.getDescriptor()
    Note: This method will return null if the log was created directly using a property table rather than a store persister descriptor.
    
    Specified by:
    
    getDescriptor in interface IStorePersister
  - setErrorHandler
```
public final void setErrorHandler(IStorePersister.ErrorHandler errorHandler)
```
    Implementation of IStorePersister.setErrorHandler(com.neeve.ods.IStorePersister.ErrorHandler)
    
    Specified by:
    
    setErrorHandler in interface IStorePersister
  - getErrorHandler
```
public final IStorePersister.ErrorHandler getErrorHandler()
```
    Implementation of IStorePersister.getErrorHandler()
    
    Specified by:
    
    getErrorHandler in interface IStorePersister
  - setEventHandler
```
public final void setEventHandler(IEventHandler eventHandler)
```
    Description copied from interface: IStorePersister
    
    Set a persister's event handler.
    
    Specified by:
    
    setEventHandler in interface IStorePersister
    
    Parameters:
    
    eventHandler - The event handler for the persister.
  - getEventHandler
```
public IEventHandler getEventHandler()
```
    Description copied from interface: IStorePersister
    
    Get a persister's event handler.
    
    Specified by:
    
    getEventHandler in interface IStorePersister
  - getStats
```
public final IStorePersisterStats getStats()
```
    Implementation of IStorePersister.getStats()
    
    Specified by:
    
    getStats in interface IStorePersister
  - wasRepaired
```
public final boolean wasRepaired()
```
    Implementation of IStorePersister.wasRepaired()
    
    Specified by:
    
    wasRepaired in interface IStorePersister
  - readMetadata
```
public final void readMetadata(IOElasticBuffer buffer)
```
    Implementation of IStoreReader.readMetadata(com.neeve.io.IOElasticBuffer)
    
    Specified by:
    
    readMetadata in interface IStoreReader
    
    Parameters:
    
    buffer - The buffer to read the (serialized form of) metadata into
  - iterativeReader
```
public final IStoreReader.IterativeReader iterativeReader(int flags)
                                                   throws Exception
```
    Implementation of IStoreReader.iterativeReader(int)
    
    Specified by:
    
    iterativeReader in interface IStoreReader
    
    Parameters:
    
    flags - Flags that qualify read operations.
    
    Throws:
    
    Exception
  - read
```
public final boolean read(IStoreReader.ReadCallback cb)
                   throws Exception
```
    Implementation of IStoreReader.read(com.neeve.ods.IStoreReader.ReadCallback)
    
    Specified by:
    
    read in interface IStoreReader
    
    Parameters:
    
    cb - The callback used to return the read entries to the caller.
    
    Returns:
    
    Returns true if the full log has been read and false if the read was suspended by the callback
    
    Throws:
    
    Exception
  - read
```
public final boolean read(IStoreReader.ReadCallback cb,
                          int flags)
                   throws Exception
```
    Implementation of IStoreReader.read(com.neeve.ods.IStoreReader.ReadCallback)
    
    Specified by:
    
    read in interface IStoreReader
    
    Parameters:
    
    cb - The callback used to return the read entries to the caller.
    
    flags - Flags that qualify read operations.
    
    Returns:
    
    Returns true if the full log has been read and false if the read was suspended by the callback
    
    Throws:
    
    Exception
  - createReader
```
public final RogLogReader createReader()
                                throws Exception
```
    Create a reader of the live log file.
    
    Returns:
    
    A RogLogReader instance.
    
    Throws:
    
    Exception - If there is an error creating the RogLogReader
  - createReader
```
public final RogLogReader createReader(int logNumber)
                                throws Exception
```
    Create a private reader of the numbered log file.
    
    Returns:
    
    A private RogLogReader instance.
    
    Throws:
    
    Exception - If there is an error creating the RogLogReader
    This method creates a private log reader of a specific numbered log file.
  - createCdcProcessor
```
public final RogLogCdcProcessor createCdcProcessor(IRogChangeDataCaptureHandler handler)
                                            throws Exception
```
    Create a log CDC processor.
    Note that only one CDC processor can be created per log.
    
    Returns:
    
    A CDC processor that can be used to fetch compacted log entries.
    
    Throws:
    
    Exception - If there is an error creating the RogLogReader
  - getSize
```
public final long getSize()
```
    Get the log file size.
    This method returns the amount of space used in the log file, including data that is buffered for write, but not yet flushed.
    
    Returns:
    
    Returns the log's log file size.
    
    Throws:
    
    IllegalStateException - Thrown if this method is invoked before the log has been opened.
  - getAllocatedSize
```
public final long getAllocatedSize()
```
    Get the log file's allocated size.
    This method returns the actual size of the log file currently allocated. This call differs from getSize() in that this value may be greater if the log has been preallocated to a larger size.
    
    Returns:
    
    Returns the log's log file size.
    
    Throws:
    
    IllegalStateException - Thrown if this method is invoked before the log has been opened.
  - fail
```
public final void fail(Exception cause)
```
    Force fail the log.
    
    Specified by:
    
    fail in interface IStorePersister
    
    Parameters:
    
    cause - The cause of the failure.
    CAUTION: This method is only for testing purposes and should not be invoked outside of test frameworks.
    
    This method invokes the error handler if installed and marks the log has failed. This will cause all subsequent commits or syncs to immediately fail with a runtime exception.
  - fail
```
public final void fail()
```
    Force fail the log.
    This method invokes the following:
    
    fail(new OdsException("force failed by user"))
    
    Specified by:
    
    fail in interface IStorePersister
  - asRepository
```
public final RogLogQueryRepository asRepository()
```
    Return the log as a query repository
  - getCompactor
```
public final RogLogCompactor getCompactor()
```
    Get the log compactor
  - archive
```
public final File archive(File archiveFolder,
                          String archiveId)
                   throws IOException
```
    Archives a transaction log's files to the specified folder, using the given archive id.
    
    Parameters:
    
    archiveFolder - The folder to which to archive this transaction log's files.
    
    archiveId - The archive id with which to suffix archived files.
    
    Returns:
    
    The archived log file
    
    Throws:
    
    IOException - If there is an error creating the backup files.
    
    IllegalStateException - If the transaction log is not in a state where it can be archived (e.g. open)
  - close
```
public final void close()
```
    Implementation of IStorePersister.close()
    
    Specified by:
    
    close in interface IStorePersister
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RogLog

Nested Class Summary

Nested classes/interfaces inherited from interface com.neeve.ods.IStorePersister

Nested classes/interfaces inherited from interface com.neeve.ods.IStoreWriter

Nested classes/interfaces inherited from interface com.neeve.ods.IStoreReader

Field Summary

Method Summary

Methods inherited from class com.neeve.ods.impl.StorePacketPersisterBase

Methods inherited from class com.neeve.root.RootObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.neeve.ods.IStoreWriter

Field Detail

PROP_STORE_ROOT

PROP_LOG_MODE

PROP_SHARED

PROP_LOG_PRESENCE_EXPECTATION

PROP_LOG_PRESENCE_EXPECTATION_DEFAULT

PROP_LOG_EMPTINESS_EXPECTATION

PROP_LOG_EMPTINESS_EXPECTATION_DEFAULT

PROP_INTEGRITY_CHECK

PROP_INTEGRITY_CHECK_DEFAULT

PROP_TRANSACTIONAL_INTEGRITY_CHECK

PROP_TRANSACTIONAL_INTEGRITY_CHECK_DEFAULT

PROP_AUTO_REPAIR

PROP_AUTO_REPAIR_DEFAULT

PROP_INITIAL_LOG_LENGTH

PROP_INITIAL_LOG_LENGTH_DEFAULT

PROP_ZERO_OUT_INITIAL

PROP_ZERO_OUT_INITIAL_DEFAULT

PROP_LOG_BACKUP_RETENTION_COUNT

PROP_LOG_BACKUP_RETENTION_COUNT_DEFAULT

PROP_LOG_SCAVENGE_POLICY

PROP_LOG_SCAVENGE_POLICY_DEFAULT

PROP_CDC_ENABLED

PROP_CDC_ENABLED_DEFAULT

PROP_FLUSH_USING_MAPPED_MEMORY

PROP_FLUSH_USING_MAPPED_MEMORY_DEFAULT

PROP_READ_BUFFER_SIZE

PROP_READ_BUFFER_SIZE_DEFAULT

PROP_WRITE_BUFFER_SIZE

PROP_WRITE_BUFFER_SIZE_DEFAULT

PROP_AUTO_FLUSH_SIZE

PROP_PAGE_SIZE

PROP_PAGE_SIZE_DEFAULT

PROP_FLUSH_ON_COMMIT

PROP_DETACHED

PROP_DETACHED_QUEUE_DEPTH

PROP_DETACHED_QUEUE_OFFER_STRATEGY

PROP_DETACHED_QUEUE_WAIT_STRATEGY

PROP_DETACHED_QUEUE_DRAINER_CPU_AFFINITIZATION_MASK

Method Detail

create

create

create

failOpen

backupLog

getPacketLog

getLogFile

getMetadataFile

getMetadata

getCompactionThreshold

isCompactionEnabled

setCompactionThreshold

scheduleCompactionOnNextWrite

scheduleCompaction

delete

backupLog

setStartupExpectation

open

open

open

open

getLogUUID

isOpen

getName

getDescriptor

setErrorHandler

getErrorHandler

setEventHandler

getEventHandler