de.ipcon.db

Class CastorPersistenceHandler

java.lang.Object

de.ipcon.db.CastorPersistenceHandler

All Implemented Interfaces:

PersistenceHandlerI

public class CastorPersistenceHandler
extends java.lang.Object
implements PersistenceHandlerI

Manages persistence operations using Castor JDO, with enhanced Id handling and create() behavior.

This class wraps the Castor JDO `Database` object to address a specific bug in Windows related to PostgreSQL and IPC/file handling. Additionally, it enables centralized key creation by the `DBMan`, facilitating synchronization between MyTISM backends.

Key features:

• Delayed `create()` execution: Object creation is deferred until the transaction is committed, preventing premature Id assignment.
• Centralized key creation: The `DBMan` can generate unique Ids, ensuring consistency across multiple backends.

Field Summary

Fields inherited from interface de.ipcon.db.core.PersistenceHandlerI

DB_LOCKED, EXCLUSIVE, READ_ONLY, SHARED

Constructor Summary

Constructors

Constructor and Description
CastorPersistenceHandler(CastorPersistenceManager _pm, org.exolab.castor.jdo.Database _db, AbstractKeyGenerator _kg, FulltextSearcherI _fts)
CastorPersistenceHandler(CastorPersistenceManager _pm, org.exolab.castor.jdo.Database _db, AbstractKeyGenerator _kg, FulltextSearcherI _fts, boolean _forSaving)

Method Summary

Modifier and Type	Method and Description
BO	assureClassStability(BO bo, int mode, java.util.Set<java.lang.Long> keepLocked)
BO	assureClassStability(BO bo, int mode, java.util.Set<java.lang.Long> keepLocked, int depth)
BO	assureClassStability(BO bo, int mode, java.util.Set<java.lang.Long> keepLocked, int depth, java.lang.String currAttr)
BO	assureClassStability(BO bo, int mode, java.util.Set<java.lang.Long> keepLocked, int depth, java.lang.String currAttr, java.util.Map tempCache)
void	begin() Initiates a new transaction within the persistence context.
void	begin(int lockTimeout) Initiates a new transaction within the persistence context.
void	cancelCreate(BO bo)
void	cancelPurge(BO bo) Cancels a previously scheduled purge operation for a BO.
void	commit() Actually creates new BOs and persists changes to the database storage; but is also called when data was just queried...?
void	complainSlowQuery(long lms, java.lang.String s, java.lang.Object[] parms)
void	create(BO bo)
void	dbLock(BO bo) Checks if a db lock for the given BO can be granted; does not actually do any locking!
boolean	exists(java.lang.Class<? extends BOI> classtip, java.lang.Long id)
void	finish()
BOLoaderI	getInjectBOLoader() _THE_ central query class as interfaced from MyTISM.
java.sql.Connection	getJdbcConnection()
CastorPersistenceManager	getManager()
SchemaI	getSchema()
boolean	isActive() Returns true if begin() was already called, false otherwise or if already finish()ed.
boolean	isAutoFinish()
boolean	isFinished() Returns true, if finish() was already called.
boolean	isForSaving() Returns true if the TransactionContext will remember all objects that were loaded with a readonly lock.
boolean	isLoadedReadOnly(java.lang.Long id) Returns true if the BO with the passed id is currently loaded in read-only mode.
boolean	isPersistent(BO bo)
de.ipcon.db.core.QueryResultsI	iterateNativeQuery(java.lang.String s)
de.ipcon.db.core.QueryResultsI	iterateNativeQuery(java.lang.String s, java.lang.Object[] parms)
de.ipcon.db.core.QueryResultsI	iterateNativeQuery(java.lang.String s, java.lang.Object[] parms, short mode)
de.ipcon.db.core.QueryResultsI	iterateNativeQuery(java.lang.String s, java.lang.Object[] parms, short mode, java.lang.String[] prefetchPaths)
de.ipcon.db.core.QueryResultsI	iterateQuery(java.lang.String s)
de.ipcon.db.core.QueryResultsI	iterateQuery(java.lang.String s, java.lang.Object[] parms)
de.ipcon.db.core.QueryResultsI	iterateQuery(java.lang.String s, java.lang.Object[] parms, short mode)
de.ipcon.db.core.QueryResultsI	iterateRelationBOs(java.lang.Class classtip, java.lang.Long id, java.lang.String attName)
de.ipcon.db.core.QueryResultsI	iterateRelationBOs(java.lang.Class classtip, java.lang.Long id, java.lang.String attName, short mode)
java.util.List	listQuery(java.lang.String s)
java.util.List	listQuery(java.lang.String s, java.lang.Object[] parms)
java.util.List	listQuery(java.lang.String s, java.lang.Object[] parms, short mode)
java.util.List	listQuery(java.lang.String s, java.lang.Object[] parms, short mode, boolean $native)
java.util.List	listRelationBOs(java.lang.Class<? extends BOI> classtip, java.lang.Long id, java.lang.String attName)
java.util.List	listRelationBOs(java.lang.Class<? extends BOI> classtip, java.lang.Long id, java.lang.String attName, short mode)
BO	load(java.lang.Class<? extends BOI> classtip, java.lang.Long id, int mode, java.util.Set<java.lang.Long> keepLocked, BO into, boolean syncModeCheck)
BO	loadReadOnly(java.lang.Class<? extends BOI> classtip, java.lang.Long id)
void	purge(BO bo) Marks a BO for purging from persistent storage upon transaction commit.
void	resetRechash()
void	rollback()
void	setAutoFinish(boolean b)
void	setBOType(BO bo)
void	setIgnoreMultipleBegin()
void	setInjectBOLoader(BOLoaderI $52)

