net.sf.joafip.service

Class FilePersistence

java.lang.Object

net.sf.joafip.service.AbstractFilePersistenceDelegatingToStore

net.sf.joafip.service.FilePersistence

All Implemented Interfaces:

IFilePersistence, IFilePersistenceAutoSaver

@NoStorableAccess
@NotStorableClass
public class FilePersistence
extends AbstractFilePersistenceDelegatingToStore

manager for file persistence of java object

Author:

luc peuvrier

Field Summary

Fields

Modifier and Type	Field and Description
static int	BEST_COMPRESSION Compression level for best compression.
static int	BEST_SPEED Compression level for fastest compression.
static int	DEFAULT_COMPRESSION Default compression level.
static int	NO_COMPRESSION Compression level for no compression.

Fields inherited from class net.sf.joafip.service.AbstractFilePersistenceDelegatingToStore

classLoaderProvider, logger, mutex, store

Constructor Summary

Constructors

Constructor and Description
FilePersistence(String propertiesSetupResourceName, boolean removeFiles) create a persistence setup from properties

Method Summary

Methods

Modifier and Type	Method and Description
protected void	assertSessionClosed()
protected void	assertSessionOpenned()
boolean	autoSave()
void	clear() clear all persisted data
void	close() close ( important to close files ) do not save modification
static void	closeAll()
IAloneDataAccessSession	createAloneDataAccessSession() Deprecated.
IDataAccessSession	createDataAccessSession()
IExclusiveDataAccessSession	createExclusiveDataAccessSession()
static FileIOException	fileIOException(Exception exception)
static EnumFileState	fileState(Exception exception) to have the file state give by exception or its primary cause
static String	getVersion()
boolean	isClosed()
boolean	isOpened()
boolean	isRunAutosaveEnable()
boolean	isUsed() for tests only ( used to check all user thread have ended usage )
void	save()
static void	setIdCount(int idCount) for test only
void	setImportListener(IImportListener listener)
void	setRunAutosaveEnable(boolean runAutosaveEnable)
void	storedMutableEnum(Class<? extends Enum<?>> enumClass) declare persisted mutable enum by its class (PROPS) can be set using properties file see FilePersistence(String, boolean)
void	storedMutableEnum(Class<? extends Enum<?>>[] enumClasses) declare persisted mutable enum by their class (PROPS) can be set using properties file see FilePersistence(String, boolean)
static Throwable	targetCause(Exception exception)
void	xmlImport(String directoryName, boolean validating) import from exported data in directoryName directory

Methods inherited from class net.sf.joafip.service.AbstractFilePersistenceDelegatingToStore

