net.sf.joafip.service

Class FilePersistenceBuilder

java.lang.Object

net.sf.joafip.service.FilePersistenceBuilder

@NoStorableAccess
public class FilePersistenceBuilder
extends Object

Author:

luc peuvrier

Constructor Summary

Constructors

Constructor and Description
FilePersistenceBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
IFilePersistence	build()
void	fileBufferSetup(int maxNumberOfBuffer, int maxBufferSize)
FilePersistenceProperties	getFilePersistenceProperties()
void	setAutoSaveEnabled(boolean autoSaveEnabled)
void	setBackgroundGarbageSweepEnabled(boolean backgroundGarbageSweepEnabled)
void	setBackgroundGarbageSweepSleepTime(int backgroundGarbageSweepSleepTime)
void	setBackupDataFileName(String backupDataFileName)
void	setCrashSafeMode(boolean crashSafeMode)
void	setDataFileName(String dataFileName)
void	setDataManager(IHeapDataManager dataManager)
void	setDataModelConversionDefInputStream(InputStreamAndSource dataModelConversionDefInputStream)
void	setDataModelIdentifier(int dataModelIdentifier)
void	setFileAccessMode(EnumFileAccessMode fileAccessMode)
void	setFileCache(int pageSize, int maxPage) file cache used
void	setFileOperationRetryMsDelay(int fileOperationRetryMsDelay)
void	setGarbageManagement(boolean garbageManagement)
void	setGlobalStateFlagFileName(String globalStateFlagFileName)
void	setMaintenedInMemory(boolean maintenedInMemory)
void	setMaintenedInMemoryQuota(int maintenedInMemoryQuota)
void	setMaxBufferSize(int maxBufferSize)
void	setMaxFileOperationRetry(int maxFileOperationRetry)
void	setMaxInMemoryThreshold(int maxInMemoryThreshold)
void	setMaxNumberOfBuffer(int maxNumberOfBuffer)
void	setNoMoreDataAction(EnumNoMoreDataAction noMoreDataAction)
void	setPathName(String pathName)
void	setProxyMode(boolean proxyMode)
void	setRecordSaveActions(boolean recordSaveActions)
void	setRemoveFiles(boolean removeFiles)
void	setStateBackupOkFlagFileName(String stateBackupOkFlagFileName)
void	setStateOkFlagFileName(String stateOkFlagFileName)
void	setStoreOnlyMarkedStorable(boolean storeOnlyMarkedStorable)
void	setSubsOfJavaUtil(boolean subsOfJavaUtil)
void	setZipCompressionLevel(int zipCompressionLevel)
void	setZipCompressionLevelSetted(boolean zipCompressionLevelSetted)

Methods inherited from class java.lang.Object

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

Constructor Detail

FilePersistenceBuilder

public FilePersistenceBuilder()

Method Detail

setDataModelIdentifier

public void setDataModelIdentifier(int dataModelIdentifier)

Parameters:

dataModelIdentifier - current data model identifier

setDataModelConversionDefInputStream

public void setDataModelConversionDefInputStream(InputStreamAndSource dataModelConversionDefInputStream)

Parameters:

dataModelConversionDefInputStream - input stream of conversion definition for data model

setFileAccessMode

public void setFileAccessMode(EnumFileAccessMode fileAccessMode)

setMaxNumberOfBuffer

public void setMaxNumberOfBuffer(int maxNumberOfBuffer)

setMaxBufferSize

public void setMaxBufferSize(int maxBufferSize)

fileBufferSetup

public void fileBufferSetup(int maxNumberOfBuffer,
                   int maxBufferSize)

setPathName

public void setPathName(String pathName)

Parameters:

pathName - name of directory path where store files

setDataFileName

public void setDataFileName(String dataFileName)

Parameters:

dataFileName - name of the file for the heap data storage

setBackupDataFileName

public void setBackupDataFileName(String backupDataFileName)

Parameters:

backupDataFileName - name of the backup file for the heap data storage (use in crash safe mode only)

setStateOkFlagFileName

public void setStateOkFlagFileName(String stateOkFlagFileName)

Parameters:

stateOkFlagFileName - name of the file used has flag for data file on stable state

setStateBackupOkFlagFileName

public void setStateBackupOkFlagFileName(String stateBackupOkFlagFileName)