Methods inherited from class java.lang.Object

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

Constructor Detail

CastorPersistenceHandler

public CastorPersistenceHandler(CastorPersistenceManager _pm,
                                org.exolab.castor.jdo.Database _db,
                                AbstractKeyGenerator _kg,
                                FulltextSearcherI _fts)

CastorPersistenceHandler

public CastorPersistenceHandler(CastorPersistenceManager _pm,
                                org.exolab.castor.jdo.Database _db,
                                AbstractKeyGenerator _kg,
                                FulltextSearcherI _fts,
                                boolean _forSaving)

Method Detail

isForSaving

public boolean isForSaving()

Description copied from interface: PersistenceHandlerI

Returns true if the TransactionContext will remember all objects that were loaded with a readonly lock. Needed when saving to keep the tx graph stable, so BOs that are included (and thereby have their lock widened in the persistence framework) will always return the same object instance in their n-1 relation.

Specified by:

isForSaving in interface PersistenceHandlerI

setAutoFinish

public void setAutoFinish(boolean b)

Specified by:

setAutoFinish in interface PersistenceHandlerI

setIgnoreMultipleBegin

public void setIgnoreMultipleBegin()

Specified by:

setIgnoreMultipleBegin in interface PersistenceHandlerI

resetRechash

public void resetRechash()

begin

public void begin()

Initiates a new transaction within the persistence context.

This method begins a new transaction for interacting with the underlying persistence mechanism (e.g., a database).

If a transaction is already active, the existing transaction is reused. If #setIgnoreMultipleBegin(boolean) was not called with true, an info about that is logged.

An `IllegalStateException` is thrown if the handler has already been finished.

If #isForSaving() is true, the transaction is started with a full read-only cache. Otherwise, a standard transaction is initiated.

The method also handles potential exceptions related to locking and general persistence errors.

Specified by:

begin in interface PersistenceHandlerI

Parameters:

lockTimeout - time to wait in seconds until a locking error is reported in case some object is already locked by another thread; defaults to -1. Zero or less for no waiting, i.e. immediate timeout (or rather the defined lock-timeout of JDO, which defaults to 30s), an infinite value for no timeout.

Throws:

java.lang.IllegalStateException - If the handler has already been finished.

LockNotGrantedException - If a lock cannot be acquired on the database.

PersistenceException - If a general error occurs during the transaction initiation.

begin

public void begin(int lockTimeout)

Description copied from interface: PersistenceHandlerI

Initiates a new transaction within the persistence context.

This method begins a new transaction for interacting with the underlying persistence mechanism (e.g., a database).

If a transaction is already active and #setIgnoreMultipleBegin(boolean) was called with true, the existing transaction is reused. Otherwise the concrete implementation may decide what to do in that case.

An `IllegalStateException` is thrown if the handler has already been finished.

