← Index · ← File index · ← Prev · Next →

#1336: PfPersistenceService.kt

projectforge-business/src/main/kotlin/org/projectforge/framework/persistence/jpa/PfPersistenceService.kt Spring Service, projectforge-business/src/main/kotlin/org/projectforge/framework/persistence/jpa/PfPersistenceService.kt 398 lines · 268 code · 106 comments · 24 blank
Central persistence service managing JPA EntityManager lifecycle via PfPersistenceContext with ThreadLocal tracking. Provides methods to run code in transactional or read-only contexts, reusing existing contexts when available. Uses kotlinx.coroutines-compatible design. Tracks connection stats for testing/debugging.

Architecture

Context Management

MethodContext TypeReuses Existing?Creates Transaction?
runInTransaction(run)TransactionalYes (if already in ThreadLocal)Yes (if new context)
runInNewTransaction(run)TransactionalNo (always creates new, restores after)Yes
runReadOnly(block)ReadOnlyYes (Transactional or ReadOnly)No
runIsolatedReadOnly(block)ReadOnlyNo (always creates new)No

Transactional Implementation (internalRunInNewTransaction)

  1. Saves current transactional context from ThreadLocal
  2. Creates new PfPersistenceContext with type TRANSACTION
  3. Sets it in ThreadLocal via PfPersistenceContextThreadLocal.setTransactional()
  4. Begins transaction: em.transaction.begin()
  5. Executes the block; on success: commit; on exception: rollback
  6. Finally: removes context from ThreadLocal, restores saved context

ReadOnly Implementation (internalRunReadOnly)

  1. Saves current readonly context
  2. Creates new PfPersistenceContext with type READONLY
  3. Sets Hibernate session defaultReadOnly = true (no flushing, prevents accidental writes)
  4. Executes block without transaction
  5. Finally: removes context, restores saved context

Convenience Query Methods (all delegated to runReadOnly)

MethodParametersDescription
find(entityClass, id)class, id, attached, entityGraphNameJPA find by primary key
selectAll(entityClass)class, attached, lockModeType, entityGraphNameSelect all entities of type
selectSingleResult(sql, resultClass)query, class, params, nullAllowed, etc.Named/hql query returning single result
selectNamedSingleResult(namedQuery, resultClass)query, class, params, nullAllowed, etc.Convenience with namedQuery=true
executeQuery(sql, resultClass)query, class, params, attached, namedQuery, etc.Execute query returning list
executeNamedQuery(namedQuery, resultClass)query, class, params, attached, etc.Convenience with namedQuery=true
getNextNumber(table, attribute)table, attribute, startNumberSELECT MAX(attribute)+1 for ID generation

Testing Support

Singleton Instance

companion object {
    lateinit var instance: PfPersistenceService; private set
}

Set in @PostConstruct; also calls HibernateUtils.internalInit(entityManagerFactory).

Git History

868d6abb7 2025 -> 2026
63081666f Source file headers: 2024-> 2025.
2bcdfbbc6 WIP: orderbook storage.
9aff90908 Migration stuff in progress... (all tests OK).
567ca70cd Migration in progress... spring.datasource.hikari.auto-commit=false
1e18ea268 ehcache removed :-(
f31e8064e Migration stuff in progress...
f570f0e53 Migration stuff in progress... (all tests OK).
50f788c06 Migration stuff in progress...
ba2479571 Migration stuff in progress...
0ceceb28f All cache refreshs are now running in isolated transactions or contexts.
b3293f0cc PersistenceService/Context: stats handling improved.
41b5c2645 Migration stuff in progress...
c14b18a48 Migration stuff in progress... (all tests OK).
87dd5b87c AuftragsCache refactored, migration stuff... (all tests OK)
b56ebe329 PersistenceCallsStats added (all tests OK).
4b9ffbee2 Migration stuff in progress... (all tests OK).
6f482cb81 Migration stuff in progress... (all tests OK).
9408b59d7 Migration stuff in progress...
a6edf511e Migration stuff in progress... PersistenceThreadLocalStats
b1a4bf2ac Migration stuff in progress... (all tests OK).
1564553d8 Migration stuff in progress...
2d2f6063e Migration stuff in progress...
1149aeaae Migration stuff in progress... PfPersistenceContextThreadLocal refactored.
85b4e1175 PfPersistenceService/PfPersistenceContext: query -> executeQuery.
efb1954bd Migration stuff in progress...
c2e2c3449 EntityManagerUtil, PfPersistenceService/PfPersistenceContext refactored.
6be167dc1 Migration stuff in progress...
2e8d77656 PfPersistenceService re-uses PfPersistenceContext (readonly/transactional) if available.
108ecf629 !!!!! Big change of Transaction handling: Re-uses PfPersistenceContext.
b095e6f7d !!!!! Big change of Transaction handling: Re-uses PfPersistenceContext.
4b8dc7c21 Migration stuff in progress...
c6b3afb46 Migration stuff in progress...
7f3cf5f4f Migration stuff in progress...
8a9870ae7 Migration stuff in progress...
f2f7cff74 Migration stuff in progress...
b7b459e73 Migration stuff in progress...
923f5c64b Migration stuff in progress...
9d8b94352 Migration stuff in progress...
e7128d28c Migration stuff in progress...
a2f3f99b2 Migration stuff in progress...
d809ca82a Migration stuff in progress...
67ce75fe9 Migration stuff in progress...
e33c8b9c2 Migration stuff in progress...