net.sf.joafip.kvstore.entity

Class HeapFileSetup

java.lang.Object

net.sf.joafip.kvstore.entity.HeapFileSetup

@NotStorableClass
public class HeapFileSetup
extends Object

heap file setup

Author:

luc peuvrier

Constructor Summary

Constructors

Constructor and Description
HeapFileSetup(EnumFileAccessMode fileAccessMode, File dataFile, boolean crashSafeMode, boolean useCacheMode, boolean deleteRenaming, boolean clearResizeFile, int maxFileOperationRetry, int fileOperationRetryMsDelay, File openFileTraceFile)

Method Summary

Methods

Modifier and Type	Method and Description
void	cacheSetup(int pageSize, int maxPage) setup of cache parameters
void	crashSafeSetup(File backupDataFile, File stateOkFlagFile, File stateBackupOkFlagFile, File globalStateFlagFile) setup of crash safe mode parameters
void	fileBufferSetup(int maxBufferSize, int maxNumberOfBuffer)
File	getBackupDataFile()
FileAccessParameter	getBackupFileAccessParameter()
File	getDataFile()
FileAccessParameter	getDataFileAccessParameter()
EnumFileAccessMode	getFileAccessMode()
int	getFileOperationRetryMsDelay()
File	getGlobalStateFlagFile()
int	getMaxFileOperationRetry()
int	getMaxPage()
File	getOpenFileTraceFile()
int	getPageSize()
File	getStateBackupOkFlagFile()
File	getStateOkFlagFile()
boolean	isClearResizeFile()
boolean	isCrashSafeMode()
boolean	isDeleteRenaming()
boolean	isUseCacheMode()

Methods inherited from class java.lang.Object

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

Constructor Detail

HeapFileSetup

public HeapFileSetup(EnumFileAccessMode fileAccessMode,
             File dataFile,
             boolean crashSafeMode,
             boolean useCacheMode,
             boolean deleteRenaming,
             boolean clearResizeFile,
             int maxFileOperationRetry,
             int fileOperationRetryMsDelay,
             File openFileTraceFile)
              throws HeapException

Parameters:

fileAccessMode -

dataFile - the file for the heap

crashSafeMode - true if crash safe mode enabled

useCacheMode - true if use cache

deleteRenaming -

clearResizeFile -

maxFileOperationRetry -

fileOperationRetryMsDelay -

Throws:

HeapException

Method Detail

cacheSetup

public void cacheSetup(int pageSize,
              int maxPage)
                throws HeapException

setup of cache parameters

Parameters:

pageSize - page size ( number of byte ), must be greater or equals to 1024, set only if use cache enabled

maxPage - maximum number of page for read cache, set only if use cache enabled

Throws:

HeapException - use cache mode not enabled

crashSafeSetup

public void crashSafeSetup(File backupDataFile,
                  File stateOkFlagFile,
                  File stateBackupOkFlagFile,
                  File globalStateFlagFile)
                    throws HeapException

setup of crash safe mode parameters

Parameters:

backupDataFile - the backup file for the heap

stateOkFlagFile - file used has flag for data file on stable state

stateBackupOkFlagFile - file used has flag for backup data file on stable state

globalStateFlagFile - file indicating backup and data file stable state

Throws:

HeapException - crash safe mode not enable

fileBufferSetup

public void fileBufferSetup(int maxBufferSize,
                   int maxNumberOfBuffer)
                     throws HeapException

Throws:

HeapException

getBackupDataFile

public File getBackupDataFile()
                       throws HeapException

Throws:

HeapException

isCrashSafeMode

public boolean isCrashSafeMode()

getDataFile

public File getDataFile()

getGlobalStateFlagFile

public File getGlobalStateFlagFile()
                            throws HeapException

Throws:

HeapException

getMaxPage

public int getMaxPage()
               throws HeapException

Throws:

HeapException

getPageSize

public int getPageSize()
                throws HeapException

Throws:

HeapException

getStateBackupOkFlagFile

public File getStateBackupOkFlagFile()
                              throws HeapException

Throws:

HeapException

getStateOkFlagFile

public File getStateOkFlagFile()
                        throws HeapException

Throws:

HeapException

isUseCacheMode

public boolean isUseCacheMode()

isDeleteRenaming

public boolean isDeleteRenaming()

isClearResizeFile

public boolean isClearResizeFile()

getMaxFileOperationRetry

public int getMaxFileOperationRetry()

getFileOperationRetryMsDelay

public int getFileOperationRetryMsDelay()

getOpenFileTraceFile

public File getOpenFileTraceFile()

getFileAccessMode

public EnumFileAccessMode getFileAccessMode()

getDataFileAccessParameter

public FileAccessParameter getDataFileAccessParameter()
                                               throws HeapException

Throws:

HeapException

getBackupFileAccessParameter

public FileAccessParameter getBackupFileAccessParameter()
                                                 throws HeapException

Throws:

HeapException