net.sf.joafip.service

Interface IDataAccessSession

All Superinterfaces:

IDataAccessSessionCommon

All Known Implementing Classes:

DataAccessSession

public interface IDataAccessSession
extends IDataAccessSessionCommon

file persistence data access session interface

Author:

luc peuvrier

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(IFilePersistenceCloseActionListener listener) add a close action execution end listener
EnumFilePersistenceCloseAction	close(EnumFilePersistenceCloseAction action) close data access session with a save action possible save actions EnumFilePersistenceCloseAction.SAVE ask for save modification, can be canceled by not save action by other data access session close.
EnumFilePersistenceCloseAction	closeAndWait(EnumFilePersistenceCloseAction action) as close(EnumFilePersistenceCloseAction), but wait for effective execution of action
void	openSynchronized() open this data access session, synchronized with other session: will wait for other session closed ( blocking )
void	removeListener(IFilePersistenceCloseActionListener listener) remove a close action execution end listener

Methods inherited from interface net.sf.joafip.service.IDataAccessSessionCommon

getClassIdentifier, getMutex, getObject, getObject, getObjects, isClosed, isOpened, objectKeySet, open, removeAllObject, removeObject, setEnumState, setObject, storedEnum, storedImmutableEnum, storedImmutableEnum, storedMutableEnum, storedMutableEnum

Method Detail

addListener

void addListener(IFilePersistenceCloseActionListener listener)

add a close action execution end listener

Parameters:

listener - close action execution end listener

removeListener

void removeListener(IFilePersistenceCloseActionListener listener)

remove a close action execution end listener

Parameters:

listener - close action execution end listener

openSynchronized

void openSynchronized()
                      throws FilePersistenceException,
                             FilePersistenceClassNotFoundException,
                             FilePersistenceInvalidClassException,
                             FilePersistenceDataCorruptedException,
                             FilePersistenceNotSerializableException

open this data access session, synchronized with other session: will wait for other session closed ( blocking )

Throws:

FilePersistenceException - failed read root object, session close pending can not reopen

FilePersistenceInvalidClassException - something is wrong with a class used by serialization

FilePersistenceDataCorruptedException - data is inconsistent.

FilePersistenceClassNotFoundException - Class of a serialized object cannot be found.

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

close

EnumFilePersistenceCloseAction close(EnumFilePersistenceCloseAction action)
                                     throws FilePersistenceException,
                                            FilePersistenceInvalidClassException,
                                            FilePersistenceNotSerializableException,
                                            FilePersistenceClassNotFoundException,
                                            FilePersistenceDataCorruptedException,
                                            FilePersistenceTooBigForSerializationException

close data access session with a save action
possible save actions

• EnumFilePersistenceCloseAction.SAVE
  ask for save modification, can be canceled by not save action by other data access session close.
• EnumFilePersistenceCloseAction.DO_NOT_SAVE
  ask for not save modification, will cancel save asked by other data access session close.

action are executed only when all data access session are closed. If one of data access session is closed asking not save action then all the modification done in all session will not be save.

• save action:
  transient or detached object referenced by persistent, or by in way to become persistent object, are persisted.
  
• do not save action:
  transient or detached object referenced by persistent, or by in way to become persistent object, are not persisted.
  

after action done (all data access session closed):
persistent object become detached, transient and detached remain in same state

Parameters:

action - close action

Returns:

null if action pending, else action executed

Throws:

FilePersistenceException - session not registered as opened session, no file in stable state, file state restored to stable, file persistence is not opened

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

FilePersistenceClassNotFoundException - Class of a serialized object cannot be found.

FilePersistenceDataCorruptedException - data is inconsistent

FilePersistenceTooBigForSerializationException

closeAndWait

EnumFilePersistenceCloseAction closeAndWait(EnumFilePersistenceCloseAction action)
                                            throws FilePersistenceException,
                                                   FilePersistenceInvalidClassException,
                                                   FilePersistenceNotSerializableException,
                                                   FilePersistenceClassNotFoundException,
                                                   FilePersistenceDataCorruptedException,
                                                   FilePersistenceTooBigForSerializationException

as close(EnumFilePersistenceCloseAction), but wait for effective execution of action

Parameters:

action - close action

Returns:

action executed

Throws:

FilePersistenceException - session not registered as opened session, no file in stable state, file state restored to stable, file persistence is not opened, close wait interrupted

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

FilePersistenceClassNotFoundException - Class of a serialized object cannot be found.

FilePersistenceDataCorruptedException - data is inconsistent

FilePersistenceTooBigForSerializationException