The method also handles potential exceptions related to locking and general persistence errors.

Specified by:

begin in interface PersistenceHandlerI

Parameters:

lockTimeout - time to wait in seconds until a locking error is reported in case some object is already locked by another thread; defaults to -1. Zero or less for no waiting, i.e. immediate timeout (or rather the defined lock-timeout of JDO, which defaults to 30s), an infinite value for no timeout.

dbLock

public void dbLock(BO bo)

Checks if a db lock for the given BO can be granted; does not actually do any locking!

Specified by:

dbLock in interface PersistenceHandlerI

Throws:

LockNotGrantedException - if the check could not be performed or there is a reason for not being able to grant the lock

create

public void create(BO bo)

Specified by:

create in interface PersistenceHandlerI

cancelCreate

public void cancelCreate(BO bo)

Specified by:

cancelCreate in interface PersistenceHandlerI

purge

public void purge(BO bo)

Description copied from interface: PersistenceHandlerI

Marks a BO for purging from persistent storage upon transaction commit.

This method schedules the specified BO for permanent deletion from the database.

Specified by:

purge in interface PersistenceHandlerI

Parameters:

bo - The BO to be purged.

cancelPurge

public void cancelPurge(BO bo)

Description copied from interface: PersistenceHandlerI

Cancels a previously scheduled purge operation for a BO.

This method removes the specified BO from the internal collection of objects marked for deletion upon transaction commit. It is essential to ensure that the provided BO was indeed scheduled for purging before calling this method.

Specified by:

cancelPurge in interface PersistenceHandlerI

Parameters:

bo - The BO whose purge operation should be cancelled.

getSchema

public SchemaI getSchema()

Specified by:

getSchema in interface PersistenceHandlerI

setBOType

public void setBOType(BO bo)

exists

public boolean exists(java.lang.Class<? extends BOI> classtip,
                      java.lang.Long id)

Specified by:

exists in interface PersistenceHandlerI

isLoadedReadOnly

public boolean isLoadedReadOnly(java.lang.Long id)

Description copied from interface: PersistenceHandlerI

Returns true if the BO with the passed id is currently loaded in read-only mode.

Specified by:

isLoadedReadOnly in interface PersistenceHandlerI

loadReadOnly

public BO loadReadOnly(java.lang.Class<? extends BOI> classtip,
                       java.lang.Long id)

Specified by:

loadReadOnly in interface PersistenceHandlerI

load

public BO load(java.lang.Class<? extends BOI> classtip,
               java.lang.Long id,
               int mode,
               java.util.Set<java.lang.Long> keepLocked,
               BO into,
               boolean syncModeCheck)

Specified by:

load in interface PersistenceHandlerI

assureClassStability

public BO assureClassStability(BO bo,
                               int mode,
                               java.util.Set<java.lang.Long> keepLocked)

Specified by:

assureClassStability in interface PersistenceHandlerI

assureClassStability

public BO assureClassStability(BO bo,
                               int mode,
                               java.util.Set<java.lang.Long> keepLocked,
                               int depth)

assureClassStability

public BO assureClassStability(BO bo,
                               int mode,
                               java.util.Set<java.lang.Long> keepLocked,
                               int depth,
                               java.lang.String currAttr)

assureClassStability

public BO assureClassStability(BO bo,
                               int mode,
                               java.util.Set<java.lang.Long> keepLocked,
                               int depth,
                               java.lang.String currAttr,
                               java.util.Map tempCache)

isPersistent

public boolean isPersistent(BO bo)

Specified by:

isPersistent in interface PersistenceHandlerI

isActive

public boolean isActive()

Description copied from interface: PersistenceHandlerI

Returns true if begin() was already called, false otherwise or if already finish()ed.

Specified by:

isActive in interface PersistenceHandlerI

rollback

public void rollback()

Specified by:

rollback in interface PersistenceHandlerI

finish

public void finish()

Specified by:

finish in interface PersistenceHandlerI

isFinished

public boolean isFinished()

Description copied from interface: PersistenceHandlerI

Returns true, if finish() was already called.

Specified by:

isFinished in interface PersistenceHandlerI

commit

public void commit()

Description copied from interface: PersistenceHandlerI