Parameters:

stateBackupOkFlagFileName - name of the file used has flag for backup data file on stable state

setGlobalStateFlagFileName

public void setGlobalStateFlagFileName(String globalStateFlagFileName)

Parameters:

globalStateFlagFileName - name of file indicating backup and data file stable state

setMaxFileOperationRetry

public void setMaxFileOperationRetry(int maxFileOperationRetry)

Parameters:

maxFileOperationRetry - max retry of file operation in cas of failure

setFileOperationRetryMsDelay

public void setFileOperationRetryMsDelay(int fileOperationRetryMsDelay)

Parameters:

fileOperationRetryMsDelay - millisecond delay before retry file operation after failure

setNoMoreDataAction

public void setNoMoreDataAction(EnumNoMoreDataAction noMoreDataAction)

setRemoveFiles

public void setRemoveFiles(boolean removeFiles)

Parameters:

removeFiles - true if remove files before open

setAutoSaveEnabled

public void setAutoSaveEnabled(boolean autoSaveEnabled)

Parameters:

autoSaveEnabled - true to enabled auto save

setMaxInMemoryThreshold

public void setMaxInMemoryThreshold(int maxInMemoryThreshold)

Parameters:

maxInMemoryThreshold -

setMaintenedInMemory

public void setMaintenedInMemory(boolean maintenedInMemory)

Parameters:

maintenedInMemory -

setMaintenedInMemoryQuota

public void setMaintenedInMemoryQuota(int maintenedInMemoryQuota)

Parameters:

maintenedInMemoryQuota -

setBackgroundGarbageSweepEnabled

public void setBackgroundGarbageSweepEnabled(boolean backgroundGarbageSweepEnabled)

Parameters:

backgroundGarbageSweepEnabled -

setBackgroundGarbageSweepSleepTime

public void setBackgroundGarbageSweepSleepTime(int backgroundGarbageSweepSleepTime)

Parameters:

backgroundGarbageSweepSleepTime -

setGarbageManagement

public void setGarbageManagement(boolean garbageManagement)

Parameters:

garbageManagement - true if manage garbage

setProxyMode

public void setProxyMode(boolean proxyMode)

Parameters:

proxyMode - true if use proxy for lazy loading

setCrashSafeMode

public void setCrashSafeMode(boolean crashSafeMode)

Parameters:

crashSafeMode - true if crash safe mode enabled

setFileCache

public void setFileCache(int pageSize,
                int maxPage)

file cache used

Parameters:

pageSize - page size ( number of byte ), must be greater or equals to 1024

maxPage - maximum number of page for read cache

setDataManager

public void setDataManager(IHeapDataManager dataManager)

Parameters:

dataManager - the provided data manager

setStoreOnlyMarkedStorable

public void setStoreOnlyMarkedStorable(boolean storeOnlyMarkedStorable)

Parameters:

storeOnlyMarkedStorable -

setZipCompressionLevel

public void setZipCompressionLevel(int zipCompressionLevel)

Parameters:

zipCompressionLevel -

setZipCompressionLevelSetted

public void setZipCompressionLevelSetted(boolean zipCompressionLevelSetted)

Parameters:

zipCompressionLevelSetted -

setSubsOfJavaUtil

public void setSubsOfJavaUtil(boolean subsOfJavaUtil)

Parameters:

subsOfJavaUtil -

setRecordSaveActions

public void setRecordSaveActions(boolean recordSaveActions)

Parameters:

recordSaveActions -

getFilePersistenceProperties

public FilePersistenceProperties getFilePersistenceProperties()

build

public IFilePersistence build()
                       throws FilePersistenceException,
                              FilePersistenceInvalidClassException,
                              FilePersistenceNotSerializableException,
                              FilePersistenceClassNotFoundException,
                              FilePersistenceDataCorruptedException

Returns:

file persistence manager

Throws:

FilePersistenceNotSerializableException - Some object to be serialized does not follow joafip persistence rules or does not implement the java.io.Serializable interface.

FilePersistenceInvalidClassException - something is wrong with a class used by serialization

FilePersistenceDataCorruptedException - data is inconsistent.

FilePersistenceClassNotFoundException - Class of a serialized object cannot be found.

FilePersistenceException