addProhibitedPackage, addToNotCheckMethod, addToNotCheckMethod, addToNotCheckMethod, addToNotCheckMethod, allClassInformation, autoSaveSetup, classInfoOfObject, classOfObject, clearStore, closeStore, copy, createObjectReadingInStoreOrGetExisting, deepCopy, disableBackgroundGarbageSweep, enableBackgroundGarbageSweep, freeSize, garbageSweep, getAllReferenceLink, getCandidate, getClassIdentifier, getClassLoader, getCurrentDataRecordIdentifierAssociatedToObject, getDataManager, getLinkRecordManager, getMutex, getNumberOfDataRecord, getNumberOfFreeRecord, getNumberOfGarbageCandidate, getNumberOfModified, getNumberOfObjectExported, getNumberOfObjectState, getNumberOfReferenced, getNumberOfToGarbage, getNumberOfVisited, getNumberOfWeakReference, getObjectAndPersistInfoOfObjectFromQueue, getObjectAndPersistInfoOfObjectFromQueue, getObjectHavingStateSet, getObjectIOManager, getResource, getStorageFileName, getStore, getStoredEnumMap, getToGarbage, getVisitedObjectSet, getWroteArrays, getWroteObjectSet, isAutoSaveEnabled, isGarbageManagement, isProxy, keptInMemory, keyOfObjectKeptInMemory, knownAsNotExisting, listenStateMapClean, maintainInMemorySetup, newInstance, newInstance, newProxyInstance, newProxyInstance, newProxyInstance, openStore, referencedByPesistedStaticField, referencedByPesistedStaticField, removeWriteSubstitution, removeWriteSubstitution, setAutoSaveEnabled, setAutoSaveEventListener, setChangeLogEnabled, setClassLoader, setDeprecatedInStore, setDeprecatedInStore, setDeprecatedInStore, setDeprecatedInStore, setEnumState, setExportListener, setForceEnhance, setForceEnhance, setForceEnhance, setForceEnhance, setGarbageListener, setMaintainedInMemoryEnabled, setNoLazyLoad, setNoLazyLoad, setNoLazyLoad, setNoLazyLoad, setNotPersistedField, setNotPersistedField, setNotStorable, setNotStorable, setNotStorable, setNotStorable, setObjectIOForClass, setObjectIOForClass, setRecordSaveActions, setRecordSaveActions, setSaveRecordActionListener, setStorable, setStorable, setStorable, setStorable, setStore, setStoredEnumMap, setStoreNotUseStandardSerialization, setStoreNotUseStandardSerialization, setStoreNotUseStandardSerialization, setStoreNotUseStandardSerialization, setStoreOnlyMarkedStorable, setStoreSerializeAndGZippedInOneRecord, setStoreSerializeAndGZippedInOneRecord, setStoreSerializeAndGZippedInOneRecord, setStoreSerializeAndGZippedInOneRecord, setStoreSerializeAndZippedInOneRecord, setStoreSerializeAndZippedInOneRecord, setStoreSerializeAndZippedInOneRecord, setStoreSerializeAndZippedInOneRecord, setStoreSerializeInOneRecord, setStoreSerializeInOneRecord, setStoreSerializeInOneRecord, setStoreSerializeInOneRecord, setSubstituteObjectManager, setSubstituteObjectManager, setSubstitutionOfJavaUtilCollection, setWriteSubstitution, setWriteSubstitution, setZipCompressionLevel, storedEnum, storedEnum, storedEnum, storedImmutableEnum, storedImmutableEnum, storeDoNotSave, storeEndAccessSession, storeGetRoot, storeNewAccessSession, storeReadRoot, storeSave, storeSetInstanceFactory, storeSetRoot, totalSize, usedForClassNameManagement, usedForGarbageManagement, usedSize, xmlExport

Methods inherited from class java.lang.Object

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

Field Detail

NO_COMPRESSION

public static final int NO_COMPRESSION

Compression level for no compression.

See Also:

Constant Field Values

BEST_SPEED

public static final int BEST_SPEED

Compression level for fastest compression.

See Also:

Constant Field Values

BEST_COMPRESSION

public static final int BEST_COMPRESSION

Compression level for best compression.

See Also:

Constant Field Values

DEFAULT_COMPRESSION

public static final int DEFAULT_COMPRESSION

Default compression level.

See Also:

Constant Field Values

Constructor Detail

FilePersistence

public FilePersistence(String propertiesSetupResourceName,
               boolean removeFiles)
                throws FilePersistenceException,
                       FilePersistenceInvalidClassException,
                       FilePersistenceNotSerializableException,
                       FilePersistenceClassNotFoundException,
                       FilePersistenceDataCorruptedException

create a persistence setup from properties

Parameters:

propertiesSetupResourceName - properties to use for setup

removeFiles - true if remove files before open

Throws:

FilePersistenceException

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.

Method Detail

getVersion

public static String getVersion()

Returns:

version information according to svn revision and location

close

public void close()
           throws FilePersistenceException

Description copied from interface: IFilePersistence

close ( important to close files )
do not save modification

Throws:

FilePersistenceException

isClosed

public boolean isClosed()

isOpened

public boolean isOpened()

closeAll

public static void closeAll()

createDataAccessSession

public IDataAccessSession createDataAccessSession()
                                           throws FilePersistenceException

Returns:

a new created data access session

Throws:

FilePersistenceException

createAloneDataAccessSession

@Deprecated
public IAloneDataAccessSession createAloneDataAccessSession()
                                                     throws FilePersistenceException

Deprecated.

Returns:

a new created alone data access session

Throws:

FilePersistenceException

createExclusiveDataAccessSession

public IExclusiveDataAccessSession createExclusiveDataAccessSession()
                                                             throws FilePersistenceException

Returns:

a new created exclusive data access session

Throws:

FilePersistenceException

clear