Actually creates new BOs and persists changes to the database storage; but is also called when data was just queried...?

Specified by:

commit in interface PersistenceHandlerI

iterateQuery

public de.ipcon.db.core.QueryResultsI iterateQuery(java.lang.String s)

Specified by:

iterateQuery in interface PersistenceHandlerI

iterateQuery

public de.ipcon.db.core.QueryResultsI iterateQuery(java.lang.String s,
                                                   java.lang.Object[] parms)

Specified by:

iterateQuery in interface PersistenceHandlerI

iterateQuery

public de.ipcon.db.core.QueryResultsI iterateQuery(java.lang.String s,
                                                   java.lang.Object[] parms,
                                                   short mode)

Specified by:

iterateQuery in interface PersistenceHandlerI

iterateNativeQuery

public de.ipcon.db.core.QueryResultsI iterateNativeQuery(java.lang.String s)

Specified by:

iterateNativeQuery in interface PersistenceHandlerI

iterateNativeQuery

public de.ipcon.db.core.QueryResultsI iterateNativeQuery(java.lang.String s,
                                                         java.lang.Object[] parms)

Specified by:

iterateNativeQuery in interface PersistenceHandlerI

iterateNativeQuery

public de.ipcon.db.core.QueryResultsI iterateNativeQuery(java.lang.String s,
                                                         java.lang.Object[] parms,
                                                         short mode)

Specified by:

iterateNativeQuery in interface PersistenceHandlerI

iterateNativeQuery

public de.ipcon.db.core.QueryResultsI iterateNativeQuery(java.lang.String s,
                                                         java.lang.Object[] parms,
                                                         short mode,
                                                         java.lang.String[] prefetchPaths)

Specified by:

iterateNativeQuery in interface PersistenceHandlerI

listQuery

public java.util.List listQuery(java.lang.String s)

Specified by:

listQuery in interface PersistenceHandlerI

listQuery

public java.util.List listQuery(java.lang.String s,
                                java.lang.Object[] parms)

Specified by:

listQuery in interface PersistenceHandlerI

listQuery

public java.util.List listQuery(java.lang.String s,
                                java.lang.Object[] parms,
                                short mode)

Specified by:

listQuery in interface PersistenceHandlerI

listQuery

public java.util.List listQuery(java.lang.String s,
                                java.lang.Object[] parms,
                                short mode,
                                boolean $native)

complainSlowQuery

public void complainSlowQuery(long lms,
                              java.lang.String s,
                              java.lang.Object[] parms)

listRelationBOs

public java.util.List listRelationBOs(java.lang.Class<? extends BOI> classtip,
                                      java.lang.Long id,
                                      java.lang.String attName)

Specified by:

listRelationBOs in interface PersistenceHandlerI

listRelationBOs

public java.util.List listRelationBOs(java.lang.Class<? extends BOI> classtip,
                                      java.lang.Long id,
                                      java.lang.String attName,
                                      short mode)

Specified by:

listRelationBOs in interface PersistenceHandlerI

iterateRelationBOs

public de.ipcon.db.core.QueryResultsI iterateRelationBOs(java.lang.Class classtip,
                                                         java.lang.Long id,
                                                         java.lang.String attName)

Specified by:

iterateRelationBOs in interface PersistenceHandlerI

iterateRelationBOs

public de.ipcon.db.core.QueryResultsI iterateRelationBOs(java.lang.Class classtip,
                                                         java.lang.Long id,
                                                         java.lang.String attName,
                                                         short mode)

Specified by:

iterateRelationBOs in interface PersistenceHandlerI

getJdbcConnection

public java.sql.Connection getJdbcConnection()

Specified by:

getJdbcConnection in interface PersistenceHandlerI

getManager

public CastorPersistenceManager getManager()

getInjectBOLoader

public BOLoaderI getInjectBOLoader()

_THE_ central query class as interfaced from MyTISM. The query itself is native to the PersistenceHandler, in this case it's CastorOQL (not very versatile, but nevertheless easy to understand).

setInjectBOLoader

public void setInjectBOLoader(BOLoaderI $52)

Specified by:

setInjectBOLoader in interface PersistenceHandlerI

isAutoFinish

public boolean isAutoFinish()

Specified by:

isAutoFinish in interface PersistenceHandlerI