public void clear()
           throws FilePersistenceException,
                  FilePersistenceInvalidClassException,
                  FilePersistenceNotSerializableException,
                  FilePersistenceClassNotFoundException,
                  FilePersistenceDataCorruptedException

Description copied from interface: IFilePersistence

clear all persisted data

Throws:

FilePersistenceException

FilePersistenceInvalidClassException

FilePersistenceNotSerializableException

FilePersistenceClassNotFoundException

FilePersistenceDataCorruptedException

autoSave

public boolean autoSave()
                 throws FilePersistenceException,
                        FilePersistenceInvalidClassException,
                        FilePersistenceNotSerializableException,
                        FilePersistenceClassNotFoundException,
                        FilePersistenceDataCorruptedException,
                        FilePersistenceTooBigForSerializationException

Throws:

FilePersistenceException

FilePersistenceInvalidClassException

FilePersistenceNotSerializableException

FilePersistenceClassNotFoundException

FilePersistenceDataCorruptedException

FilePersistenceTooBigForSerializationException

setRunAutosaveEnable

public void setRunAutosaveEnable(boolean runAutosaveEnable)

isRunAutosaveEnable

public boolean isRunAutosaveEnable()

save

public void save()
          throws FilePersistenceException,
                 FilePersistenceInvalidClassException,
                 FilePersistenceNotSerializableException,
                 FilePersistenceClassNotFoundException,
                 FilePersistenceDataCorruptedException,
                 FilePersistenceTooBigForSerializationException

Throws:

FilePersistenceException

FilePersistenceInvalidClassException

FilePersistenceNotSerializableException

FilePersistenceClassNotFoundException

FilePersistenceDataCorruptedException

FilePersistenceTooBigForSerializationException

isUsed

@Fortest
public boolean isUsed()
               throws FilePersistenceException

for tests only ( used to check all user thread have ended usage )

Returns:

true if used by at least one data access session

Throws:

FilePersistenceException

assertSessionClosed

protected void assertSessionClosed()
                            throws FilePersistenceException

Specified by:

assertSessionClosed in class AbstractFilePersistenceDelegatingToStore

Throws:

FilePersistenceException

assertSessionOpenned

protected void assertSessionOpenned()
                             throws FilePersistenceException

Specified by:

assertSessionOpenned in class AbstractFilePersistenceDelegatingToStore

Throws:

FilePersistenceException

fileState

public static EnumFileState fileState(Exception exception)

to have the file state give by exception or its primary cause

Parameters:

exception - exception

Returns:

file state for exception

fileIOException

public static FileIOException fileIOException(Exception exception)

targetCause

public static Throwable targetCause(Exception exception)

Parameters:

exception - the exception in which search for target invocation exception

Returns:

exception thrown at target invocation, null if none

setIdCount

@Fortest
public static void setIdCount(int idCount)
                       throws FilePersistenceException

for test only

Parameters:

idCount -

Throws:

FilePersistenceException

storedMutableEnum

public void storedMutableEnum(Class<? extends Enum<?>> enumClass)
                       throws FilePersistenceException

Description copied from interface: IFilePersistence

declare persisted mutable enum by its class
(PROPS) can be set using properties file see FilePersistence(String, boolean)

Parameters:

enumClass - the enum class

Throws:

FilePersistenceException

storedMutableEnum

public void storedMutableEnum(Class<? extends Enum<?>>[] enumClasses)
                       throws FilePersistenceException

Description copied from interface: IFilePersistence

declare persisted mutable enum by their class
(PROPS) can be set using properties file see FilePersistence(String, boolean)

Throws:

FilePersistenceException

xmlImport

public void xmlImport(String directoryName,
             boolean validating)
               throws FilePersistenceException,
                      FilePersistenceClassNotFoundException,
                      FilePersistenceInvalidClassException,
                      FilePersistenceDataCorruptedException,
                      FilePersistenceNotSerializableException

Description copied from interface: IFilePersistence

import from exported data in directoryName directory


Parameters:

directoryName - directory name where are stored exported data to import

Throws:

FilePersistenceException

FilePersistenceClassNotFoundException

FilePersistenceInvalidClassException

FilePersistenceDataCorruptedException

FilePersistenceNotSerializableException

setImportListener

public void setImportListener(IImportListener listener)